w3c_api 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE.md +33 -0
- data/README.adoc +1265 -0
- data/Rakefile +8 -0
- data/exe/w3c_api +6 -0
- data/lib/w3c_api/cli.rb +41 -0
- data/lib/w3c_api/client.rb +320 -0
- data/lib/w3c_api/commands/affiliation.rb +48 -0
- data/lib/w3c_api/commands/ecosystem.rb +57 -0
- data/lib/w3c_api/commands/group.rb +87 -0
- data/lib/w3c_api/commands/output_formatter.rb +18 -0
- data/lib/w3c_api/commands/participation.rb +34 -0
- data/lib/w3c_api/commands/series.rb +40 -0
- data/lib/w3c_api/commands/specification.rb +68 -0
- data/lib/w3c_api/commands/translation.rb +31 -0
- data/lib/w3c_api/commands/user.rb +77 -0
- data/lib/w3c_api/models/affiliation.rb +86 -0
- data/lib/w3c_api/models/affiliations.rb +33 -0
- data/lib/w3c_api/models/base.rb +39 -0
- data/lib/w3c_api/models/call_for_translation.rb +59 -0
- data/lib/w3c_api/models/call_for_translation_ref.rb +15 -0
- data/lib/w3c_api/models/charter.rb +110 -0
- data/lib/w3c_api/models/charters.rb +17 -0
- data/lib/w3c_api/models/collection_base.rb +79 -0
- data/lib/w3c_api/models/connected_account.rb +54 -0
- data/lib/w3c_api/models/delegate_enumerable.rb +54 -0
- data/lib/w3c_api/models/ecosystem.rb +72 -0
- data/lib/w3c_api/models/ecosystems.rb +33 -0
- data/lib/w3c_api/models/extension.rb +12 -0
- data/lib/w3c_api/models/group.rb +173 -0
- data/lib/w3c_api/models/groups.rb +38 -0
- data/lib/w3c_api/models/join_emails.rb +12 -0
- data/lib/w3c_api/models/link.rb +17 -0
- data/lib/w3c_api/models/participation.rb +109 -0
- data/lib/w3c_api/models/participations.rb +17 -0
- data/lib/w3c_api/models/serie.rb +88 -0
- data/lib/w3c_api/models/series.rb +41 -0
- data/lib/w3c_api/models/series_collection.rb +17 -0
- data/lib/w3c_api/models/spec_version.rb +96 -0
- data/lib/w3c_api/models/spec_version_ref.rb +18 -0
- data/lib/w3c_api/models/spec_versions.rb +17 -0
- data/lib/w3c_api/models/specification.rb +79 -0
- data/lib/w3c_api/models/specifications.rb +17 -0
- data/lib/w3c_api/models/translation.rb +162 -0
- data/lib/w3c_api/models/translations.rb +40 -0
- data/lib/w3c_api/models/user.rb +178 -0
- data/lib/w3c_api/models/users.rb +44 -0
- data/lib/w3c_api/models.rb +15 -0
- data/lib/w3c_api/version.rb +5 -0
- data/lib/w3c_api.rb +9 -0
- metadata +166 -0
data/README.adoc
ADDED
@@ -0,0 +1,1265 @@
|
|
1
|
+
= W3C API in Ruby
|
2
|
+
|
3
|
+
image:https://img.shields.io/gem/v/w3c_api.svg["Gem Version", link="https://rubygems.org/gems/w3c_api"]
|
4
|
+
image:https://github.com/relaton/w3c_api/workflows/rake/badge.svg["Build Status", link="https://github.com/relaton/w3c_api/actions?workflow=rake"]
|
5
|
+
image:https://codeclimate.com/github/relaton/w3c_api/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/w3c_api"]
|
6
|
+
|
7
|
+
== Purpose
|
8
|
+
|
9
|
+
A Ruby wrapper for the W3C web API with a CLI interface. This gem provides:
|
10
|
+
|
11
|
+
* A complete client for the W3C API
|
12
|
+
* Data models created with https://github.com/lutaml/lutaml-model[lutaml-model]
|
13
|
+
for all W3C API resources
|
14
|
+
* A command-line interface using Thor following GitHub CLI patterns
|
15
|
+
|
16
|
+
This gem is developed against the W3C API documented at https://api.w3.org/doc.
|
17
|
+
|
18
|
+
== Ruby API
|
19
|
+
|
20
|
+
[source,ruby]
|
21
|
+
----
|
22
|
+
require 'w3c_api'
|
23
|
+
|
24
|
+
# Create a client
|
25
|
+
client = W3cApi::Client.new
|
26
|
+
|
27
|
+
# Get specifications
|
28
|
+
specifications = client.specifications
|
29
|
+
specification = client.specification('webrtc')
|
30
|
+
versions = client.specification_versions('webrtc')
|
31
|
+
version = client.specification_version('webrtc', '20241008')
|
32
|
+
specs_by_status = client.specifications_by_status('Recommendation')
|
33
|
+
|
34
|
+
# Get specification series
|
35
|
+
series_list = client.series
|
36
|
+
series = client.series_by_shortname('webrtc')
|
37
|
+
series_specs = client.series_specifications('webrtc')
|
38
|
+
|
39
|
+
# Get groups
|
40
|
+
groups = client.groups
|
41
|
+
group = client.group(109735) # Immersive Web Working Group
|
42
|
+
users = client.group_users(109735)
|
43
|
+
specifications = client.group_specifications(109735)
|
44
|
+
charters = client.group_charters(109735)
|
45
|
+
chairs = client.group_chairs(109735)
|
46
|
+
team_contacts = client.group_team_contacts(109735)
|
47
|
+
|
48
|
+
# Get users
|
49
|
+
users = client.users
|
50
|
+
user = client.user('f1ovb5rydm8s0go04oco0cgk0sow44w')
|
51
|
+
groups = client.user_groups('f1ovb5rydm8s0go04oco0cgk0sow44w')
|
52
|
+
specs = client.user_specifications('f1ovb5rydm8s0go04oco0cgk0sow44w')
|
53
|
+
affiliations = client.user_affiliations('f1ovb5rydm8s0go04oco0cgk0sow44w')
|
54
|
+
participations = client.user_participations('f1ovb5rydm8s0go04oco0cgk0sow44w')
|
55
|
+
chair_groups = client.user_chair_of_groups('f1ovb5rydm8s0go04oco0cgk0sow44w')
|
56
|
+
team_contact_groups = client.user_team_contact_of_groups('f1ovb5rydm8s0go04oco0cgk0sow44w')
|
57
|
+
|
58
|
+
# Get affiliations
|
59
|
+
affiliations = client.affiliations
|
60
|
+
affiliation = client.affiliation(35662) # Google LLC
|
61
|
+
participants = client.affiliation_participants(35662)
|
62
|
+
participations = client.affiliation_participations(35662)
|
63
|
+
|
64
|
+
# Work with other resources
|
65
|
+
translations = client.translations
|
66
|
+
translation = client.translation(2)
|
67
|
+
ecosystems = client.ecosystems
|
68
|
+
ecosystem = client.ecosystem('data')
|
69
|
+
----
|
70
|
+
|
71
|
+
== Command line interface
|
72
|
+
|
73
|
+
=== General
|
74
|
+
|
75
|
+
W3C API provides a command-line interface (CLI) for various operations.
|
76
|
+
|
77
|
+
The main executable is `w3c_api`.
|
78
|
+
|
79
|
+
[source,shell]
|
80
|
+
----
|
81
|
+
Commands:
|
82
|
+
# Work with W3C specifications
|
83
|
+
w3c_api specification SUBCOMMAND ...ARGS
|
84
|
+
# Work with W3C specification series
|
85
|
+
w3c_api series SUBCOMMAND ...ARGS
|
86
|
+
# Work with W3C groups
|
87
|
+
w3c_api group SUBCOMMAND ...ARGS
|
88
|
+
# Work with W3C users
|
89
|
+
w3c_api user SUBCOMMAND ...ARGS
|
90
|
+
# Work with W3C affiliations
|
91
|
+
w3c_api affiliation SUBCOMMAND ...ARGS
|
92
|
+
# Work with W3C translations
|
93
|
+
w3c_api translation SUBCOMMAND ...ARGS
|
94
|
+
# Work with W3C ecosystems
|
95
|
+
w3c_api ecosystem SUBCOMMAND ...ARGS
|
96
|
+
# Describe available commands or one specific command
|
97
|
+
w3c_api help [COMMAND]
|
98
|
+
----
|
99
|
+
|
100
|
+
=== Specifications
|
101
|
+
|
102
|
+
This command provides access to W3C specifications.
|
103
|
+
|
104
|
+
==== Index
|
105
|
+
|
106
|
+
When fetching an index of specifications, for every specification, only the
|
107
|
+
`href` and `title` attributes are provided.
|
108
|
+
|
109
|
+
[source,shell]
|
110
|
+
----
|
111
|
+
# Fetch specifications
|
112
|
+
$ w3c_api specification fetch [OPTIONS]
|
113
|
+
# Fetch specifications in JSON format
|
114
|
+
$ w3c_api specification fetch --format=json
|
115
|
+
# Fetch specifications in YAML format
|
116
|
+
$ w3c_api specification fetch --format=yaml
|
117
|
+
# Fetch specifications with a specific status
|
118
|
+
$ w3c_api specification fetch --status=Recommendation
|
119
|
+
----
|
120
|
+
|
121
|
+
[example]
|
122
|
+
====
|
123
|
+
[source,shell]
|
124
|
+
----
|
125
|
+
$ w3c_api specification fetch --format=yaml
|
126
|
+
- href: https://www.w3.org/TR/html5/
|
127
|
+
title: HTML5
|
128
|
+
- href: https://www.w3.org/TR/css3-color/
|
129
|
+
title: CSS Color Module Level 3
|
130
|
+
----
|
131
|
+
====
|
132
|
+
|
133
|
+
==== Get
|
134
|
+
|
135
|
+
Getting a specification provides all attributes of the specification.
|
136
|
+
|
137
|
+
[source,shell]
|
138
|
+
----
|
139
|
+
# Fetch a specification
|
140
|
+
$ w3c_api specification fetch --shortname=webrtc
|
141
|
+
# Fetch a specification in JSON format
|
142
|
+
$ w3c_api specification fetch --shortname=webrtc --format=json
|
143
|
+
# Fetch a specification in YAML format
|
144
|
+
$ w3c_api specification fetch --shortname=webrtc --format=yaml
|
145
|
+
# Fetch a specific version of a specification
|
146
|
+
$ w3c_api specification fetch --shortname=webrtc --version=20241008
|
147
|
+
----
|
148
|
+
|
149
|
+
[example]
|
150
|
+
====
|
151
|
+
[source,shell]
|
152
|
+
----
|
153
|
+
$ w3c_api specification fetch --shortname=webrtc --format=yaml
|
154
|
+
---
|
155
|
+
shortlink: https://www.w3.org/TR/webrtc/
|
156
|
+
description: "<p>This document defines a set of ECMAScript APIs in WebIDL to allow
|
157
|
+
media to be sent to and received from another browser or device implementing the
|
158
|
+
appropriate set of real-time protocols. This specification is being developed in
|
159
|
+
conjunction with a protocol specification developed by the IETF RTCWEB group and
|
160
|
+
an API specification to get access to local media devices.</p>"
|
161
|
+
title: 'WebRTC: Real-Time Communication in Browsers'
|
162
|
+
shortname: webrtc
|
163
|
+
editor_draft: https://w3c.github.io/webrtc-pc/
|
164
|
+
series_version: '1.0'
|
165
|
+
_links:
|
166
|
+
self:
|
167
|
+
href: https://api.w3.org/specifications/webrtc
|
168
|
+
version_history:
|
169
|
+
href: https://api.w3.org/specifications/webrtc/versions
|
170
|
+
first_version:
|
171
|
+
href: https://api.w3.org/specifications/webrtc/versions/20111027
|
172
|
+
title: Working Draft
|
173
|
+
latest_version:
|
174
|
+
href: https://api.w3.org/specifications/webrtc/versions/20241008
|
175
|
+
title: Recommendation
|
176
|
+
series:
|
177
|
+
href: https://api.w3.org/specification-series/webrtc
|
178
|
+
----
|
179
|
+
====
|
180
|
+
|
181
|
+
|
182
|
+
==== Versions
|
183
|
+
|
184
|
+
This command provides access to W3C specification versions given a shortname.
|
185
|
+
|
186
|
+
[source,shell]
|
187
|
+
----
|
188
|
+
# Fetch versions of a specification
|
189
|
+
$ w3c_api specification versions --shortname=webrtc
|
190
|
+
# Fetch versions in JSON format
|
191
|
+
$ w3c_api specification versions --shortname=webrtc --format=json
|
192
|
+
# Fetch versions in YAML format
|
193
|
+
$ w3c_api specification versions --shortname=webrtc --format=yaml
|
194
|
+
----
|
195
|
+
|
196
|
+
[example]
|
197
|
+
====
|
198
|
+
[source,shell]
|
199
|
+
----
|
200
|
+
$ w3c_api specification versions --shortname=webrtc --format=yaml
|
201
|
+
spec_versions:
|
202
|
+
- title: 'WebRTC: Real-Time Communication in Browsers'
|
203
|
+
href: https://api.w3.org/specifications/webrtc/versions/20241008
|
204
|
+
- title: 'WebRTC: Real-Time Communication in Browsers'
|
205
|
+
href: https://api.w3.org/specifications/webrtc/versions/20230306
|
206
|
+
- title: 'WebRTC: Real-Time Communication in Browsers'
|
207
|
+
href: https://api.w3.org/specifications/webrtc/versions/20230301
|
208
|
+
# Additional versions omitted for brevity
|
209
|
+
----
|
210
|
+
====
|
211
|
+
|
212
|
+
==== Status
|
213
|
+
|
214
|
+
This command provides access to W3C specifications by status.
|
215
|
+
|
216
|
+
[source,shell]
|
217
|
+
----
|
218
|
+
# Fetch specifications with a specific status
|
219
|
+
$ w3c_api specification fetch --status=Recommendation
|
220
|
+
# Fetch specifications with a specific status in JSON format
|
221
|
+
$ w3c_api specification fetch --status=Recommendation --format=json
|
222
|
+
# Fetch specifications with a specific status in YAML format
|
223
|
+
$ w3c_api specification fetch --status=Recommendation --format=yaml
|
224
|
+
----
|
225
|
+
|
226
|
+
[example]
|
227
|
+
====
|
228
|
+
[source,shell]
|
229
|
+
----
|
230
|
+
$ w3c_api specification fetch --status=Recommendation --format=yaml
|
231
|
+
specifications:
|
232
|
+
- title: 'XML Schema Part 1: Structures Second Edition'
|
233
|
+
href: https://api.w3.org/specifications/xmlschema-1
|
234
|
+
- title: 'XML Schema Part 2: Datatypes Second Edition'
|
235
|
+
href: https://api.w3.org/specifications/xmlschema-2
|
236
|
+
- title: CSS Namespaces Module Level 3
|
237
|
+
href: https://api.w3.org/specifications/css-namespaces-3
|
238
|
+
# Additional specifications omitted for brevity
|
239
|
+
----
|
240
|
+
====
|
241
|
+
|
242
|
+
=== Series
|
243
|
+
|
244
|
+
This command provides access to W3C specification series.
|
245
|
+
|
246
|
+
==== Index
|
247
|
+
|
248
|
+
Fetching an index of specification series.
|
249
|
+
|
250
|
+
[source,shell]
|
251
|
+
----
|
252
|
+
# Fetch specification series
|
253
|
+
$ w3c_api series fetch [OPTIONS]
|
254
|
+
# Fetch specification series in JSON format
|
255
|
+
$ w3c_api series fetch --format=json
|
256
|
+
# Fetch specification series in YAML format
|
257
|
+
$ w3c_api series fetch --format=yaml
|
258
|
+
----
|
259
|
+
|
260
|
+
[example]
|
261
|
+
====
|
262
|
+
[source,shell]
|
263
|
+
----
|
264
|
+
$ w3c_api series fetch --format=yaml
|
265
|
+
- shortname: html
|
266
|
+
name: HTML
|
267
|
+
- shortname: css
|
268
|
+
name: CSS
|
269
|
+
# Additional series omitted for brevity
|
270
|
+
----
|
271
|
+
====
|
272
|
+
|
273
|
+
==== Get
|
274
|
+
|
275
|
+
Getting a specification series by shortname.
|
276
|
+
|
277
|
+
[source,shell]
|
278
|
+
----
|
279
|
+
# Fetch a specification series
|
280
|
+
$ w3c_api series fetch --shortname=webrtc
|
281
|
+
# Fetch a specification series in JSON format
|
282
|
+
$ w3c_api series fetch --shortname=webrtc --format=json
|
283
|
+
# Fetch a specification series in YAML format
|
284
|
+
$ w3c_api series fetch --shortname=webrtc --format=yaml
|
285
|
+
----
|
286
|
+
|
287
|
+
[example]
|
288
|
+
====
|
289
|
+
[source,shell]
|
290
|
+
----
|
291
|
+
$ w3c_api series fetch --shortname=webrtc --format=yaml
|
292
|
+
---
|
293
|
+
shortname: webrtc
|
294
|
+
name: 'WebRTC: Real-Time Communication Between Browsers'
|
295
|
+
_links:
|
296
|
+
self:
|
297
|
+
href: https://api.w3.org/specification-series/webrtc
|
298
|
+
specifications:
|
299
|
+
href: https://api.w3.org/specification-series/webrtc/specifications
|
300
|
+
current_specification:
|
301
|
+
href: https://api.w3.org/specifications/webrtc
|
302
|
+
----
|
303
|
+
====
|
304
|
+
|
305
|
+
==== Specifications
|
306
|
+
|
307
|
+
This command provides access to specifications in a series.
|
308
|
+
|
309
|
+
[source,shell]
|
310
|
+
----
|
311
|
+
# Fetch specifications in a series
|
312
|
+
$ w3c_api series specifications --shortname=webrtc
|
313
|
+
# Fetch specifications in a series in JSON format
|
314
|
+
$ w3c_api series specifications --shortname=webrtc --format=json
|
315
|
+
# Fetch specifications in a series in YAML format
|
316
|
+
$ w3c_api series specifications --shortname=webrtc --format=yaml
|
317
|
+
----
|
318
|
+
|
319
|
+
[example]
|
320
|
+
====
|
321
|
+
[source,shell]
|
322
|
+
----
|
323
|
+
$ w3c_api series specifications --shortname=webrtc --format=yaml
|
324
|
+
---
|
325
|
+
specifications:
|
326
|
+
- title: 'WebRTC: Real-Time Communication in Browsers'
|
327
|
+
href: https://api.w3.org/specifications/webrtc
|
328
|
+
----
|
329
|
+
====
|
330
|
+
|
331
|
+
=== Users
|
332
|
+
|
333
|
+
This command provides access to W3C users.
|
334
|
+
|
335
|
+
[IMPORTANT]
|
336
|
+
.User ID Formats
|
337
|
+
====
|
338
|
+
The W3C API uses both numeric IDs (e.g., `128112`) and string IDs (e.g., `f1ovb5rydm8s0go04oco0cgk0sow44w`) for users. All user-related commands support both formats. The format depends on how the user is referenced in API responses.
|
339
|
+
====
|
340
|
+
|
341
|
+
==== Get
|
342
|
+
|
343
|
+
Getting a user by ID.
|
344
|
+
|
345
|
+
[source,shell]
|
346
|
+
----
|
347
|
+
# Fetch a user with a numeric ID
|
348
|
+
$ w3c_api user fetch --id=128112
|
349
|
+
# Fetch a user with a string ID
|
350
|
+
$ w3c_api user fetch --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
351
|
+
# Fetch a user in JSON format
|
352
|
+
$ w3c_api user fetch --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=json
|
353
|
+
# Fetch a user in YAML format
|
354
|
+
$ w3c_api user fetch --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
355
|
+
----
|
356
|
+
|
357
|
+
[example]
|
358
|
+
====
|
359
|
+
[source,shell]
|
360
|
+
----
|
361
|
+
$ w3c_api user fetch --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
362
|
+
---
|
363
|
+
id: 128112
|
364
|
+
name: Jennifer Strickland
|
365
|
+
given: Jennifer
|
366
|
+
family: Strickland
|
367
|
+
discr: user
|
368
|
+
country_code: US
|
369
|
+
connected_accounts:
|
370
|
+
- created: '2021-03-12T22:06:06+00:00'
|
371
|
+
service: github
|
372
|
+
identifier: '57469'
|
373
|
+
nickname: jenstrickland
|
374
|
+
profile_picture: https://avatars.githubusercontent.com/u/57469?v=4
|
375
|
+
href: https://github.com/jenstrickland
|
376
|
+
_links:
|
377
|
+
user:
|
378
|
+
href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w
|
379
|
+
_links:
|
380
|
+
self:
|
381
|
+
href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w
|
382
|
+
affiliations:
|
383
|
+
href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/affiliations
|
384
|
+
groups:
|
385
|
+
href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/groups
|
386
|
+
specifications:
|
387
|
+
href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/specifications
|
388
|
+
participations:
|
389
|
+
href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/participations
|
390
|
+
chair_of_groups:
|
391
|
+
href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/chair-of-groups
|
392
|
+
team_contact_of_groups:
|
393
|
+
href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/team-contact-of-groups
|
394
|
+
----
|
395
|
+
====
|
396
|
+
|
397
|
+
==== Groups
|
398
|
+
|
399
|
+
Getting groups a user is a member of.
|
400
|
+
|
401
|
+
[source,shell]
|
402
|
+
----
|
403
|
+
# Fetch groups a user is a member of
|
404
|
+
$ w3c_api user groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
405
|
+
# Fetch groups a user is a member of in JSON format
|
406
|
+
$ w3c_api user groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=json
|
407
|
+
# Fetch groups a user is a member of in YAML format
|
408
|
+
$ w3c_api user groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
409
|
+
----
|
410
|
+
|
411
|
+
[example]
|
412
|
+
====
|
413
|
+
[source,shell]
|
414
|
+
----
|
415
|
+
$ w3c_api user groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
416
|
+
---
|
417
|
+
groups:
|
418
|
+
- href: https://api.w3.org/groups/wg/ag
|
419
|
+
title: Accessibility Guidelines Working Group
|
420
|
+
- href: https://api.w3.org/groups/cg/global-inclusion
|
421
|
+
title: Accessibility Internationalization Community Group
|
422
|
+
- href: https://api.w3.org/groups/wg/apa
|
423
|
+
title: Accessible Platform Architectures Working Group
|
424
|
+
- href: https://api.w3.org/groups/wg/css
|
425
|
+
title: Cascading Style Sheets (CSS) Working Group
|
426
|
+
- href: https://api.w3.org/groups/cg/coga-community
|
427
|
+
title: Cognitive Accessibility Community Group
|
428
|
+
- href: https://api.w3.org/groups/cg/equity
|
429
|
+
title: Equity Community Group
|
430
|
+
- href: https://api.w3.org/groups/wg/immersive-web
|
431
|
+
title: Immersive Web Working Group
|
432
|
+
- href: https://api.w3.org/groups/cg/pwe
|
433
|
+
title: Positive Work Environment Community Group
|
434
|
+
- href: https://api.w3.org/groups/cg/silver
|
435
|
+
title: Silver Community Group
|
436
|
+
- href: https://api.w3.org/groups/wg/sdw
|
437
|
+
title: Spatio-temporal Data on the Web Working Group
|
438
|
+
- href: https://api.w3.org/groups/cg/sustainability
|
439
|
+
title: Sustainability Community Group
|
440
|
+
- href: https://api.w3.org/groups/ig/sustainableweb
|
441
|
+
title: Sustainable Web Interest Group
|
442
|
+
- href: https://api.w3.org/groups/cg/w3process
|
443
|
+
title: W3C Process Community Group
|
444
|
+
- href: https://api.w3.org/groups/wg/webapps
|
445
|
+
title: Web Applications Working Group
|
446
|
+
- href: https://api.w3.org/groups/cg/webcomponents
|
447
|
+
title: Web Components Community Group
|
448
|
+
- href: https://api.w3.org/groups/wg/webperf
|
449
|
+
title: Web Performance Working Group
|
450
|
+
----
|
451
|
+
====
|
452
|
+
|
453
|
+
==== Specifications
|
454
|
+
|
455
|
+
Getting specifications a user has contributed to.
|
456
|
+
|
457
|
+
[source,shell]
|
458
|
+
----
|
459
|
+
# Fetch specifications a user has contributed to
|
460
|
+
$ w3c_api user specifications --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
461
|
+
# Fetch specifications a user has contributed to in JSON format
|
462
|
+
$ w3c_api user specifications --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=json
|
463
|
+
# Fetch specifications a user has contributed to in YAML format
|
464
|
+
$ w3c_api user specifications --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
465
|
+
----
|
466
|
+
|
467
|
+
[example]
|
468
|
+
====
|
469
|
+
[source,shell]
|
470
|
+
----
|
471
|
+
$ w3c_api user specifications --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
472
|
+
specifications:
|
473
|
+
- title: HTML 5.2
|
474
|
+
href: https://api.w3.org/specifications/html52
|
475
|
+
- title: CSS Color Module Level 3
|
476
|
+
href: https://api.w3.org/specifications/css-color-3
|
477
|
+
# Additional specifications omitted for brevity
|
478
|
+
----
|
479
|
+
====
|
480
|
+
|
481
|
+
==== Affiliations
|
482
|
+
|
483
|
+
Getting affiliations of a user.
|
484
|
+
|
485
|
+
[source,shell]
|
486
|
+
----
|
487
|
+
# Fetch affiliations of a user
|
488
|
+
$ w3c_api user affiliations --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
489
|
+
# Fetch affiliations of a user in JSON format
|
490
|
+
$ w3c_api user affiliations --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=json
|
491
|
+
# Fetch affiliations of a user in YAML format
|
492
|
+
$ w3c_api user affiliations --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
493
|
+
----
|
494
|
+
|
495
|
+
[example]
|
496
|
+
====
|
497
|
+
[source,shell]
|
498
|
+
----
|
499
|
+
$ w3c_api user affiliations --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
500
|
+
---
|
501
|
+
affiliations:
|
502
|
+
- href: https://api.w3.org/affiliations/1092
|
503
|
+
title: MITRE Corporation
|
504
|
+
----
|
505
|
+
====
|
506
|
+
|
507
|
+
==== Participations
|
508
|
+
|
509
|
+
Getting participations of a user.
|
510
|
+
|
511
|
+
[source,shell]
|
512
|
+
----
|
513
|
+
# Fetch participations of a user
|
514
|
+
$ w3c_api user participations --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
515
|
+
# Fetch participations of a user in JSON format
|
516
|
+
$ w3c_api user participations --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=json
|
517
|
+
# Fetch participations of a user in YAML format
|
518
|
+
$ w3c_api user participations --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
519
|
+
----
|
520
|
+
|
521
|
+
[example]
|
522
|
+
====
|
523
|
+
[source,shell]
|
524
|
+
----
|
525
|
+
$ w3c_api user participations --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
526
|
+
---
|
527
|
+
participations:
|
528
|
+
- title: Silver Community Group
|
529
|
+
href: https://api.w3.org/participations/38785
|
530
|
+
- title: Accessibility Guidelines Working Group
|
531
|
+
href: https://api.w3.org/participations/41574
|
532
|
+
- title: Cognitive Accessibility Community Group
|
533
|
+
href: https://api.w3.org/participations/38233
|
534
|
+
- title: Immersive Web Working Group
|
535
|
+
href: https://api.w3.org/participations/43790
|
536
|
+
- title: Cascading Style Sheets (CSS) Working Group
|
537
|
+
href: https://api.w3.org/participations/38783
|
538
|
+
- title: Positive Work Environment Community Group
|
539
|
+
href: https://api.w3.org/participations/38784
|
540
|
+
- title: Web Performance Working Group
|
541
|
+
href: https://api.w3.org/participations/38786
|
542
|
+
- title: Spatio-temporal Data on the Web Working Group
|
543
|
+
href: https://api.w3.org/participations/44558
|
544
|
+
- title: W3C Process Community Group
|
545
|
+
href: https://api.w3.org/participations/39267
|
546
|
+
- title: Equity Community Group
|
547
|
+
href: https://api.w3.org/participations/39352
|
548
|
+
- title: Web Components Community Group
|
549
|
+
href: https://api.w3.org/participations/40553
|
550
|
+
- title: Accessible Platform Architectures Working Group
|
551
|
+
href: https://api.w3.org/participations/36682
|
552
|
+
- title: Sustainability Community Group
|
553
|
+
href: https://api.w3.org/participations/41861
|
554
|
+
- title: Web Applications Working Group
|
555
|
+
href: https://api.w3.org/participations/43789
|
556
|
+
- title: Accessibility Internationalization Community Group
|
557
|
+
href: https://api.w3.org/participations/43788
|
558
|
+
- title: Sustainable Web Interest Group
|
559
|
+
href: https://api.w3.org/participations/44152
|
560
|
+
----
|
561
|
+
====
|
562
|
+
|
563
|
+
==== Chair of Groups
|
564
|
+
|
565
|
+
Getting groups a user chairs.
|
566
|
+
|
567
|
+
[source,shell]
|
568
|
+
----
|
569
|
+
# Fetch groups a user chairs
|
570
|
+
$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
571
|
+
# Fetch groups a user chairs in JSON format
|
572
|
+
$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=json
|
573
|
+
# Fetch groups a user chairs in YAML format
|
574
|
+
$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
575
|
+
----
|
576
|
+
|
577
|
+
[example]
|
578
|
+
====
|
579
|
+
[source,shell]
|
580
|
+
----
|
581
|
+
$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
582
|
+
---
|
583
|
+
groups:
|
584
|
+
- href: https://api.w3.org/groups/cg/equity
|
585
|
+
title: Equity Community Group
|
586
|
+
----
|
587
|
+
====
|
588
|
+
|
589
|
+
==== Team Contact of Groups
|
590
|
+
|
591
|
+
Getting groups a user is a team contact of.
|
592
|
+
|
593
|
+
[source,shell]
|
594
|
+
----
|
595
|
+
# Fetch groups a user is a team contact of
|
596
|
+
$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
597
|
+
# Fetch groups a user is a team contact of in JSON format
|
598
|
+
$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=json
|
599
|
+
# Fetch groups a user is a team contact of in YAML format
|
600
|
+
$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
601
|
+
----
|
602
|
+
|
603
|
+
[example]
|
604
|
+
====
|
605
|
+
[source,shell]
|
606
|
+
----
|
607
|
+
$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
|
608
|
+
groups:
|
609
|
+
- name: Web Platform Working Group
|
610
|
+
href: https://api.w3.org/groups/72825
|
611
|
+
- name: Internationalization Working Group
|
612
|
+
href: https://api.w3.org/groups/32113
|
613
|
+
# Additional groups omitted for brevity
|
614
|
+
----
|
615
|
+
====
|
616
|
+
|
617
|
+
=== Groups
|
618
|
+
|
619
|
+
This command provides access to W3C groups.
|
620
|
+
|
621
|
+
==== Index
|
622
|
+
|
623
|
+
Fetching an index of groups.
|
624
|
+
|
625
|
+
[source,shell]
|
626
|
+
----
|
627
|
+
# Fetch groups
|
628
|
+
$ w3c_api group fetch [OPTIONS]
|
629
|
+
# Fetch groups in JSON format
|
630
|
+
$ w3c_api group fetch --format=json
|
631
|
+
# Fetch groups in YAML format
|
632
|
+
$ w3c_api group fetch --format=yaml
|
633
|
+
----
|
634
|
+
|
635
|
+
[example]
|
636
|
+
====
|
637
|
+
[source,shell]
|
638
|
+
----
|
639
|
+
$ w3c_api group fetch --format=yaml
|
640
|
+
---
|
641
|
+
groups:
|
642
|
+
- href: https://api.w3.org/groups/tf/ab-liaisons-to-bod
|
643
|
+
title: AB Liaisons to the Board of Directors
|
644
|
+
- href: https://api.w3.org/groups/cg/a11yedge
|
645
|
+
title: Accessibility at the Edge Community Group
|
646
|
+
- href: https://api.w3.org/groups/tf/wcag-act
|
647
|
+
title: Accessibility Conformance Testing (ACT) Task Force
|
648
|
+
- href: https://api.w3.org/groups/cg/a11y-discov-vocab
|
649
|
+
title: Accessibility Discoverability Vocabulary for Schema.org Community Group
|
650
|
+
# Additional groups omitted for brevity
|
651
|
+
----
|
652
|
+
====
|
653
|
+
|
654
|
+
==== Get
|
655
|
+
|
656
|
+
Getting a group by ID.
|
657
|
+
|
658
|
+
[source,shell]
|
659
|
+
----
|
660
|
+
# Fetch a group
|
661
|
+
$ w3c_api group fetch --id=109735
|
662
|
+
# Fetch a group in JSON format
|
663
|
+
$ w3c_api group fetch --id=109735 --format=json
|
664
|
+
# Fetch a group in YAML format
|
665
|
+
$ w3c_api group fetch --id=109735 --format=yaml
|
666
|
+
----
|
667
|
+
|
668
|
+
[example]
|
669
|
+
====
|
670
|
+
[source,shell]
|
671
|
+
----
|
672
|
+
---
|
673
|
+
id: 109735
|
674
|
+
name: Immersive Web Working Group
|
675
|
+
type: working group
|
676
|
+
description: The mission of the Immersive Web Working Group is to help bring high-performance
|
677
|
+
Virtual Reality (VR) and Augmented Reality (AR) (collectively known as XR) to the
|
678
|
+
open Web via APIs to interact with XR devices and sensors in browsers.
|
679
|
+
shortname: immersive-web
|
680
|
+
discr: w3cgroup
|
681
|
+
start_date: '2018-09-24'
|
682
|
+
end_date: '2026-09-25'
|
683
|
+
is_closed: false
|
684
|
+
_links:
|
685
|
+
self:
|
686
|
+
href: https://api.w3.org/groups/wg/immersive-web
|
687
|
+
homepage:
|
688
|
+
href: https://www.w3.org/immersive-web/
|
689
|
+
users:
|
690
|
+
href: https://api.w3.org/groups/wg/immersive-web/users
|
691
|
+
services:
|
692
|
+
href: https://api.w3.org/groups/wg/immersive-web/services
|
693
|
+
specifications:
|
694
|
+
href: https://api.w3.org/groups/wg/immersive-web/specifications
|
695
|
+
chairs:
|
696
|
+
href: https://api.w3.org/groups/wg/immersive-web/chairs
|
697
|
+
team_contacts:
|
698
|
+
href: https://api.w3.org/groups/wg/immersive-web/teamcontacts
|
699
|
+
charters:
|
700
|
+
href: https://api.w3.org/groups/wg/immersive-web/charters
|
701
|
+
active_charter:
|
702
|
+
href: https://api.w3.org/groups/wg/immersive-web/charters/514
|
703
|
+
join:
|
704
|
+
href: https://www.w3.org/groups/wg/immersive-web/join
|
705
|
+
pp_status:
|
706
|
+
href: https://www.w3.org/groups/wg/immersive-web/ipr
|
707
|
+
participations:
|
708
|
+
href: https://api.w3.org/groups/wg/immersive-web/participations
|
709
|
+
----
|
710
|
+
====
|
711
|
+
|
712
|
+
==== Users
|
713
|
+
|
714
|
+
Getting users in a group.
|
715
|
+
|
716
|
+
[source,shell]
|
717
|
+
----
|
718
|
+
# Fetch users in a group
|
719
|
+
$ w3c_api group users --id=109735
|
720
|
+
# Fetch users in a group in JSON format
|
721
|
+
$ w3c_api group users --id=109735 --format=json
|
722
|
+
# Fetch users in a group in YAML format
|
723
|
+
$ w3c_api group users --id=109735 --format=yaml
|
724
|
+
----
|
725
|
+
|
726
|
+
[example]
|
727
|
+
====
|
728
|
+
[source,sh]
|
729
|
+
----
|
730
|
+
$ w3c_api group users --id=109735 --format=yaml
|
731
|
+
---
|
732
|
+
users:
|
733
|
+
- href: https://api.w3.org/users/9o1jsmhi8ysk088w0k4g00wsssk4c8c
|
734
|
+
title: Muadh Al Kalbani
|
735
|
+
- href: https://api.w3.org/users/rqjspzlmiq8c0kk8goos4c480w8wccs
|
736
|
+
title: Matthew Atkinson
|
737
|
+
- href: https://api.w3.org/users/32hnccz98a68sk0kcog8c4wo4sgckkw
|
738
|
+
title: Ashwin Balasubramaniyan
|
739
|
+
- href: https://api.w3.org/users/ff80kfl6a0gso4oo8s40cg4c4wccgs0
|
740
|
+
title: Trevor Baron
|
741
|
+
- href: https://api.w3.org/users/icpnypf3mfsckc848s0cgwckgwgcwks
|
742
|
+
title: Piotr Bialecki
|
743
|
+
- href: https://api.w3.org/users/cfck5b7g1h4wkkco80w08g488kg4c0c
|
744
|
+
title: Michael Blix
|
745
|
+
- href: https://api.w3.org/users/bigukrtur3co8s04k4kocg04ow0oowo
|
746
|
+
title: Artem Bolgar
|
747
|
+
----
|
748
|
+
====
|
749
|
+
|
750
|
+
==== Specifications
|
751
|
+
|
752
|
+
Getting specifications of a group.
|
753
|
+
|
754
|
+
[source,shell]
|
755
|
+
----
|
756
|
+
# Fetch specifications of a group
|
757
|
+
$ w3c_api group specifications --id=109735
|
758
|
+
# Fetch specifications of a group in JSON format
|
759
|
+
$ w3c_api group specifications --id=109735 --format=json
|
760
|
+
# Fetch specifications of a group in YAML format
|
761
|
+
$ w3c_api group specifications --id=109735 --format=yaml
|
762
|
+
----
|
763
|
+
|
764
|
+
[example]
|
765
|
+
====
|
766
|
+
[source,shell]
|
767
|
+
----
|
768
|
+
$ w3c_api group specifications --id=109735 --format=yaml
|
769
|
+
---
|
770
|
+
specifications:
|
771
|
+
- title: WebXR Lighting Estimation API Level 1
|
772
|
+
href: https://api.w3.org/specifications/webxr-lighting-estimation-1
|
773
|
+
- title: WebXR Augmented Reality Module - Level 1
|
774
|
+
href: https://api.w3.org/specifications/webxr-ar-module-1
|
775
|
+
- title: WebXR Gamepads Module - Level 1
|
776
|
+
href: https://api.w3.org/specifications/webxr-gamepads-module-1
|
777
|
+
- title: WebXR Layers API Level 1
|
778
|
+
href: https://api.w3.org/specifications/webxrlayers-1
|
779
|
+
# Additional specifications omitted for brevity
|
780
|
+
----
|
781
|
+
====
|
782
|
+
|
783
|
+
==== Charters
|
784
|
+
|
785
|
+
Getting charters of a group.
|
786
|
+
|
787
|
+
[source,shell]
|
788
|
+
----
|
789
|
+
# Fetch charters of a group
|
790
|
+
$ w3c_api group charters --id=109735
|
791
|
+
# Fetch charters of a group in JSON format
|
792
|
+
$ w3c_api group charters --id=109735 --format=json
|
793
|
+
# Fetch charters of a group in YAML format
|
794
|
+
$ w3c_api group charters --id=109735 --format=yaml
|
795
|
+
----
|
796
|
+
|
797
|
+
[example]
|
798
|
+
====
|
799
|
+
[source,shell]
|
800
|
+
----
|
801
|
+
$ w3c_api group charters --id=109735 --format=yaml
|
802
|
+
---
|
803
|
+
charters:
|
804
|
+
- href: https://api.w3.org/groups/109735/charters/361
|
805
|
+
title: 2018-09-24 -> 2020-03-01
|
806
|
+
- href: https://api.w3.org/groups/109735/charters/405
|
807
|
+
title: 2020-05-12 -> 2022-06-01
|
808
|
+
- href: https://api.w3.org/groups/109735/charters/464
|
809
|
+
title: 2022-07-08 -> 2024-07-07
|
810
|
+
- href: https://api.w3.org/groups/109735/charters/514
|
811
|
+
title: 2024-09-26 -> 2026-09-25
|
812
|
+
----
|
813
|
+
====
|
814
|
+
|
815
|
+
==== Chairs
|
816
|
+
|
817
|
+
Getting chairs of a group.
|
818
|
+
|
819
|
+
[source,shell]
|
820
|
+
----
|
821
|
+
# Fetch chairs of a group
|
822
|
+
$ w3c_api group chairs --id=109735
|
823
|
+
# Fetch chairs of a group in JSON format
|
824
|
+
$ w3c_api group chairs --id=109735 --format=json
|
825
|
+
# Fetch chairs of a group in YAML format
|
826
|
+
$ w3c_api group chairs --id=109735 --format=yaml
|
827
|
+
----
|
828
|
+
|
829
|
+
[example]
|
830
|
+
====
|
831
|
+
[source,shell]
|
832
|
+
----
|
833
|
+
$ w3c_api group chairs --id=109735 --format=yaml
|
834
|
+
---
|
835
|
+
users:
|
836
|
+
- href: https://api.w3.org/users/basy63arxl448c8co0og8ocosocgc0w
|
837
|
+
title: Ada Rose Cannon
|
838
|
+
- href: https://api.w3.org/users/l88ca27n2b4sk00cogosk0skw4s8osc
|
839
|
+
title: Chris Wilson
|
840
|
+
- href: https://api.w3.org/users/m99jqkpi9m8oww84kw4gwccgc4g0ogs
|
841
|
+
title: Ayşegül Yönet
|
842
|
+
----
|
843
|
+
====
|
844
|
+
|
845
|
+
|
846
|
+
==== Team Contacts
|
847
|
+
|
848
|
+
Getting team contacts of a group.
|
849
|
+
|
850
|
+
[source,shell]
|
851
|
+
----
|
852
|
+
# Fetch team contacts of a group
|
853
|
+
$ w3c_api group team_contacts --id=109735
|
854
|
+
# Fetch team contacts of a group in JSON format
|
855
|
+
$ w3c_api group team_contacts --id=109735 --format=json
|
856
|
+
# Fetch team contacts of a group in YAML format
|
857
|
+
$ w3c_api group team_contacts --id=109735 --format=yaml
|
858
|
+
----
|
859
|
+
|
860
|
+
[example]
|
861
|
+
====
|
862
|
+
[source,shell]
|
863
|
+
----
|
864
|
+
$ w3c_api group team_contacts --id=109735 --format=yaml
|
865
|
+
---
|
866
|
+
users:
|
867
|
+
- href: https://api.w3.org/users/1eb2xr7ab6zo0k8440o48swso408ksc
|
868
|
+
title: Atsushi Shimono
|
869
|
+
----
|
870
|
+
====
|
871
|
+
|
872
|
+
=== Affiliations
|
873
|
+
|
874
|
+
This command provides access to W3C affiliations (organizations).
|
875
|
+
|
876
|
+
==== Index
|
877
|
+
|
878
|
+
Fetching an index of affiliations.
|
879
|
+
|
880
|
+
[source,shell]
|
881
|
+
----
|
882
|
+
# Fetch affiliations
|
883
|
+
$ w3c_api affiliation fetch [OPTIONS]
|
884
|
+
# Fetch affiliations in JSON format
|
885
|
+
$ w3c_api affiliation fetch --format=json
|
886
|
+
# Fetch affiliations in YAML format
|
887
|
+
$ w3c_api affiliation fetch --format=yaml
|
888
|
+
----
|
889
|
+
|
890
|
+
[example]
|
891
|
+
====
|
892
|
+
[source,shell]
|
893
|
+
----
|
894
|
+
$ w3c_api affiliation fetch --format=yaml
|
895
|
+
---
|
896
|
+
affiliations:
|
897
|
+
- href: https://api.w3.org/affiliations/1001
|
898
|
+
title: Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)
|
899
|
+
- href: https://api.w3.org/affiliations/1003
|
900
|
+
title: BackWeb Technologies, Inc.
|
901
|
+
- href: https://api.w3.org/affiliations/1005
|
902
|
+
title: Bull S.A.
|
903
|
+
- href: https://api.w3.org/affiliations/1011
|
904
|
+
title: Digital Island, Inc.
|
905
|
+
- href: https://api.w3.org/affiliations/1013
|
906
|
+
title: University of Bristol
|
907
|
+
- href: https://api.w3.org/affiliations/1014
|
908
|
+
title: Internet Association Japan
|
909
|
+
# Additional affiliations omitted for brevity
|
910
|
+
----
|
911
|
+
====
|
912
|
+
|
913
|
+
==== Get
|
914
|
+
|
915
|
+
Getting an affiliation by ID.
|
916
|
+
|
917
|
+
[source,shell]
|
918
|
+
----
|
919
|
+
# Fetch an affiliation
|
920
|
+
$ w3c_api affiliation fetch --id=35662
|
921
|
+
# Fetch an affiliation in JSON format
|
922
|
+
$ w3c_api affiliation fetch --id=35662 --format=json
|
923
|
+
# Fetch an affiliation in YAML format
|
924
|
+
$ w3c_api affiliation fetch --id=35662 --format=yaml
|
925
|
+
----
|
926
|
+
|
927
|
+
[example]
|
928
|
+
====
|
929
|
+
[source,shell]
|
930
|
+
----
|
931
|
+
$ w3c_api affiliation fetch --id=35662 --format=yaml
|
932
|
+
---
|
933
|
+
affiliations:
|
934
|
+
- id: 35662
|
935
|
+
name: Google LLC
|
936
|
+
is_member: true
|
937
|
+
is_member_association: false
|
938
|
+
is_partner_member: false
|
939
|
+
_links:
|
940
|
+
self:
|
941
|
+
href: https://api.w3.org/affiliations/35662
|
942
|
+
participants:
|
943
|
+
href: https://api.w3.org/affiliations/35662/participants
|
944
|
+
participations:
|
945
|
+
href: https://api.w3.org/affiliations/35662/participations
|
946
|
+
----
|
947
|
+
====
|
948
|
+
|
949
|
+
==== Participants
|
950
|
+
|
951
|
+
Getting participants of an affiliation.
|
952
|
+
|
953
|
+
[source,shell]
|
954
|
+
----
|
955
|
+
# Fetch participants of an affiliation
|
956
|
+
$ w3c_api affiliation participants --id=35662
|
957
|
+
# Fetch participants of an affiliation in JSON format
|
958
|
+
$ w3c_api affiliation participants --id=35662 --format=json
|
959
|
+
# Fetch participants of an affiliation in YAML format
|
960
|
+
$ w3c_api affiliation participants --id=35662 --format=yaml
|
961
|
+
----
|
962
|
+
|
963
|
+
[example]
|
964
|
+
====
|
965
|
+
[source,shell]
|
966
|
+
----
|
967
|
+
$ w3c_api affiliation participants --id=35662 --format=yaml
|
968
|
+
---
|
969
|
+
users:
|
970
|
+
- href: https://api.w3.org/users/p3dte6mpoj4sgw888w8kw4w4skwosck
|
971
|
+
title: Tab Atkins Jr.
|
972
|
+
- href: https://api.w3.org/users/l88ca27n2b4sk00cogosk0skw4s8osc
|
973
|
+
title: Chris Wilson
|
974
|
+
- href: https://api.w3.org/users/kjqsxbe6kioko4s88s4wocws848kgw8
|
975
|
+
title: David Baron
|
976
|
+
- href: https://api.w3.org/users/t9qq83owlzkck404w0o44so8owc00gg
|
977
|
+
title: Rune Lillesveen
|
978
|
+
- href: https://api.w3.org/users/jviqbqcbem8w4gkgwcscoc400skcwwk
|
979
|
+
title: Koji Ishii
|
980
|
+
# Additional participants omitted for brevity
|
981
|
+
----
|
982
|
+
====
|
983
|
+
|
984
|
+
==== Participations
|
985
|
+
|
986
|
+
Getting participations of an affiliation.
|
987
|
+
|
988
|
+
[source,shell]
|
989
|
+
----
|
990
|
+
# Fetch participations of an affiliation
|
991
|
+
$ w3c_api affiliation participations --id=35662
|
992
|
+
# Fetch participations of an affiliation in JSON format
|
993
|
+
$ w3c_api affiliation participations --id=35662 --format=json
|
994
|
+
# Fetch participations of an affiliation in YAML format
|
995
|
+
$ w3c_api affiliation participations --id=35662 --format=yaml
|
996
|
+
----
|
997
|
+
|
998
|
+
[example]
|
999
|
+
====
|
1000
|
+
[source,shell]
|
1001
|
+
----
|
1002
|
+
$ w3c_api affiliation participations --id=35662 --format=yaml
|
1003
|
+
---
|
1004
|
+
participations:
|
1005
|
+
- title: Patents and Standards Interest Group
|
1006
|
+
href: https://api.w3.org/participations/3092
|
1007
|
+
- title: Media and Entertainment Interest Group
|
1008
|
+
href: https://api.w3.org/participations/3115
|
1009
|
+
- title: JSON for Linked Data Community Group
|
1010
|
+
href: https://api.w3.org/participations/3121
|
1011
|
+
- title: Games Community Group
|
1012
|
+
href: https://api.w3.org/participations/3124
|
1013
|
+
----
|
1014
|
+
====
|
1015
|
+
|
1016
|
+
=== Ecosystems
|
1017
|
+
|
1018
|
+
This command provides access to W3C ecosystems.
|
1019
|
+
|
1020
|
+
==== Index
|
1021
|
+
|
1022
|
+
Fetching an index of ecosystems.
|
1023
|
+
|
1024
|
+
[source,shell]
|
1025
|
+
----
|
1026
|
+
# Fetch ecosystems
|
1027
|
+
$ w3c_api ecosystem fetch
|
1028
|
+
# Fetch ecosystems in JSON format
|
1029
|
+
$ w3c_api ecosystem fetch --format=json
|
1030
|
+
# Fetch ecosystems in YAML format
|
1031
|
+
$ w3c_api ecosystem fetch --format=yaml
|
1032
|
+
----
|
1033
|
+
|
1034
|
+
[example]
|
1035
|
+
====
|
1036
|
+
[source,shell]
|
1037
|
+
----
|
1038
|
+
$ w3c_api ecosystem fetch --format=yaml
|
1039
|
+
---
|
1040
|
+
ecosystems:
|
1041
|
+
- href: https://api.w3.org/ecosystems/advertising
|
1042
|
+
title: Web Advertising
|
1043
|
+
- href: https://api.w3.org/ecosystems/e-commerce
|
1044
|
+
title: E-commerce
|
1045
|
+
- href: https://api.w3.org/ecosystems/media
|
1046
|
+
title: Media & Entertainment
|
1047
|
+
- href: https://api.w3.org/ecosystems/network-communications
|
1048
|
+
title: Network & Communications
|
1049
|
+
- href: https://api.w3.org/ecosystems/publishing
|
1050
|
+
title: Publishing
|
1051
|
+
- href: https://api.w3.org/ecosystems/smart-cities
|
1052
|
+
title: Smart Cities
|
1053
|
+
- href: https://api.w3.org/ecosystems/automotive-transportation
|
1054
|
+
title: Automotive & Transportation
|
1055
|
+
- href: https://api.w3.org/ecosystems/web-of-things
|
1056
|
+
title: Web of Things
|
1057
|
+
- href: https://api.w3.org/ecosystems/data
|
1058
|
+
title: Data and knowledge
|
1059
|
+
----
|
1060
|
+
====
|
1061
|
+
|
1062
|
+
==== Get
|
1063
|
+
|
1064
|
+
Getting an ecosystem by shortname.
|
1065
|
+
|
1066
|
+
[source,shell]
|
1067
|
+
----
|
1068
|
+
# Fetch an ecosystem
|
1069
|
+
$ w3c_api ecosystem fetch --shortname=data
|
1070
|
+
# Fetch an ecosystem in JSON format
|
1071
|
+
$ w3c_api ecosystem fetch --shortname=data --format=json
|
1072
|
+
# Fetch an ecosystem in YAML format
|
1073
|
+
$ w3c_api ecosystem fetch --shortname=data --format=yaml
|
1074
|
+
----
|
1075
|
+
|
1076
|
+
[example]
|
1077
|
+
====
|
1078
|
+
[source,shell]
|
1079
|
+
----
|
1080
|
+
$ w3c_api ecosystem fetch --shortname=data --format=yaml
|
1081
|
+
---
|
1082
|
+
name: Data and knowledge
|
1083
|
+
shortname: data
|
1084
|
+
_links:
|
1085
|
+
self:
|
1086
|
+
href: https://api.w3.org/ecosystems/data
|
1087
|
+
champion:
|
1088
|
+
href: https://api.w3.org/users/t891ludoisggsccsw44o8goccc0s0ks
|
1089
|
+
title: Pierre-Antoine Champin
|
1090
|
+
evangelists:
|
1091
|
+
href: https://api.w3.org/ecosystems/data/evangelists
|
1092
|
+
groups:
|
1093
|
+
href: https://api.w3.org/ecosystems/data/groups
|
1094
|
+
member_organizations:
|
1095
|
+
href: https://api.w3.org/ecosystems/data/member-organizations
|
1096
|
+
----
|
1097
|
+
====
|
1098
|
+
|
1099
|
+
==== Groups
|
1100
|
+
|
1101
|
+
Getting groups in an ecosystem.
|
1102
|
+
|
1103
|
+
[source,shell]
|
1104
|
+
----
|
1105
|
+
# Fetch groups in an ecosystem
|
1106
|
+
$ w3c_api ecosystem groups --shortname=data
|
1107
|
+
# Fetch groups in an ecosystem in JSON format
|
1108
|
+
$ w3c_api ecosystem groups --shortname=data --format=json
|
1109
|
+
# Fetch groups in an ecosystem in YAML format
|
1110
|
+
$ w3c_api ecosystem groups --shortname=data --format=yaml
|
1111
|
+
----
|
1112
|
+
|
1113
|
+
[example]
|
1114
|
+
====
|
1115
|
+
[source,shell]
|
1116
|
+
----
|
1117
|
+
$ w3c_api ecosystem groups --shortname=data --format=yaml
|
1118
|
+
---
|
1119
|
+
groups:
|
1120
|
+
- href: https://api.w3.org/groups/wg/data-shapes
|
1121
|
+
title: Data Shapes Working Group
|
1122
|
+
- href: https://api.w3.org/groups/wg/dx
|
1123
|
+
title: Dataset Exchange Working Group
|
1124
|
+
- href: https://api.w3.org/groups/wg/did
|
1125
|
+
title: Decentralized Identifier Working Group
|
1126
|
+
- href: https://api.w3.org/groups/wg/json-ld
|
1127
|
+
title: JSON-LD Working Group
|
1128
|
+
# Additional groups omitted for brevity
|
1129
|
+
----
|
1130
|
+
====
|
1131
|
+
|
1132
|
+
=== Translations
|
1133
|
+
|
1134
|
+
This command provides access to W3C translations.
|
1135
|
+
|
1136
|
+
==== Index
|
1137
|
+
|
1138
|
+
Fetching an index of translations.
|
1139
|
+
|
1140
|
+
[source,shell]
|
1141
|
+
----
|
1142
|
+
# Fetch translations
|
1143
|
+
$ w3c_api translation fetch
|
1144
|
+
# Fetch translations in JSON format
|
1145
|
+
$ w3c_api translation fetch --format=json
|
1146
|
+
# Fetch translations in YAML format
|
1147
|
+
$ w3c_api translation fetch --format=yaml
|
1148
|
+
----
|
1149
|
+
|
1150
|
+
[example]
|
1151
|
+
====
|
1152
|
+
[source,shell]
|
1153
|
+
----
|
1154
|
+
$ w3c_api translation fetch --format=yaml
|
1155
|
+
---
|
1156
|
+
translations:
|
1157
|
+
- title: 'Vidéo : introduction à l’accessibilité web et aux standards du W3C'
|
1158
|
+
href: https://api.w3.org/translations/2
|
1159
|
+
language: fr
|
1160
|
+
- title: Vídeo de Introducción a la Accesibilidad Web y Estándares del W3C
|
1161
|
+
href: https://api.w3.org/translations/3
|
1162
|
+
language: es
|
1163
|
+
- title: Video-introductie over Web-toegankelijkheid en W3C-standaarden
|
1164
|
+
href: https://api.w3.org/translations/4
|
1165
|
+
language: nl
|
1166
|
+
- title: 网页无障碍和W3C标准的介绍视频
|
1167
|
+
href: https://api.w3.org/translations/5
|
1168
|
+
language: zh_Hans
|
1169
|
+
# Additional translations omitted for brevity
|
1170
|
+
----
|
1171
|
+
====
|
1172
|
+
|
1173
|
+
==== Get
|
1174
|
+
|
1175
|
+
Getting a translation by ID.
|
1176
|
+
|
1177
|
+
[source,shell]
|
1178
|
+
----
|
1179
|
+
# Fetch a translation
|
1180
|
+
$ w3c_api translation fetch --id=2
|
1181
|
+
# Fetch a translation in JSON format
|
1182
|
+
$ w3c_api translation fetch --id=2 --format=json
|
1183
|
+
# Fetch a translation in YAML format
|
1184
|
+
$ w3c_api translation fetch --id=2 --format=yaml
|
1185
|
+
----
|
1186
|
+
|
1187
|
+
[example]
|
1188
|
+
====
|
1189
|
+
[source,shell]
|
1190
|
+
----
|
1191
|
+
$ w3c_api translation fetch --id=2 --format=yaml
|
1192
|
+
---
|
1193
|
+
uri: https://github.com/w3c/wai-video-standards-and-benefits/blob/master/index.fr.md
|
1194
|
+
title: 'Vidéo : introduction à l’accessibilité web et aux standards du W3C'
|
1195
|
+
language: fr
|
1196
|
+
authorized: false
|
1197
|
+
call_for_translation:
|
1198
|
+
uri: https://www.w3.org/WAI/videos/standards-and-benefits/
|
1199
|
+
title: Video Introduction to Web Accessibility and W3C Standards
|
1200
|
+
comments: Needs updating. Requested on 22 Feb 2019.
|
1201
|
+
states:
|
1202
|
+
- review
|
1203
|
+
translators:
|
1204
|
+
- id: 40757
|
1205
|
+
name: Stéphane Deschamps
|
1206
|
+
given: Stéphane
|
1207
|
+
family: Deschamps
|
1208
|
+
work_title: Mr.
|
1209
|
+
discr: user
|
1210
|
+
biography: "I love accessibility and standards. Don't we all."
|
1211
|
+
country_code: FR
|
1212
|
+
city: Arcueil Cedex
|
1213
|
+
_links:
|
1214
|
+
self:
|
1215
|
+
href: https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008
|
1216
|
+
affiliations:
|
1217
|
+
href: https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/affiliations
|
1218
|
+
groups:
|
1219
|
+
href: https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/groups
|
1220
|
+
specifications:
|
1221
|
+
href: https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/specifications
|
1222
|
+
participations:
|
1223
|
+
href: https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/participations
|
1224
|
+
chair_of_groups:
|
1225
|
+
href: https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/chair-of-groups
|
1226
|
+
team_contact_of_groups:
|
1227
|
+
href: https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/team-contact-of-groups
|
1228
|
+
_links:
|
1229
|
+
self:
|
1230
|
+
href: https://api.w3.org/translations/2
|
1231
|
+
----
|
1232
|
+
====
|
1233
|
+
|
1234
|
+
=== Troubleshooting
|
1235
|
+
|
1236
|
+
This section covers common issues and their solutions.
|
1237
|
+
|
1238
|
+
==== Empty Responses from Endpoints
|
1239
|
+
|
1240
|
+
Some API endpoints may return empty responses or 404 errors, especially for user-related endpoints. The library is designed to handle these cases gracefully by returning empty collections rather than raising exceptions.
|
1241
|
+
|
1242
|
+
[example]
|
1243
|
+
====
|
1244
|
+
If a user has no specifications, the command will still complete successfully but return an empty collection:
|
1245
|
+
|
1246
|
+
[source,shell]
|
1247
|
+
----
|
1248
|
+
$ w3c_api user specifications --id=128112 --format=yaml
|
1249
|
+
specifications: []
|
1250
|
+
----
|
1251
|
+
====
|
1252
|
+
|
1253
|
+
==== User ID Format Considerations
|
1254
|
+
|
1255
|
+
The W3C API uses two different ID formats for users:
|
1256
|
+
|
1257
|
+
1. Numeric IDs (e.g., `128112`)
|
1258
|
+
2. String IDs (e.g., `f1ovb5rydm8s0go04oco0cgk0sow44w`)
|
1259
|
+
|
1260
|
+
Both formats are important to consider when interacting with the API as they may affect the results returned based on the input type.
|
1261
|
+
|
1262
|
+
|
1263
|
+
== Copyright and License
|
1264
|
+
|
1265
|
+
Copyright Ribose.
|