w3c_api 0.1.0 → 0.1.1

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.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.md +1 -1
  3. data/README.adoc +845 -436
  4. data/lib/w3c_api/cli.rb +20 -20
  5. data/lib/w3c_api/client.rb +66 -195
  6. data/lib/w3c_api/commands/affiliation.rb +33 -33
  7. data/lib/w3c_api/commands/ecosystem.rb +47 -47
  8. data/lib/w3c_api/commands/group.rb +68 -68
  9. data/lib/w3c_api/commands/output_formatter.rb +11 -11
  10. data/lib/w3c_api/commands/participation.rb +20 -22
  11. data/lib/w3c_api/commands/series.rb +26 -26
  12. data/lib/w3c_api/commands/specification.rb +77 -52
  13. data/lib/w3c_api/commands/translation.rb +18 -18
  14. data/lib/w3c_api/commands/user.rb +60 -60
  15. data/lib/w3c_api/hal.rb +164 -0
  16. data/lib/w3c_api/models/account.rb +44 -0
  17. data/lib/w3c_api/models/affiliation.rb +54 -65
  18. data/lib/w3c_api/models/affiliation_index.rb +11 -0
  19. data/lib/w3c_api/models/call_for_translation.rb +15 -39
  20. data/lib/w3c_api/models/chair_index.rb +11 -0
  21. data/lib/w3c_api/models/charter.rb +48 -89
  22. data/lib/w3c_api/models/charter_index.rb +11 -0
  23. data/lib/w3c_api/models/connected_account.rb +21 -30
  24. data/lib/w3c_api/models/ecosystem.rb +20 -42
  25. data/lib/w3c_api/models/{ecosystems.rb → ecosystem_index.rb} +4 -10
  26. data/lib/w3c_api/models/evangelist_index.rb +11 -0
  27. data/lib/w3c_api/models/extension.rb +5 -7
  28. data/lib/w3c_api/models/group.rb +63 -142
  29. data/lib/w3c_api/models/group_index.rb +12 -0
  30. data/lib/w3c_api/models/join_emails.rb +5 -7
  31. data/lib/w3c_api/models/participant_index.rb +11 -0
  32. data/lib/w3c_api/models/participation.rb +31 -90
  33. data/lib/w3c_api/models/participation_index.rb +11 -0
  34. data/lib/w3c_api/models/photo.rb +26 -0
  35. data/lib/w3c_api/models/serie.rb +21 -51
  36. data/lib/w3c_api/models/{series.rb → serie_index.rb} +22 -13
  37. data/lib/w3c_api/models/spec_version.rb +69 -83
  38. data/lib/w3c_api/models/spec_version_index.rb +13 -0
  39. data/lib/w3c_api/models/spec_version_ref.rb +11 -13
  40. data/lib/w3c_api/models/specification.rb +54 -66
  41. data/lib/w3c_api/models/specification_index.rb +10 -0
  42. data/lib/w3c_api/models/team_contact_index.rb +11 -0
  43. data/lib/w3c_api/models/testimonial.rb +17 -0
  44. data/lib/w3c_api/models/translation.rb +33 -72
  45. data/lib/w3c_api/models/{translations.rb → translation_index.rb} +4 -12
  46. data/lib/w3c_api/models/user.rb +95 -165
  47. data/lib/w3c_api/models/user_index.rb +11 -0
  48. data/lib/w3c_api/models.rb +35 -12
  49. data/lib/w3c_api/version.rb +1 -1
  50. data/lib/w3c_api.rb +3 -2
  51. metadata +35 -19
  52. data/lib/w3c_api/models/affiliations.rb +0 -33
  53. data/lib/w3c_api/models/base.rb +0 -39
  54. data/lib/w3c_api/models/call_for_translation_ref.rb +0 -15
  55. data/lib/w3c_api/models/charters.rb +0 -17
  56. data/lib/w3c_api/models/collection_base.rb +0 -79
  57. data/lib/w3c_api/models/delegate_enumerable.rb +0 -54
  58. data/lib/w3c_api/models/groups.rb +0 -38
  59. data/lib/w3c_api/models/link.rb +0 -17
  60. data/lib/w3c_api/models/participations.rb +0 -17
  61. data/lib/w3c_api/models/series_collection.rb +0 -17
  62. data/lib/w3c_api/models/spec_versions.rb +0 -17
  63. data/lib/w3c_api/models/specifications.rb +0 -17
  64. data/lib/w3c_api/models/users.rb +0 -44
data/README.adoc CHANGED
@@ -1,4 +1,4 @@
1
- = W3C API in Ruby
1
+ = W3C API through LutaML Models
2
2
 
3
3
  image:https://img.shields.io/gem/v/w3c_api.svg["Gem Version", link="https://rubygems.org/gems/w3c_api"]
4
4
  image:https://github.com/relaton/w3c_api/workflows/rake/badge.svg["Build Status", link="https://github.com/relaton/w3c_api/actions?workflow=rake"]
@@ -6,17 +6,106 @@ image:https://codeclimate.com/github/relaton/w3c_api/badges/gpa.svg["Code Climat
6
6
 
7
7
  == Purpose
8
8
 
9
- A Ruby wrapper for the W3C web API with a CLI interface. This gem provides:
9
+ A Ruby client implementation for the W3C web API with a CLI interface.
10
10
 
11
- * A complete client for the W3C API
12
- * Data models created with https://github.com/lutaml/lutaml-model[lutaml-model]
11
+ This gem provides:
12
+
13
+ * A complete client for the W3C API (oft-used endpoints implemented)
14
+
15
+ * Data models created with
16
+ https://github.com/lutaml/lutaml-hal[lutaml-hal] and
17
+ https://github.com/lutaml/lutaml-model[lutaml-model]
13
18
  for all W3C API resources
19
+
20
+ * HAL (Hypertext Application Language) implementation for recursive resource traversal
21
+
14
22
  * A command-line interface using Thor following GitHub CLI patterns
15
23
 
24
+ The endpoint supported is at https://api.w3.org.
25
+
16
26
  This gem is developed against the W3C API documented at https://api.w3.org/doc.
17
27
 
28
+
29
+ == Illustrative example usage
30
+
31
+ This is an example demonstrating the power of this library as inherited
32
+ from `lutaml-hal`, showing multiple levels of automatic link resolution.
33
+
34
+ .Calling the Ruby API with multiple levels of link resolution
35
+ [source,ruby]
36
+ ----
37
+ > require 'w3c_api'
38
+ > W3cApi::Hal.instance.register.fetch(:ecosystem_index)
39
+ .links.ecosystems.first.realize
40
+ .links.evangelists.realize
41
+
42
+ # =>
43
+ # #<W3cApi::Models::EvangelistIndex:0x000000011de99d50
44
+ # @limit=100,
45
+ # @links=
46
+ # #<W3cApi::Models::EvangelistIndexLinkSet:0x000000011c19a600
47
+ # @evangelists=
48
+ # [#<W3cApi::Models::UserLink:0x000000011c1b9f78
49
+ # @deprecation=nil,
50
+ # @href="https://api.w3.org/users/664293jn3jswwo4sccsoko0wwk0wog0",
51
+ # @lang=nil,
52
+ # @name=nil,
53
+ # @profile=nil,
54
+ # @templated=nil,
55
+ # @title="Marty Voshell",
56
+ # @type="User">],
57
+ # @first=
58
+ # #<W3cApi::Models::EvangelistIndexLink:0x000000010c7378c0
59
+ # @deprecation=nil,
60
+ # @href="https://api.w3.org/ecosystems/advertising/evangelists?page=1&items=100",
61
+ # @lang=nil,
62
+ # @name=nil,
63
+ # @profile=nil,
64
+ # @templated=nil,
65
+ # @title=nil,
66
+ # @type="EvangelistIndex">,
67
+ # @last=
68
+ # #<W3cApi::Models::EvangelistIndexLink:0x000000010adeb560
69
+ # @deprecation=nil,
70
+ # @href="https://api.w3.org/ecosystems/advertising/evangelists?page=1&items=100",
71
+ # @lang=nil,
72
+ # @name=nil,
73
+ # @profile=nil,
74
+ # @templated=nil,
75
+ # @title=nil,
76
+ # @type="EvangelistIndex">,
77
+ # @next=nil,
78
+ # @prev=nil,
79
+ # @self=
80
+ # #<W3cApi::Models::EvangelistIndexLink:0x000000010c75a8c0
81
+ # @deprecation=nil,
82
+ # @href="https://api.w3.org/ecosystems/advertising/evangelists?page=1&items=100",
83
+ # @lang=nil,
84
+ # @name=nil,
85
+ # @profile=nil,
86
+ # @templated=nil,
87
+ # @title=nil,
88
+ # @type="EvangelistIndex">,
89
+ # @up=
90
+ # #<W3cApi::Models::EvangelistIndexLink:0x000000011c1be398
91
+ # @deprecation=nil,
92
+ # @href="https://api.w3.org/ecosystems/advertising",
93
+ # @lang=nil,
94
+ # @name=nil,
95
+ # @profile=nil,
96
+ # @templated=nil,
97
+ # @title=nil,
98
+ # @type="EvangelistIndex">>,
99
+ # @page=1,
100
+ # @pages=1,
101
+ # @total=1>
102
+ ----
103
+
104
+
18
105
  == Ruby API
19
106
 
107
+ === General
108
+
20
109
  [source,ruby]
21
110
  ----
22
111
  require 'w3c_api'
@@ -27,14 +116,18 @@ client = W3cApi::Client.new
27
116
  # Get specifications
28
117
  specifications = client.specifications
29
118
  specification = client.specification('webrtc')
119
+
30
120
  versions = client.specification_versions('webrtc')
31
121
  version = client.specification_version('webrtc', '20241008')
32
122
  specs_by_status = client.specifications_by_status('Recommendation')
33
123
 
34
- # Get specification series
35
- series_list = client.series
36
- series = client.series_by_shortname('webrtc')
37
- series_specs = client.series_specifications('webrtc')
124
+ # Work with linked resources directly
125
+ spec = client.specification('webrtc')
126
+ spec_versions = spec.links.versions
127
+ latest = spec.links.latest_version.realize # Resolves the latest-version link
128
+ series = spec.links.series
129
+ editors = spec.links.editors
130
+ deliverers = spec.links.deliverers
38
131
 
39
132
  # Get groups
40
133
  groups = client.groups
@@ -45,6 +138,13 @@ charters = client.group_charters(109735)
45
138
  chairs = client.group_chairs(109735)
46
139
  team_contacts = client.group_team_contacts(109735)
47
140
 
141
+ # Use link resolution with groups
142
+ group = client.group(109735)
143
+ specs = group.links.specifications
144
+ users = group.links.users
145
+ chairs = group.links.chairs
146
+ charters = group.links.charters
147
+
48
148
  # Get users
49
149
  users = client.users
50
150
  user = client.user('f1ovb5rydm8s0go04oco0cgk0sow44w')
@@ -61,13 +161,84 @@ affiliation = client.affiliation(35662) # Google LLC
61
161
  participants = client.affiliation_participants(35662)
62
162
  participations = client.affiliation_participations(35662)
63
163
 
64
- # Work with other resources
164
+ # Translations
65
165
  translations = client.translations
66
166
  translation = client.translation(2)
167
+
168
+ # Ecosystems
67
169
  ecosystems = client.ecosystems
68
170
  ecosystem = client.ecosystem('data')
69
171
  ----
70
172
 
173
+ === Models
174
+
175
+ ==== General
176
+
177
+ This library provides models for various W3C API resources under the
178
+ `W3cApi::Models` namespace.
179
+
180
+
181
+ ==== Affiliation
182
+
183
+ The `W3cApi::Models::Affiliation` represents a W3C affiliation model that
184
+ includes various attributes and methods to interact with affiliated entities.
185
+
186
+ .Fetching the affiliation index
187
+ [example]
188
+ ====
189
+ [source,ruby]
190
+ ----
191
+ > W3cApi::Hal.instance.register.fetch(:affiliation_index)
192
+ # =>
193
+ # #<W3cApi::Models::AffiliationIndex:0x0000000123ecca38
194
+ # @_global_register_id=:w3c_api,
195
+ # @limit=100,
196
+ # @links=
197
+ # #<W3cApi::Models::AffiliationIndexLinkSet:0x00000001325b4a68
198
+ # @_global_register_id=:w3c_api,
199
+ # @affiliations=
200
+ # [#<W3cApi::Models::AffiliationLink:0x000000011fe453c0
201
+ # @_global_register_id=:w3c_api,
202
+ # @deprecation=nil,
203
+ # @href="https://api.w3.org/affiliations/1001",
204
+ # @lang=nil,
205
+ # @name=nil,
206
+ # @profile=nil,
207
+ # @templated=nil,
208
+ # @title=
209
+ # "Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)",
210
+ # @type="Affiliation">,
211
+ # #<W3cApi::Models::AffiliationLink:0x000000011fe232c0
212
+ # @_global_register_id=:w3c_api,
213
+ # @deprecation=nil,
214
+ # @href="https://api.w3.org/affiliations/1003",
215
+ # @lang=nil,
216
+ # @name=nil,
217
+ # @profile=nil,
218
+ # @templated=nil,
219
+ # @title="BackWeb Technologies, Inc.",
220
+ # @type="Affiliation">,
221
+ # ...
222
+ ----
223
+ ====
224
+
225
+ .Fetching a specific affiliation
226
+ [example]
227
+ ====
228
+ [source,ruby]
229
+ ----
230
+ > W3cApi::Hal.instance.register.fetch(:affiliation_resource, id: 35662)
231
+ # =>
232
+ # #<W3cApi::Models::Affiliation:0x000000011de99d50
233
+ # @id=35662,
234
+ # @name="Google LLC",
235
+ # @discr="organization",
236
+ # ... >
237
+ ----
238
+ ====
239
+
240
+
241
+
71
242
  == Command line interface
72
243
 
73
244
  === General
@@ -76,6 +247,9 @@ W3C API provides a command-line interface (CLI) for various operations.
76
247
 
77
248
  The main executable is `w3c_api`.
78
249
 
250
+ By default, the output is in YAML format. You can specify the output format using the
251
+ `--format` option, which accepts `json` or `yaml`.
252
+
79
253
  [source,shell]
80
254
  ----
81
255
  Commands:
@@ -110,10 +284,6 @@ When fetching an index of specifications, for every specification, only the
110
284
  ----
111
285
  # Fetch specifications
112
286
  $ 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
287
  # Fetch specifications with a specific status
118
288
  $ w3c_api specification fetch --status=Recommendation
119
289
  ----
@@ -122,7 +292,7 @@ $ w3c_api specification fetch --status=Recommendation
122
292
  ====
123
293
  [source,shell]
124
294
  ----
125
- $ w3c_api specification fetch --format=yaml
295
+ $ w3c_api specification fetch
126
296
  - href: https://www.w3.org/TR/html5/
127
297
  title: HTML5
128
298
  - href: https://www.w3.org/TR/css3-color/
@@ -138,10 +308,6 @@ Getting a specification provides all attributes of the specification.
138
308
  ----
139
309
  # Fetch a specification
140
310
  $ 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
311
  # Fetch a specific version of a specification
146
312
  $ w3c_api specification fetch --shortname=webrtc --version=20241008
147
313
  ----
@@ -150,7 +316,7 @@ $ w3c_api specification fetch --shortname=webrtc --version=20241008
150
316
  ====
151
317
  [source,shell]
152
318
  ----
153
- $ w3c_api specification fetch --shortname=webrtc --format=yaml
319
+ $ w3c_api specification fetch --shortname=webrtc
154
320
  ---
155
321
  shortlink: https://www.w3.org/TR/webrtc/
156
322
  description: "<p>This document defines a set of ECMAScript APIs in WebIDL to allow
@@ -187,17 +353,13 @@ This command provides access to W3C specification versions given a shortname.
187
353
  ----
188
354
  # Fetch versions of a specification
189
355
  $ 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
356
  ----
195
357
 
196
358
  [example]
197
359
  ====
198
360
  [source,shell]
199
361
  ----
200
- $ w3c_api specification versions --shortname=webrtc --format=yaml
362
+ $ w3c_api specification versions --shortname=webrtc
201
363
  spec_versions:
202
364
  - title: 'WebRTC: Real-Time Communication in Browsers'
203
365
  href: https://api.w3.org/specifications/webrtc/versions/20241008
@@ -217,17 +379,13 @@ This command provides access to W3C specifications by status.
217
379
  ----
218
380
  # Fetch specifications with a specific status
219
381
  $ 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
382
  ----
225
383
 
226
384
  [example]
227
385
  ====
228
386
  [source,shell]
229
387
  ----
230
- $ w3c_api specification fetch --status=Recommendation --format=yaml
388
+ $ w3c_api specification fetch --status=Recommendation
231
389
  specifications:
232
390
  - title: 'XML Schema Part 1: Structures Second Edition'
233
391
  href: https://api.w3.org/specifications/xmlschema-1
@@ -239,6 +397,62 @@ specifications:
239
397
  ----
240
398
  ====
241
399
 
400
+ // === Specification version
401
+
402
+ // TODO: This is not yet implemented!
403
+
404
+ // ==== Editors
405
+
406
+ // TODO: This is not yet implemented!
407
+
408
+ // This command provides access to editors of a specification version.
409
+
410
+ // [source,shell]
411
+ // ----
412
+ // # Fetch editors of a specification version
413
+ // $ w3c_api specification-version editors --shortname=webrtc --version=20241008
414
+ // ----
415
+
416
+ // [example]
417
+ // ====
418
+ // [source,shell]
419
+ // ----
420
+ // $ w3c_api specification-version editors --shortname=webrtc --version=20241008
421
+ // ---
422
+ // users:
423
+ // - href: https://api.w3.org/users/p3dte6mpoj4sgw888w8kw4w4skwosck
424
+ // title: Cullen Jennings
425
+ // - href: https://api.w3.org/users/kjqsxbe6kioko4s88s4wocws848kgw8
426
+ // title: Bernard Aboba
427
+ // - href: https://api.w3.org/users/t9qq83owlzkck404w0o44so8owc00gg
428
+ // title: Jan-Ivar Bruaroey
429
+ // ----
430
+ // ====
431
+
432
+ // ==== Deliverers
433
+
434
+ // TODO: This is not yet implemented!
435
+
436
+ // This command provides access to deliverers (working groups) of a specification version.
437
+
438
+ // [source,shell]
439
+ // ----
440
+ // # Fetch deliverers of a specification version
441
+ // $ w3c_api specification-version deliverers --shortname=webrtc --version=20241008
442
+ // ----
443
+
444
+ // [example]
445
+ // ====
446
+ // [source,shell]
447
+ // ----
448
+ // $ w3c_api specification-version deliverers --shortname=webrtc --version=20241008
449
+ // ---
450
+ // groups:
451
+ // - href: https://api.w3.org/groups/wg/webrtc
452
+ // title: Web Real-Time Communications Working Group
453
+ // ----
454
+ // ====
455
+
242
456
  === Series
243
457
 
244
458
  This command provides access to W3C specification series.
@@ -251,17 +465,13 @@ Fetching an index of specification series.
251
465
  ----
252
466
  # Fetch specification series
253
467
  $ 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
468
  ----
259
469
 
260
470
  [example]
261
471
  ====
262
472
  [source,shell]
263
473
  ----
264
- $ w3c_api series fetch --format=yaml
474
+ $ w3c_api series fetch
265
475
  - shortname: html
266
476
  name: HTML
267
477
  - shortname: css
@@ -278,17 +488,13 @@ Getting a specification series by shortname.
278
488
  ----
279
489
  # Fetch a specification series
280
490
  $ 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
491
  ----
286
492
 
287
493
  [example]
288
494
  ====
289
495
  [source,shell]
290
496
  ----
291
- $ w3c_api series fetch --shortname=webrtc --format=yaml
497
+ $ w3c_api series fetch --shortname=webrtc
292
498
  ---
293
499
  shortname: webrtc
294
500
  name: 'WebRTC: Real-Time Communication Between Browsers'
@@ -310,17 +516,13 @@ This command provides access to specifications in a series.
310
516
  ----
311
517
  # Fetch specifications in a series
312
518
  $ 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
519
  ----
318
520
 
319
521
  [example]
320
522
  ====
321
523
  [source,shell]
322
524
  ----
323
- $ w3c_api series specifications --shortname=webrtc --format=yaml
525
+ $ w3c_api series specifications --shortname=webrtc
324
526
  ---
325
527
  specifications:
326
528
  - title: 'WebRTC: Real-Time Communication in Browsers'
@@ -345,20 +547,16 @@ Getting a user by ID.
345
547
  [source,shell]
346
548
  ----
347
549
  # Fetch a user with a numeric ID
348
- $ w3c_api user fetch --id=128112
550
+ $ w3c_api user fetch --hash=128112
349
551
  # 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
552
+ $ w3c_api user fetch --hash=f1ovb5rydm8s0go04oco0cgk0sow44w
355
553
  ----
356
554
 
357
555
  [example]
358
556
  ====
359
557
  [source,shell]
360
558
  ----
361
- $ w3c_api user fetch --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
559
+ $ w3c_api user fetch --hash=f1ovb5rydm8s0go04oco0cgk0sow44w
362
560
  ---
363
561
  id: 128112
364
562
  name: Jennifer Strickland
@@ -402,17 +600,13 @@ Getting groups a user is a member of.
402
600
  ----
403
601
  # Fetch groups a user is a member of
404
602
  $ 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
603
  ----
410
604
 
411
605
  [example]
412
606
  ====
413
607
  [source,shell]
414
608
  ----
415
- $ w3c_api user groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
609
+ $ w3c_api user groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
416
610
  ---
417
611
  groups:
418
612
  - href: https://api.w3.org/groups/wg/ag
@@ -458,17 +652,13 @@ Getting specifications a user has contributed to.
458
652
  ----
459
653
  # Fetch specifications a user has contributed to
460
654
  $ 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
655
  ----
466
656
 
467
657
  [example]
468
658
  ====
469
659
  [source,shell]
470
660
  ----
471
- $ w3c_api user specifications --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
661
+ $ w3c_api user specifications --id=f1ovb5rydm8s0go04oco0cgk0sow44w
472
662
  specifications:
473
663
  - title: HTML 5.2
474
664
  href: https://api.w3.org/specifications/html52
@@ -486,17 +676,13 @@ Getting affiliations of a user.
486
676
  ----
487
677
  # Fetch affiliations of a user
488
678
  $ 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
679
  ----
494
680
 
495
681
  [example]
496
682
  ====
497
683
  [source,shell]
498
684
  ----
499
- $ w3c_api user affiliations --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
685
+ $ w3c_api user affiliations --id=f1ovb5rydm8s0go04oco0cgk0sow44w
500
686
  ---
501
687
  affiliations:
502
688
  - href: https://api.w3.org/affiliations/1092
@@ -512,17 +698,13 @@ Getting participations of a user.
512
698
  ----
513
699
  # Fetch participations of a user
514
700
  $ 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
701
  ----
520
702
 
521
703
  [example]
522
704
  ====
523
705
  [source,shell]
524
706
  ----
525
- $ w3c_api user participations --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
707
+ $ w3c_api user participations --id=f1ovb5rydm8s0go04oco0cgk0sow44w
526
708
  ---
527
709
  participations:
528
710
  - title: Silver Community Group
@@ -568,17 +750,13 @@ Getting groups a user chairs.
568
750
  ----
569
751
  # Fetch groups a user chairs
570
752
  $ 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
753
  ----
576
754
 
577
755
  [example]
578
756
  ====
579
757
  [source,shell]
580
758
  ----
581
- $ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
759
+ $ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
582
760
  ---
583
761
  groups:
584
762
  - href: https://api.w3.org/groups/cg/equity
@@ -594,17 +772,13 @@ Getting groups a user is a team contact of.
594
772
  ----
595
773
  # Fetch groups a user is a team contact of
596
774
  $ 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
775
  ----
602
776
 
603
777
  [example]
604
778
  ====
605
779
  [source,shell]
606
780
  ----
607
- $ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w --format=yaml
781
+ $ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
608
782
  groups:
609
783
  - name: Web Platform Working Group
610
784
  href: https://api.w3.org/groups/72825
@@ -614,6 +788,7 @@ groups:
614
788
  ----
615
789
  ====
616
790
 
791
+
617
792
  === Groups
618
793
 
619
794
  This command provides access to W3C groups.
@@ -626,17 +801,13 @@ Fetching an index of groups.
626
801
  ----
627
802
  # Fetch groups
628
803
  $ 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
804
  ----
634
805
 
635
806
  [example]
636
807
  ====
637
808
  [source,shell]
638
809
  ----
639
- $ w3c_api group fetch --format=yaml
810
+ $ w3c_api group fetch
640
811
  ---
641
812
  groups:
642
813
  - href: https://api.w3.org/groups/tf/ab-liaisons-to-bod
@@ -659,10 +830,6 @@ Getting a group by ID.
659
830
  ----
660
831
  # Fetch a group
661
832
  $ 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
833
  ----
667
834
 
668
835
  [example]
@@ -686,580 +853,822 @@ _links:
686
853
  href: https://api.w3.org/groups/wg/immersive-web
687
854
  homepage:
688
855
  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
856
  ----
710
857
  ====
711
858
 
712
- ==== Users
859
+ ==== Chairs
713
860
 
714
- Getting users in a group.
861
+ Fetching chairs for a group.
715
862
 
716
863
  [source,shell]
717
864
  ----
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
865
+ # Fetch chairs for a group
866
+ $ w3c_api group chairs --id={id}
724
867
  ----
725
868
 
726
869
  [example]
727
870
  ====
728
- [source,sh]
871
+ [source,shell]
729
872
  ----
730
- $ w3c_api group users --id=109735 --format=yaml
873
+ $ w3c_api group chairs --id=109735
731
874
  ---
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
875
+ _links:
876
+ self:
877
+ href: https://api.w3.org/groups/109735/chairs?page=1&items=100
878
+ type: W3cApi::Models::ChairIndex
879
+ first:
880
+ href: https://api.w3.org/groups/109735/chairs?page=1&items=100
881
+ type: W3cApi::Models::ChairIndex
882
+ last:
883
+ href: https://api.w3.org/groups/109735/chairs?page=1&items=100
884
+ type: W3cApi::Models::ChairIndex
885
+ up:
886
+ href: https://api.w3.org/groups/109735
887
+ type: W3cApi::Models::ChairIndex
888
+ chairs:
889
+ - href: https://api.w3.org/users/basy63arxl448c8co0og8ocosocgc0w
890
+ title: Ada Rose Cannon
891
+ type: User
892
+ - href: https://api.w3.org/users/l88ca27n2b4sk00cogosk0skw4s8osc
893
+ title: Chris Wilson
894
+ type: User
895
+ - href: https://api.w3.org/users/m99jqkpi9m8oww84kw4gwccgc4g0ogs
896
+ title: Ayşegül Yönet
897
+ type: User
747
898
  ----
748
899
  ====
749
900
 
750
- ==== Specifications
901
+ ==== Team contacts
751
902
 
752
- Getting specifications of a group.
903
+ Fetching team contacts for a group.
753
904
 
754
905
  [source,shell]
755
906
  ----
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
907
+ # Fetch team contacts for a group
908
+ $ w3c_api group team-contacts --id={id}
762
909
  ----
763
910
 
764
911
  [example]
765
912
  ====
766
913
  [source,shell]
767
914
  ----
768
- $ w3c_api group specifications --id=109735 --format=yaml
915
+ $ w3c_api group team-contacts --id=109735
769
916
  ---
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
917
+ _links:
918
+ self:
919
+ href: https://api.w3.org/groups/109735/teamcontacts?page=1&items=100
920
+ type: W3cApi::Models::TeamContactIndex
921
+ first:
922
+ href: https://api.w3.org/groups/109735/teamcontacts?page=1&items=100
923
+ type: W3cApi::Models::TeamContactIndex
924
+ last:
925
+ href: https://api.w3.org/groups/109735/teamcontacts?page=1&items=100
926
+ type: W3cApi::Models::TeamContactIndex
927
+ up:
928
+ href: https://api.w3.org/groups/109735
929
+ type: W3cApi::Models::TeamContactIndex
930
+ team-contacts:
931
+ - href: https://api.w3.org/users/1eb2xr7ab6zo0k8440o48swso408ksc
932
+ title: Atsushi Shimono
933
+ type: User
780
934
  ----
781
935
  ====
782
936
 
783
- ==== Charters
937
+ ==== Participations
784
938
 
785
- Getting charters of a group.
939
+ Fetching participations for a group.
786
940
 
787
941
  [source,shell]
788
942
  ----
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
943
+ # Fetch participations for a group
944
+ $ w3c_api group participations --id={id}
795
945
  ----
796
946
 
797
947
  [example]
798
948
  ====
799
949
  [source,shell]
800
950
  ----
801
- $ w3c_api group charters --id=109735 --format=yaml
951
+ $ w3c_api group participations --id=109735
802
952
  ---
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
953
+ _links:
954
+ self:
955
+ href: https://api.w3.org/groups/109735/participations?page=1&items=100
956
+ type: ParticipationIndex
957
+ first:
958
+ href: https://api.w3.org/groups/109735/participations?page=1&items=100
959
+ type: ParticipationIndex
960
+ last:
961
+ href: https://api.w3.org/groups/109735/participations?page=1&items=100
962
+ type: ParticipationIndex
963
+ up:
964
+ href: https://api.w3.org/groups/109735
965
+ type: ParticipationIndex
966
+ participations:
967
+ - href: https://api.w3.org/participations/43367
968
+ title: Kodansha, Publishers, Ltd.
969
+ type: Participation
970
+ - href: https://api.w3.org/participations/43368
971
+ title: Institut National de Recherche en Informatique et en Automatique (Inria)
972
+ type: Participation
973
+ - href: https://api.w3.org/participations/43391
974
+ title: Igalia
975
+ type: Participation
976
+ - href: https://api.w3.org/participations/43415
977
+ title: Christine Perey
978
+ type: Participation
812
979
  ----
813
980
  ====
814
981
 
815
- ==== Chairs
816
982
 
817
- Getting chairs of a group.
983
+ ==== Specifications
984
+
985
+ Fetching specifications for a group.
818
986
 
819
987
  [source,shell]
820
988
  ----
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
989
+ # Fetch specifications for a group
990
+ $ w3c_api group specifications --id=109735
827
991
  ----
828
992
 
829
993
  [example]
830
994
  ====
831
995
  [source,shell]
832
996
  ----
833
- $ w3c_api group chairs --id=109735 --format=yaml
997
+ $ w3c_api group specifications --id=109735
834
998
  ---
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
999
+ specifications:
1000
+ - href: https://api.w3.org/specifications/webxr-lighting-estimation-1
1001
+ title: WebXR Lighting Estimation API Level 1
1002
+ type: Specification
1003
+ - href: https://api.w3.org/specifications/webxr-ar-module-1
1004
+ title: WebXR Augmented Reality Module - Level 1
1005
+ type: Specification
1006
+ - href: https://api.w3.org/specifications/webxr-gamepads-module-1
1007
+ title: WebXR Gamepads Module - Level 1
1008
+ type: Specification
1009
+ - href: https://api.w3.org/specifications/webxrlayers-1
1010
+ title: WebXR Layers API Level 1
1011
+ type: Specification
1012
+ - href: https://api.w3.org/specifications/webxr-hand-input-1
1013
+ title: WebXR Hand Input Module - Level 1
1014
+ type: Specification
1015
+ - href: https://api.w3.org/specifications/webxr-hit-test-1
1016
+ title: WebXR Hit Test Module
1017
+ type: Specification
1018
+ - href: https://api.w3.org/specifications/webxr-depth-sensing-1
1019
+ title: WebXR Depth Sensing Module
1020
+ type: Specification
1021
+ - href: https://api.w3.org/specifications/webxr-dom-overlays-1
1022
+ title: WebXR DOM Overlays Module
1023
+ type: Specification
1024
+ - href: https://api.w3.org/specifications/webxr
1025
+ title: WebXR Device API
1026
+ type: Specification
842
1027
  ----
843
1028
  ====
844
1029
 
1030
+ ==== Users
845
1031
 
846
- ==== Team Contacts
1032
+ Fetching users for a group.
847
1033
 
848
- Getting team contacts of a group.
1034
+ [source,shell]
1035
+ ----
1036
+ # Fetch users for a group
1037
+ $ w3c_api group users --id=109735
1038
+ ----
849
1039
 
1040
+ [example]
1041
+ ====
850
1042
  [source,shell]
851
1043
  ----
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
1044
+ $ w3c_api group users --id=109735
1045
+ ---
1046
+ users:
1047
+ - href: https://api.w3.org/users/9o1jsmhi8ysk088w0k4g00wsssk4c8c
1048
+ title: Muadh Al Kalbani
1049
+ type: User
1050
+ - href: https://api.w3.org/users/rqjspzlmiq8c0kk8goos4c480w8wccs
1051
+ title: Matthew Atkinson
1052
+ type: User
1053
+ - href: https://api.w3.org/users/32hnccz98a68sk0kcog8c4wo4sgckkw
1054
+ title: Ashwin Balasubramaniyan
1055
+ type: User
1056
+ - href: https://api.w3.org/users/ff80kfl6a0gso4oo8s40cg4c4wccgs0
1057
+ title: Trevor Baron
1058
+ type: User
1059
+ ----
1060
+ ====
1061
+
1062
+ ==== Charters
1063
+
1064
+ Fetching charters for a group.
1065
+
1066
+ [source,shell]
1067
+ ----
1068
+ # Fetch charters for a group
1069
+ $ w3c_api group charters --id=109735
858
1070
  ----
859
1071
 
860
1072
  [example]
861
1073
  ====
862
1074
  [source,shell]
863
1075
  ----
864
- $ w3c_api group team_contacts --id=109735 --format=yaml
1076
+ $ w3c_api group charters --id=109735
865
1077
  ---
866
- users:
867
- - href: https://api.w3.org/users/1eb2xr7ab6zo0k8440o48swso408ksc
868
- title: Atsushi Shimono
1078
+ charters:
1079
+ - href: https://api.w3.org/groups/109735/charters/361
1080
+ title: 2018-09-24 -> 2020-03-01
1081
+ type: Charter
1082
+ - href: https://api.w3.org/groups/109735/charters/405
1083
+ title: 2020-05-12 -> 2022-06-01
1084
+ type: Charter
1085
+ - href: https://api.w3.org/groups/109735/charters/464
1086
+ title: 2022-07-08 -> 2024-07-07
1087
+ type: Charter
1088
+ - href: https://api.w3.org/groups/109735/charters/514
1089
+ title: 2024-09-26 -> 2026-09-25
1090
+ type: Charter
869
1091
  ----
870
1092
  ====
871
1093
 
872
- === Affiliations
1094
+ === Translation
873
1095
 
874
- This command provides access to W3C affiliations (organizations).
1096
+ This command provides access to W3C translations.
875
1097
 
876
1098
  ==== Index
877
1099
 
878
- Fetching an index of affiliations.
1100
+ Fetching an index of translations.
879
1101
 
880
1102
  [source,shell]
881
1103
  ----
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
1104
+ # Fetch translations
1105
+ $ w3c_api translation fetch [OPTIONS]
888
1106
  ----
889
-
890
1107
  [example]
891
1108
  ====
892
1109
  [source,shell]
893
1110
  ----
894
- $ w3c_api affiliation fetch --format=yaml
1111
+ $ w3c_api translation fetch
895
1112
  ---
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
1113
+ "translations": [
1114
+ {
1115
+ "href": "https://api.w3.org/translations/2",
1116
+ "title": "Vidéo : introduction à l’accessibilité web et aux standards du W3C",
1117
+ "language": "fr"
1118
+ },
1119
+ {
1120
+ "href": "https://api.w3.org/translations/3",
1121
+ "title": "Vídeo de Introducción a la Accesibilidad Web y Estándares del W3C",
1122
+ "language": "es"
1123
+ },
1124
+ {
1125
+ "href": "https://api.w3.org/translations/4",
1126
+ "title": "Video-introductie over Web-toegankelijkheid en W3C-standaarden",
1127
+ "language": "nl"
1128
+ },
1129
+ {
1130
+ "href": "https://api.w3.org/translations/5",
1131
+ "title": "网页无障碍和W3C标准的介绍视频",
1132
+ "language": "zh_Hans"
1133
+ },...
910
1134
  ----
911
1135
  ====
912
1136
 
913
1137
  ==== Get
914
1138
 
915
- Getting an affiliation by ID.
1139
+ Getting a translation by ID.
916
1140
 
917
1141
  [source,shell]
918
1142
  ----
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
1143
+ # Fetch a translation
1144
+ $ w3c_api translation fetch --id=467
925
1145
  ----
926
1146
 
927
1147
  [example]
928
1148
  ====
929
1149
  [source,shell]
930
1150
  ----
931
- $ w3c_api affiliation fetch --id=35662 --format=yaml
1151
+ $ w3c_api translation fetch --id=467
932
1152
  ---
933
- affiliations:
934
- - id: 35662
935
- name: Google LLC
936
- is_member: true
937
- is_member_association: false
938
- is_partner_member: false
1153
+ _links:
1154
+ self:
1155
+ href: https://api.w3.org/translations/467
1156
+ type: Translation
1157
+ uri: http://maujor.com/w3c/xml-base.html
1158
+ title: XML Base
1159
+ language: pt_BR
1160
+ published: '2005-09-23T00:00:00+00:00'
1161
+ authorized: false
1162
+ call-for-translation:
939
1163
  _links:
940
1164
  self:
941
- href: https://api.w3.org/affiliations/35662
942
- participants:
943
- href: https://api.w3.org/affiliations/35662/participants
1165
+ href: https://api.w3.org/callsfortranslation/28
1166
+ type: CallForTranslation
1167
+ translations:
1168
+ href: https://api.w3.org/callsfortranslation/28/translations
1169
+ type: TranslationIndex
1170
+ title: XML Base
1171
+ states:
1172
+ - published
1173
+ translators:
1174
+ - _links:
1175
+ self:
1176
+ href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48
1177
+ type: User
1178
+ affiliations:
1179
+ href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/affiliations
1180
+ type: W3cApi::Models::AffiliationIndex
1181
+ groups:
1182
+ href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/groups
1183
+ type: GroupIndex
1184
+ specifications:
1185
+ href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/specifications
1186
+ type: SpecificationIndex
944
1187
  participations:
945
- href: https://api.w3.org/affiliations/35662/participations
1188
+ href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/participations
1189
+ type: ParticipationIndex
1190
+ id: '112282'
1191
+ name: Maurício Samy Silva
1192
+ given: Maurício
1193
+ family: Samy Silva
1194
+ discr: user
946
1195
  ----
947
1196
  ====
948
1197
 
949
- ==== Participants
950
1198
 
951
- Getting participants of an affiliation.
1199
+ === Ecosystem
1200
+
1201
+ This command provides access to W3C ecosystems.
1202
+
1203
+ ==== Index
1204
+
1205
+ Fetching an index of ecosystems.
1206
+ [source,shell]
1207
+ ----
1208
+ # Fetch ecosystems
1209
+ $ w3c_api ecosystem fetch [OPTIONS]
1210
+ ----
1211
+ [example]
1212
+ ====
1213
+ [source,shell]
1214
+ ----
1215
+ $ w3c_api ecosystem fetch
1216
+ ---
1217
+ _links:
1218
+ self:
1219
+ href: https://api.w3.org/ecosystems?embed=0&page=1&items=100
1220
+ type: W3cApi::Models::EcosystemIndex
1221
+ first:
1222
+ href: https://api.w3.org/ecosystems?embed=0&page=1&items=100
1223
+ type: W3cApi::Models::EcosystemIndex
1224
+ last:
1225
+ href: https://api.w3.org/ecosystems?embed=0&page=1&items=100
1226
+ type: W3cApi::Models::EcosystemIndex
1227
+ ecosystems:
1228
+ - href: https://api.w3.org/ecosystems/advertising
1229
+ title: Web Advertising
1230
+ type: Ecosystem
1231
+ - href: https://api.w3.org/ecosystems/e-commerce
1232
+ title: E-commerce
1233
+ type: Ecosystem
1234
+ - href: https://api.w3.org/ecosystems/media
1235
+ title: Media & Entertainment
1236
+ type: Ecosystem
1237
+ - href: https://api.w3.org/ecosystems/network-communications
1238
+ title: Network & Communications
1239
+ type: Ecosystem
1240
+ - href: https://api.w3.org/ecosystems/publishing
1241
+ title: Publishing
1242
+ type: Ecosystem
1243
+ - href: https://api.w3.org/ecosystems/smart-cities
1244
+ title: Smart Cities
1245
+ type: Ecosystem
1246
+ - href: https://api.w3.org/ecosystems/automotive-transportation
1247
+ title: Automotive & Transportation
1248
+ type: Ecosystem
1249
+ - href: https://api.w3.org/ecosystems/web-of-things
1250
+ title: Web of Things
1251
+ type: Ecosystem
1252
+ - href: https://api.w3.org/ecosystems/data
1253
+ title: Data and knowledge
1254
+ type: Ecosystem
1255
+ ----
1256
+ ====
1257
+
1258
+ ==== Get
1259
+
1260
+ Getting an ecosystem by shortname.
952
1261
 
953
1262
  [source,shell]
954
1263
  ----
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
1264
+ # Fetch an ecosystem
1265
+ $ w3c_api ecosystem fetch --shortname={shortname}
961
1266
  ----
962
1267
 
963
1268
  [example]
964
1269
  ====
965
1270
  [source,shell]
966
1271
  ----
967
- $ w3c_api affiliation participants --id=35662 --format=yaml
1272
+ $ w3c_api ecosystem fetch --shortname=data
968
1273
  ---
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
1274
+ _links:
1275
+ self:
1276
+ href: https://api.w3.org/ecosystems/data
1277
+ type: Ecosystem
1278
+ champion:
1279
+ href: https://api.w3.org/users/t891ludoisggsccsw44o8goccc0s0ks
1280
+ title: Pierre-Antoine Champin
1281
+ type: User
1282
+ evangelists:
1283
+ href: https://api.w3.org/ecosystems/data/evangelists
1284
+ type: EvangelistIndex
1285
+ groups:
1286
+ href: https://api.w3.org/ecosystems/data/groups
1287
+ type: GroupIndex
1288
+ member-organizations:
1289
+ href: https://api.w3.org/ecosystems/data/member-organizations
1290
+ type: AffiliationIndex
1291
+ name: Data and knowledge
1292
+ shortname: data
981
1293
  ----
982
1294
  ====
983
1295
 
984
- ==== Participations
1296
+ ==== Evangelists
1297
+
1298
+ Getting evangelists for an ecosystem.
1299
+
1300
+ [source,shell]
1301
+ ----
1302
+ # Fetch evangelists for an ecosystem
1303
+ $ w3c_api ecosystem evangelists --shortname={shortname}
1304
+ ----
1305
+ [example]
1306
+ ====
1307
+ [source,shell]
1308
+ ----
1309
+ $ w3c_api ecosystem evangelists --shortname=publishing
1310
+ ---
1311
+ _links:
1312
+ self:
1313
+ href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
1314
+ type: EvangelistIndex
1315
+ first:
1316
+ href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
1317
+ type: EvangelistIndex
1318
+ last:
1319
+ href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
1320
+ type: EvangelistIndex
1321
+ up:
1322
+ href: https://api.w3.org/ecosystems/publishing
1323
+ type: EvangelistIndex
1324
+ evangelists:
1325
+ - href: https://api.w3.org/users/ni26g4n5gqskg8k80ssgw0ko048wgwg
1326
+ title: Bill Kasdorf
1327
+ type: User
1328
+ - href: https://api.w3.org/users/a5eur9p2iyo0ws00448w4gcw4c8sock
1329
+ title: Daihei Shiohama
1330
+ type: User
1331
+ - href: https://api.w3.org/users/qdkk81rtp344c44g0osoocgwwc8o4ss
1332
+ title: Bobby Tung
1333
+ type: User
1334
+ ----
1335
+ ====
1336
+
1337
+ ==== Groups
985
1338
 
986
- Getting participations of an affiliation.
1339
+ Getting groups for an ecosystem.
987
1340
 
988
1341
  [source,shell]
989
1342
  ----
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
1343
+ # Fetch groups for an ecosystem
1344
+ $ w3c_api ecosystem groups --shortname={shortname}
996
1345
  ----
997
1346
 
998
1347
  [example]
999
1348
  ====
1000
1349
  [source,shell]
1001
1350
  ----
1002
- $ w3c_api affiliation participations --id=35662 --format=yaml
1351
+ $ w3c_api ecosystem groups --shortname=publishing
1003
1352
  ---
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
1353
+ ---
1354
+ _links:
1355
+ self:
1356
+ href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
1357
+ type: GroupIndex
1358
+ first:
1359
+ href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
1360
+ type: GroupIndex
1361
+ last:
1362
+ href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
1363
+ type: GroupIndex
1364
+ up:
1365
+ href: https://api.w3.org/ecosystems/publishing
1366
+ type: GroupIndex
1367
+ groups:
1368
+ - href: https://api.w3.org/groups/cg/a11y-discov-vocab
1369
+ title: Accessibility Discoverability Vocabulary for Schema.org Community Group
1370
+ type: Group
1371
+ - href: https://api.w3.org/groups/cg/epub3
1372
+ title: EPUB 3 Community Group
1373
+ type: Group
1374
+ - href: https://api.w3.org/groups/bg/publishingbg
1375
+ title: Publishing Business Group
1376
+ type: Group
1377
+ - href: https://api.w3.org/groups/cg/publishingcg
1378
+ title: Publishing Community Group
1379
+ type: Group
1380
+ - href: https://api.w3.org/groups/wg/pm
1381
+ title: Publishing Maintenance Working Group
1382
+ type: Group
1013
1383
  ----
1014
1384
  ====
1015
1385
 
1016
- === Ecosystems
1386
+ ==== Member organizations
1017
1387
 
1018
- This command provides access to W3C ecosystems.
1388
+ Getting member organizations for an ecosystem.
1389
+
1390
+ [source,shell]
1391
+ ----
1392
+ # Fetch member organizations for an ecosystem
1393
+ $ w3c_api ecosystem member-organizations --shortname={shortname}
1394
+ ----
1395
+
1396
+ [example]
1397
+ ====
1398
+ [source,shell]
1399
+ ----
1400
+ $ w3c_api ecosystem member-organizations --shortname=publishing
1401
+ ---
1402
+ _links:
1403
+ self:
1404
+ href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
1405
+ type: W3cApi::Models::AffiliationIndex
1406
+ first:
1407
+ href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
1408
+ type: W3cApi::Models::AffiliationIndex
1409
+ last:
1410
+ href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
1411
+ type: W3cApi::Models::AffiliationIndex
1412
+ up:
1413
+ href: https://api.w3.org/ecosystems/publishing
1414
+ type: W3cApi::Models::AffiliationIndex
1415
+ affiliations:
1416
+ - href: https://api.w3.org/affiliations/56103
1417
+ title: ACCESS CO., LTD.
1418
+ type: Affiliation
1419
+ - href: https://api.w3.org/affiliations/1057
1420
+ title: Adobe
1421
+ type: Affiliation
1422
+ - href: https://api.w3.org/affiliations/108617
1423
+ title: Amazon
1424
+ type: Affiliation
1425
+ - href: https://api.w3.org/affiliations/43420
1426
+ title: Apache Software Foundation
1427
+ type: Affiliation
1428
+ ...
1429
+ ----
1430
+ ====
1431
+
1432
+ === Affiliations
1019
1433
 
1020
1434
  ==== Index
1021
1435
 
1022
- Fetching an index of ecosystems.
1436
+ Fetching an index of affiliations.
1023
1437
 
1024
1438
  [source,shell]
1025
1439
  ----
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
1440
+ # Fetch affiliations
1441
+ $ w3c_api affiliation fetch [OPTIONS]
1032
1442
  ----
1033
1443
 
1034
1444
  [example]
1035
1445
  ====
1036
1446
  [source,shell]
1037
1447
  ----
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
1448
+ $ w3c_api affiliation fetch
1059
1449
  ----
1060
1450
  ====
1061
1451
 
1062
1452
  ==== Get
1063
1453
 
1064
- Getting an ecosystem by shortname.
1454
+ Getting an affiliation by ID.
1065
1455
 
1066
1456
  [source,shell]
1067
1457
  ----
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
1458
+ # Fetch an affiliation
1459
+ $ w3c_api affiliation fetch --id={id}
1074
1460
  ----
1075
1461
 
1076
1462
  [example]
1077
1463
  ====
1078
1464
  [source,shell]
1079
1465
  ----
1080
- $ w3c_api ecosystem fetch --shortname=data --format=yaml
1466
+ # Fetch an affiliation
1467
+ $ w3c_api affiliation fetch --id=1001
1081
1468
  ---
1082
- name: Data and knowledge
1083
- shortname: data
1084
1469
  _links:
1085
1470
  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
1471
+ href: https://api.w3.org/affiliations/1001
1472
+ type: Affiliation
1473
+ homepage:
1474
+ href: http://www.framkom.se
1475
+ type: String
1476
+ participants:
1477
+ href: https://api.w3.org/affiliations/1001/participants
1478
+ type: Participant
1479
+ participations:
1480
+ href: https://api.w3.org/affiliations/1001/participations
1481
+ type: Participation
1482
+ id: 1001
1483
+ name: Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)
1484
+ discr: organization
1485
+ is-member: false
1486
+ is-member-association: false
1487
+ is-partner-member: false
1096
1488
  ----
1097
1489
  ====
1098
1490
 
1099
- ==== Groups
1491
+ ==== Participants
1100
1492
 
1101
- Getting groups in an ecosystem.
1493
+ Getting participants for an affiliation.
1102
1494
 
1103
1495
  [source,shell]
1104
1496
  ----
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
1497
+ # Fetch participants for an affiliation
1498
+ $ w3c_api affiliation participants --id={id}
1111
1499
  ----
1112
1500
 
1113
1501
  [example]
1114
1502
  ====
1115
1503
  [source,shell]
1116
1504
  ----
1117
- $ w3c_api ecosystem groups --shortname=data --format=yaml
1505
+ $ w3c_api affiliation participants --id=1104
1118
1506
  ---
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
1507
+ _links:
1508
+ self:
1509
+ href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
1510
+ type: W3cApi::Models::ParticipantIndex
1511
+ first:
1512
+ href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
1513
+ type: W3cApi::Models::ParticipantIndex
1514
+ last:
1515
+ href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
1516
+ type: W3cApi::Models::ParticipantIndex
1517
+ up:
1518
+ href: https://api.w3.org/affiliations/1104
1519
+ type: W3cApi::Models::ParticipantIndex
1520
+ participants:
1521
+ - href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
1522
+ title: Jean-Luc Chevillard
1523
+ type: User
1129
1524
  ----
1130
1525
  ====
1131
1526
 
1132
- === Translations
1133
-
1134
- This command provides access to W3C translations.
1135
1527
 
1136
- ==== Index
1528
+ ==== Participations
1137
1529
 
1138
- Fetching an index of translations.
1530
+ Getting participations for an affiliation.
1139
1531
 
1140
1532
  [source,shell]
1141
1533
  ----
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
1534
+ # Fetch participations for an affiliation
1535
+ $ w3c_api affiliation participations --id={id}
1148
1536
  ----
1149
1537
 
1150
1538
  [example]
1151
1539
  ====
1152
1540
  [source,shell]
1153
1541
  ----
1154
- $ w3c_api translation fetch --format=yaml
1542
+ $ w3c_api affiliation participations --id=1104
1155
1543
  ---
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
1544
+ _links:
1545
+ self:
1546
+ href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
1547
+ type: ParticipationIndex
1548
+ first:
1549
+ href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
1550
+ type: ParticipationIndex
1551
+ last:
1552
+ href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
1553
+ type: ParticipationIndex
1554
+ up:
1555
+ href: https://api.w3.org/affiliations/1104
1556
+ type: ParticipationIndex
1557
+ participations:
1558
+ - href: https://api.w3.org/participations/32932
1559
+ title: XQuery and XSLT Extensions Community Group
1560
+ type: Participation
1170
1561
  ----
1171
1562
  ====
1172
1563
 
1564
+ === Participations
1565
+
1173
1566
  ==== Get
1174
1567
 
1175
- Getting a translation by ID.
1568
+ Getting a participation by ID.
1176
1569
 
1177
1570
  [source,shell]
1178
1571
  ----
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
1572
+ # Fetch a participation
1573
+ $ w3c_api participation fetch --id={id}
1185
1574
  ----
1186
1575
 
1187
1576
  [example]
1188
1577
  ====
1189
1578
  [source,shell]
1190
1579
  ----
1191
- $ w3c_api translation fetch --id=2 --format=yaml
1580
+ $ w3c_api participation fetch --id=32932
1192
1581
  ---
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
1582
  _links:
1229
1583
  self:
1230
- href: https://api.w3.org/translations/2
1584
+ href: https://api.w3.org/participations/32932
1585
+ type: Participation
1586
+ group:
1587
+ href: https://api.w3.org/groups/cg/xslt-40
1588
+ title: XQuery and XSLT Extensions Community Group
1589
+ type: Group
1590
+ organization:
1591
+ href: https://api.w3.org/affiliations/1104
1592
+ title: CNRS
1593
+ type: Affiliation
1594
+ participants:
1595
+ href: https://api.w3.org/participations/32932/participants
1596
+ type: W3cApi::Models::ParticipantIndex
1597
+ individual: false
1598
+ invited-expert: false
1599
+ created: '2020-11-28T05:59:24+00:00'
1231
1600
  ----
1232
1601
  ====
1233
1602
 
1234
- === Troubleshooting
1235
-
1236
- This section covers common issues and their solutions.
1603
+ ==== Participants
1237
1604
 
1238
- ==== Empty Responses from Endpoints
1605
+ Getting participants for a participation.
1239
1606
 
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.
1607
+ [source,shell]
1608
+ ----
1609
+ # Fetch participants for a participation
1610
+ $ w3c_api participation participants --id={id}
1611
+ ----
1241
1612
 
1242
1613
  [example]
1243
1614
  ====
1244
- If a user has no specifications, the command will still complete successfully but return an empty collection:
1245
-
1246
1615
  [source,shell]
1247
1616
  ----
1248
- $ w3c_api user specifications --id=128112 --format=yaml
1249
- specifications: []
1617
+ $ w3c_api participation participants --id=32932
1618
+ ---
1619
+ _links:
1620
+ self:
1621
+ href: https://api.w3.org/participations/32932/participants?page=1&items=100
1622
+ type: W3cApi::Models::ParticipantIndex
1623
+ first:
1624
+ href: https://api.w3.org/participations/32932/participants?page=1&items=100
1625
+ type: W3cApi::Models::ParticipantIndex
1626
+ last:
1627
+ href: https://api.w3.org/participations/32932/participants?page=1&items=100
1628
+ type: W3cApi::Models::ParticipantIndex
1629
+ up:
1630
+ href: https://api.w3.org/participations/32932
1631
+ type: W3cApi::Models::ParticipantIndex
1632
+ participants:
1633
+ - href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
1634
+ title: Jean-Luc Chevillard
1635
+ type: User
1250
1636
  ----
1251
1637
  ====
1252
1638
 
1253
- ==== User ID Format Considerations
1254
1639
 
1255
- The W3C API uses two different ID formats for users:
1640
+ == Debug mode
1641
+
1642
+ The library supports a debug mode that can be enabled by setting the `DEBUG_API`
1643
+ environment variable to a non-empty value.
1644
+
1645
+ This will print the HTTP requests and responses made by the API client.
1646
+
1647
+ .Enabling debug mode on the command line
1648
+ [example]
1649
+ ====
1650
+ [source,sh]
1651
+ ----
1652
+ # Enable debug mode
1653
+ $ export DEBUG_API=1
1654
+ $ w3c_api specification fetch --shortname=webrtc
1655
+ ----
1656
+ ====
1256
1657
 
1257
- 1. Numeric IDs (e.g., `128112`)
1258
- 2. String IDs (e.g., `f1ovb5rydm8s0go04oco0cgk0sow44w`)
1658
+ .Enabling debug mode in Ruby
1659
+ [example]
1660
+ ====
1661
+ [source,ruby]
1662
+ ----
1663
+ ENV["DEBUG_API"] = "1"
1664
+ W3cApi::Hal.instance.register.fetch(:specification_index)
1665
+ ----
1666
+ ====
1259
1667
 
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
1668
 
1669
+ == License and Copyright
1262
1670
 
1263
- == Copyright and License
1671
+ This project is licensed under the BSD 2-clause License.
1672
+ See the link:LICENSE.md[] file for details.
1264
1673
 
1265
1674
  Copyright Ribose.