w3c_api 0.1.2 → 0.1.4
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 +4 -4
- data/.rubocop_todo.yml +24 -8
- data/README.adoc +334 -970
- data/demo/test_embed_functionality.rb +87 -0
- data/lib/w3c_api/cli.rb +4 -0
- data/lib/w3c_api/client.rb +46 -5
- data/lib/w3c_api/commands/specification_version.rb +38 -0
- data/lib/w3c_api/embed.rb +40 -0
- data/lib/w3c_api/hal.rb +422 -196
- data/lib/w3c_api/models/affiliation.rb +12 -0
- data/lib/w3c_api/models/affiliation_index.rb +1 -0
- data/lib/w3c_api/models/deliverer_index.rb +12 -0
- data/lib/w3c_api/models/editor_index.rb +12 -0
- data/lib/w3c_api/models/group.rb +25 -1
- data/lib/w3c_api/models/groups.rb +32 -0
- data/lib/w3c_api/models/serie.rb +12 -0
- data/lib/w3c_api/models/spec_version.rb +4 -4
- data/lib/w3c_api/models/spec_version_index.rb +0 -3
- data/lib/w3c_api/models/spec_version_predecessor_index.rb +11 -0
- data/lib/w3c_api/models/spec_version_successor_index.rb +11 -0
- data/lib/w3c_api/models/specification.rb +7 -0
- data/lib/w3c_api/models/user.rb +12 -0
- data/lib/w3c_api/models.rb +41 -33
- data/lib/w3c_api/version.rb +1 -1
- data/lib/w3c_api.rb +1 -0
- metadata +12 -19
- data/lib/w3c_api/models/group_link_set.rb +0 -24
data/README.adoc
CHANGED
@@ -28,10 +28,9 @@ This gem is developed against the W3C API documented at https://api.w3.org/doc.
|
|
28
28
|
This is an example demonstrating the power of this library as inherited
|
29
29
|
from `lutaml-hal`, showing multiple levels of automatic link resolution.
|
30
30
|
|
31
|
+
.Calling the Ruby API with multiple levels of link resolution
|
31
32
|
[example]
|
32
33
|
====
|
33
|
-
.Calling the Ruby API with multiple levels of link resolution
|
34
|
-
|
35
34
|
[source,ruby]
|
36
35
|
----
|
37
36
|
> require 'w3c_api'
|
@@ -64,38 +63,7 @@ from `lutaml-hal`, showing multiple levels of automatic link resolution.
|
|
64
63
|
# @templated=nil,
|
65
64
|
# @title=nil,
|
66
65
|
# @type="EvangelistIndex">,
|
67
|
-
#
|
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">>,
|
66
|
+
# ...>,
|
99
67
|
# @page=1,
|
100
68
|
# @pages=1,
|
101
69
|
# @total=1>
|
@@ -104,6 +72,108 @@ from `lutaml-hal`, showing multiple levels of automatic link resolution.
|
|
104
72
|
|
105
73
|
== Ruby API
|
106
74
|
|
75
|
+
=== Embed support with auto-realize
|
76
|
+
|
77
|
+
==== General
|
78
|
+
|
79
|
+
The W3C API supports embedded content to reduce the number of HTTP requests
|
80
|
+
needed to fetch related resources. This gem provides comprehensive embed
|
81
|
+
support with automatic link realization for optimal performance.
|
82
|
+
|
83
|
+
[source,ruby]
|
84
|
+
----
|
85
|
+
require 'w3c_api'
|
86
|
+
|
87
|
+
# Create a client and use embed parameter directly
|
88
|
+
client = W3cApi::Client.new
|
89
|
+
|
90
|
+
# Fetch specifications with embedded content
|
91
|
+
specs = client.specifications(embed: true, items: 5)
|
92
|
+
|
93
|
+
# Fetch groups with embedded content
|
94
|
+
groups = client.groups(embed: true, items: 5)
|
95
|
+
|
96
|
+
# Fetch series with embedded content
|
97
|
+
series = client.series(embed: true, items: 5)
|
98
|
+
|
99
|
+
# Discover which endpoints support embed
|
100
|
+
supported_endpoints = W3cApi::Client.embed_supported_endpoints
|
101
|
+
# => [:group_index, :serie_index, :specification_index]
|
102
|
+
|
103
|
+
# Check if specific endpoint supports embed
|
104
|
+
client.embed_supported?(:specification_index) # => true
|
105
|
+
----
|
106
|
+
|
107
|
+
==== Auto-realize functionality
|
108
|
+
|
109
|
+
The gem features automatic embedded content detection that eliminates the need
|
110
|
+
to manually pass `parent_resource` parameters. Links automatically detect and
|
111
|
+
use embedded content when available, falling back to HTTP requests when needed.
|
112
|
+
|
113
|
+
[source,ruby]
|
114
|
+
----
|
115
|
+
# Fetch specifications with embed enabled
|
116
|
+
specs = client.specifications(embed: true, items: 5)
|
117
|
+
|
118
|
+
# Links automatically use embedded content - no parent_resource needed!
|
119
|
+
specs.links.specifications.each do |spec_link|
|
120
|
+
# This uses embedded data automatically - no HTTP request needed!
|
121
|
+
spec = spec_link.realize
|
122
|
+
puts "#{spec.title} - #{spec.shortname}"
|
123
|
+
end
|
124
|
+
|
125
|
+
# The auto-realize functionality works by:
|
126
|
+
# 1. Links store references to their parent resources automatically
|
127
|
+
# 2. Before making HTTP requests, links check for embedded data
|
128
|
+
# 3. If embedded content is available, it's used directly
|
129
|
+
# 4. If no embedded content exists, normal HTTP requests are made
|
130
|
+
----
|
131
|
+
|
132
|
+
==== Performance comparison
|
133
|
+
|
134
|
+
Using embed with auto-realize provides significant performance improvements:
|
135
|
+
|
136
|
+
[source,ruby]
|
137
|
+
----
|
138
|
+
# Without embed: 1 request for index + N requests for each specification
|
139
|
+
specs = client.specifications(items: 5)
|
140
|
+
specs.links.specifications.each do |spec_link|
|
141
|
+
spec = spec_link.realize # Each call makes an HTTP request
|
142
|
+
puts spec.title
|
143
|
+
end
|
144
|
+
# Total: 6 HTTP requests (1 + 5)
|
145
|
+
|
146
|
+
# With embed: 1 request total, embedded data used automatically
|
147
|
+
specs = client.specifications(embed: true, items: 5)
|
148
|
+
specs.links.specifications.each do |spec_link|
|
149
|
+
spec = spec_link.realize # Uses embedded data automatically!
|
150
|
+
puts spec.title
|
151
|
+
end
|
152
|
+
# Total: 1 HTTP request only
|
153
|
+
----
|
154
|
+
|
155
|
+
==== Embed discovery
|
156
|
+
|
157
|
+
The gem provides methods to discover embed capabilities:
|
158
|
+
|
159
|
+
[source,ruby]
|
160
|
+
----
|
161
|
+
# Get list of endpoints that support embed
|
162
|
+
W3cApi::Client.embed_supported_endpoints
|
163
|
+
# => [:group_index, :serie_index, :specification_index]
|
164
|
+
|
165
|
+
# Check if specific endpoint supports embed
|
166
|
+
client.embed_supported?(:specification_index) # => true
|
167
|
+
client.embed_supported?(:specification_resource) # => false
|
168
|
+
|
169
|
+
# Get comprehensive embed information
|
170
|
+
embed_info = W3cApi::Embed.embed_info
|
171
|
+
puts embed_info[:supported_endpoints]
|
172
|
+
puts embed_info[:descriptions]
|
173
|
+
puts embed_info[:usage_example]
|
174
|
+
----
|
175
|
+
|
176
|
+
|
107
177
|
=== General
|
108
178
|
|
109
179
|
[source,ruby]
|
@@ -125,11 +195,40 @@ specs_by_status = client.specifications_by_status('Recommendation')
|
|
125
195
|
predecessors = client.specification_version_predecessors('webrtc', '20241008')
|
126
196
|
successors = client.specification_version_successors('webrtc', '20241008')
|
127
197
|
|
198
|
+
# Navigate through version history with chained realization
|
199
|
+
version = client.specification_version('html5', '20140429')
|
200
|
+
|
201
|
+
# Get all predecessors and navigate through them
|
202
|
+
predecessors = version.links.predecessor_versions.realize
|
203
|
+
predecessors.links.predecessor_versions.each do |pred_link|
|
204
|
+
predecessor = pred_link.realize
|
205
|
+
puts "#{predecessor.title} - #{predecessor.date}"
|
206
|
+
|
207
|
+
# Each predecessor can have its own predecessors
|
208
|
+
if predecessor.links.predecessor_versions
|
209
|
+
pred_predecessors = predecessor.links.predecessor_versions.realize
|
210
|
+
# Continue navigation...
|
211
|
+
end
|
212
|
+
end
|
213
|
+
|
214
|
+
# Get all successors and navigate through them
|
215
|
+
successors = version.links.successor_versions.realize
|
216
|
+
successors.links.successor_versions.each do |succ_link|
|
217
|
+
successor = succ_link.realize
|
218
|
+
puts "#{successor.title} - #{successor.date}"
|
219
|
+
|
220
|
+
# Each successor can have its own successors
|
221
|
+
if successor.links.successor_versions
|
222
|
+
succ_successors = successor.links.successor_versions.realize
|
223
|
+
# Continue navigation...
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
128
227
|
# All client methods support comprehensive options including:
|
129
228
|
|
130
229
|
# Pagination options
|
131
|
-
specifications = client.specifications(page: 2,
|
132
|
-
groups = client.groups(page: 1,
|
230
|
+
specifications = client.specifications(page: 2, per_page: 50)
|
231
|
+
groups = client.groups(page: 1, per_page: 10, limit: 25, offset: 100)
|
133
232
|
|
134
233
|
# HTTP client options
|
135
234
|
user = client.user('hash', timeout: 30, headers: { 'User-Agent' => 'MyApp/1.0' })
|
@@ -202,155 +301,6 @@ ecosystems = client.ecosystems
|
|
202
301
|
ecosystem = client.ecosystem('data')
|
203
302
|
----
|
204
303
|
|
205
|
-
=== Pagination
|
206
|
-
|
207
|
-
All index endpoints support pagination with the following parameters:
|
208
|
-
|
209
|
-
* `page` - The page number to retrieve (default: 1)
|
210
|
-
* `items` - The number of items per page (default: 100)
|
211
|
-
|
212
|
-
==== Basic pagination
|
213
|
-
|
214
|
-
[source,ruby]
|
215
|
-
----
|
216
|
-
# Get first page with default limit (100 items)
|
217
|
-
specifications = client.specifications
|
218
|
-
|
219
|
-
# Get specific page with custom limit
|
220
|
-
specifications = client.specifications(page: 2, items: 25)
|
221
|
-
|
222
|
-
# Get first page with smaller limit
|
223
|
-
groups = client.groups(page: 1, items: 10)
|
224
|
-
----
|
225
|
-
|
226
|
-
==== Navigation links
|
227
|
-
|
228
|
-
All paginated responses include navigation links that can be used to traverse
|
229
|
-
pages:
|
230
|
-
|
231
|
-
[source,ruby]
|
232
|
-
----
|
233
|
-
# Get first page
|
234
|
-
specs_page1 = client.specifications(page: 1, items: 10)
|
235
|
-
|
236
|
-
# Access navigation links
|
237
|
-
links = specs_page1.links
|
238
|
-
|
239
|
-
# Check available navigation options
|
240
|
-
puts "Has next page: #{!links.next.nil?}"
|
241
|
-
puts "Has previous page: #{!links.prev.nil?}"
|
242
|
-
|
243
|
-
# Navigate to next page using the link
|
244
|
-
if links.next
|
245
|
-
next_page = links.next.realize
|
246
|
-
puts "Next page number: #{next_page.page}"
|
247
|
-
puts "Items on next page: #{next_page.links.specifications.length}"
|
248
|
-
end
|
249
|
-
|
250
|
-
# Navigate to first/last pages
|
251
|
-
first_page = links.first.realize if links.first
|
252
|
-
last_page = links.last.realize if links.last
|
253
|
-
----
|
254
|
-
|
255
|
-
==== Pagination information
|
256
|
-
|
257
|
-
Each paginated response includes metadata about the pagination state:
|
258
|
-
|
259
|
-
[source,ruby]
|
260
|
-
----
|
261
|
-
specs = client.specifications(page: 2, items: 25)
|
262
|
-
|
263
|
-
puts "Current page: #{specs.page}" # 2
|
264
|
-
puts "Items per page: #{specs.limit}" # 25
|
265
|
-
puts "Total items: #{specs.total}" # e.g., 1643
|
266
|
-
puts "Total pages: #{specs.pages}" # e.g., 66
|
267
|
-
----
|
268
|
-
|
269
|
-
==== Iterating through all pages
|
270
|
-
|
271
|
-
[source,ruby]
|
272
|
-
----
|
273
|
-
# Method 1: Using navigation links
|
274
|
-
current_page = client.specifications(page: 1, items: 50)
|
275
|
-
all_specifications = []
|
276
|
-
|
277
|
-
loop do
|
278
|
-
all_specifications.concat(current_page.links.specifications)
|
279
|
-
|
280
|
-
break unless current_page.links.next
|
281
|
-
|
282
|
-
current_page = current_page.links.next.realize
|
283
|
-
end
|
284
|
-
|
285
|
-
puts "Total specifications collected: #{all_specifications.length}"
|
286
|
-
|
287
|
-
# Method 2: Manual page iteration
|
288
|
-
page = 1
|
289
|
-
all_specifications = []
|
290
|
-
|
291
|
-
loop do
|
292
|
-
current_page = client.specifications(page: page, items: 50)
|
293
|
-
specifications = current_page.links.specifications
|
294
|
-
|
295
|
-
break if specifications.empty?
|
296
|
-
|
297
|
-
all_specifications.concat(specifications)
|
298
|
-
page += 1
|
299
|
-
end
|
300
|
-
----
|
301
|
-
|
302
|
-
==== Pagination for nested resources
|
303
|
-
|
304
|
-
Nested resources also support pagination:
|
305
|
-
|
306
|
-
[source,ruby]
|
307
|
-
----
|
308
|
-
# Get a group
|
309
|
-
group = client.group(109735)
|
310
|
-
|
311
|
-
# Get paginated specifications for this group
|
312
|
-
specs = group.specifications(page: 1, items: 10)
|
313
|
-
|
314
|
-
# Navigate through pages
|
315
|
-
if specs.links.next
|
316
|
-
next_specs = specs.links.next.realize
|
317
|
-
end
|
318
|
-
|
319
|
-
# Other nested resources with pagination
|
320
|
-
users = group.users(page: 1, items: 20)
|
321
|
-
chairs = group.chairs(page: 1, items: 5)
|
322
|
-
participations = group.participations(page: 1, items: 15)
|
323
|
-
|
324
|
-
# Affiliation nested resources
|
325
|
-
affiliation = client.affiliation(35662)
|
326
|
-
participants = affiliation.participants(page: 1, items: 10)
|
327
|
-
participations = affiliation.participations(page: 1, items: 10)
|
328
|
-
----
|
329
|
-
|
330
|
-
==== Supported endpoints
|
331
|
-
|
332
|
-
All the following endpoints support pagination:
|
333
|
-
|
334
|
-
* `client.specifications(page:, items:)`
|
335
|
-
* `client.groups(page:, items:)`
|
336
|
-
* `client.affiliations(page:, items:)`
|
337
|
-
* `client.series(page:, items:)`
|
338
|
-
* `client.translations(page:, items:)`
|
339
|
-
* `client.ecosystems(page:, items:)`
|
340
|
-
* `group.specifications(page:, items:)`
|
341
|
-
* `group.users(page:, items:)`
|
342
|
-
* `group.chairs(page:, items:)`
|
343
|
-
* `group.team_contacts(page:, items:)`
|
344
|
-
* `group.participations(page:, items:)`
|
345
|
-
* `affiliation.participants(page:, items:)`
|
346
|
-
* `affiliation.participations(page:, items:)`
|
347
|
-
* `participation.participants(page:, items:)`
|
348
|
-
* `user.groups(page:, items:)`
|
349
|
-
* `user.specifications(page:, items:)`
|
350
|
-
* `user.affiliations(page:, items:)`
|
351
|
-
* `user.participations(page:, items:)`
|
352
|
-
* And many more nested resource endpoints
|
353
|
-
|
354
304
|
=== Models
|
355
305
|
|
356
306
|
==== General
|
@@ -358,7 +308,6 @@ All the following endpoints support pagination:
|
|
358
308
|
This library provides models for various W3C API resources under the
|
359
309
|
`W3cApi::Models` namespace.
|
360
310
|
|
361
|
-
|
362
311
|
==== Affiliation
|
363
312
|
|
364
313
|
The `W3cApi::Models::Affiliation` represents a W3C affiliation model that
|
@@ -367,6 +316,7 @@ includes various attributes and methods to interact with affiliated entities.
|
|
367
316
|
.Fetching the affiliation index
|
368
317
|
[example]
|
369
318
|
====
|
319
|
+
|
370
320
|
[source,ruby]
|
371
321
|
----
|
372
322
|
> W3cApi::Hal.instance.register.fetch(:affiliation_index)
|
@@ -406,6 +356,7 @@ includes various attributes and methods to interact with affiliated entities.
|
|
406
356
|
.Fetching a specific affiliation
|
407
357
|
[example]
|
408
358
|
====
|
359
|
+
|
409
360
|
[source,ruby]
|
410
361
|
----
|
411
362
|
> W3cApi::Hal.instance.register.fetch(:affiliation_resource, id: 35662)
|
@@ -418,8 +369,6 @@ includes various attributes and methods to interact with affiliated entities.
|
|
418
369
|
----
|
419
370
|
====
|
420
371
|
|
421
|
-
|
422
|
-
|
423
372
|
== Command line interface
|
424
373
|
|
425
374
|
=== General
|
@@ -436,6 +385,8 @@ using the `--format` option, which accepts `json` or `yaml`.
|
|
436
385
|
Commands:
|
437
386
|
# Work with W3C specifications
|
438
387
|
w3c_api specification SUBCOMMAND ...ARGS
|
388
|
+
# Work with W3C specification versions
|
389
|
+
w3c_api specification_version SUBCOMMAND ...ARGS
|
439
390
|
# Work with W3C specification series
|
440
391
|
w3c_api series SUBCOMMAND ...ARGS
|
441
392
|
# Work with W3C groups
|
@@ -525,7 +476,6 @@ _links:
|
|
525
476
|
----
|
526
477
|
====
|
527
478
|
|
528
|
-
|
529
479
|
==== Versions
|
530
480
|
|
531
481
|
This command provides access to W3C specification versions given a shortname.
|
@@ -578,61 +528,65 @@ specifications:
|
|
578
528
|
----
|
579
529
|
====
|
580
530
|
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
608
|
-
|
609
|
-
|
610
|
-
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
623
|
-
|
624
|
-
|
625
|
-
|
626
|
-
|
627
|
-
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
|
633
|
-
|
634
|
-
|
635
|
-
|
531
|
+
=== Specification version
|
532
|
+
|
533
|
+
==== Editors
|
534
|
+
|
535
|
+
This command provides access to editors of a specification version.
|
536
|
+
|
537
|
+
[source,shell]
|
538
|
+
----
|
539
|
+
# Fetch editors of a specification version
|
540
|
+
$ w3c_api specification_version editors --shortname=webrtc --version=20241008
|
541
|
+
----
|
542
|
+
|
543
|
+
[example]
|
544
|
+
====
|
545
|
+
[source,shell]
|
546
|
+
----
|
547
|
+
$ w3c_api specification_version editors --shortname=webrtc --version=20241008
|
548
|
+
---
|
549
|
+
_links:
|
550
|
+
editors:
|
551
|
+
- href: https://api.w3.org/users/bzb5w20eg68k40gc8w0wg0okk4k84os
|
552
|
+
title: Cullen Jennings
|
553
|
+
type: User
|
554
|
+
- href: https://api.w3.org/users/f521yr1m6g0kks880s8ocwsgwskgss4
|
555
|
+
title: Jan-Ivar Bruaroey
|
556
|
+
type: User
|
557
|
+
- href: https://api.w3.org/users/1dsgdsi4zrj4goo4k400c8scw4k4ggk
|
558
|
+
title: Henrik Boström
|
559
|
+
type: User
|
560
|
+
- href: https://api.w3.org/users/nlyfs3q8s2s0gk0owoggkco0sg0wwso
|
561
|
+
title: Florent Castelli
|
562
|
+
type: User
|
563
|
+
----
|
564
|
+
====
|
565
|
+
|
566
|
+
==== Deliverers
|
567
|
+
|
568
|
+
This command provides access to deliverers (working groups) of a specification
|
569
|
+
version.
|
570
|
+
|
571
|
+
[source,shell]
|
572
|
+
----
|
573
|
+
# Fetch deliverers of a specification version
|
574
|
+
$ w3c_api specification_version deliverers --shortname=webrtc --version=20241008
|
575
|
+
----
|
576
|
+
|
577
|
+
[example]
|
578
|
+
====
|
579
|
+
[source,shell]
|
580
|
+
----
|
581
|
+
$ w3c_api specification_version deliverers --shortname=webrtc --version=20241008
|
582
|
+
---
|
583
|
+
_links:
|
584
|
+
deliverers:
|
585
|
+
- href: https://api.w3.org/groups/wg/webrtc
|
586
|
+
title: Web Real-Time Communications Working Group
|
587
|
+
type: Group
|
588
|
+
----
|
589
|
+
====
|
636
590
|
|
637
591
|
=== Series
|
638
592
|
|
@@ -715,8 +669,8 @@ specifications:
|
|
715
669
|
|
716
670
|
This command provides access to W3C users.
|
717
671
|
|
718
|
-
[IMPORTANT]
|
719
672
|
.User ID formats
|
673
|
+
[IMPORTANT]
|
720
674
|
====
|
721
675
|
The W3C API uses both numeric IDs (e.g., `128112`) and string IDs (e.g.,
|
722
676
|
`f1ovb5rydm8s0go04oco0cgk0sow44w`) for users. All user-related commands
|
@@ -903,76 +857,9 @@ participations:
|
|
903
857
|
href: https://api.w3.org/participations/38783
|
904
858
|
- title: Positive Work Environment Community Group
|
905
859
|
href: https://api.w3.org/participations/38784
|
906
|
-
- title: Web Performance Working Group
|
907
|
-
href: https://api.w3.org/participations/38786
|
908
|
-
- title: Spatio-temporal Data on the Web Working Group
|
909
|
-
href: https://api.w3.org/participations/44558
|
910
|
-
- title: W3C Process Community Group
|
911
|
-
href: https://api.w3.org/participations/39267
|
912
|
-
- title: Equity Community Group
|
913
|
-
href: https://api.w3.org/participations/39352
|
914
|
-
- title: Web Components Community Group
|
915
|
-
href: https://api.w3.org/participations/40553
|
916
|
-
- title: Accessible Platform Architectures Working Group
|
917
|
-
href: https://api.w3.org/participations/36682
|
918
|
-
- title: Sustainability Community Group
|
919
|
-
href: https://api.w3.org/participations/41861
|
920
|
-
- title: Web Applications Working Group
|
921
|
-
href: https://api.w3.org/participations/43789
|
922
|
-
- title: Accessibility Internationalization Community Group
|
923
|
-
href: https://api.w3.org/participations/43788
|
924
|
-
- title: Sustainable Web Interest Group
|
925
|
-
href: https://api.w3.org/participations/44152
|
926
|
-
----
|
927
|
-
====
|
928
|
-
|
929
|
-
==== Chair of groups
|
930
|
-
|
931
|
-
Getting groups a user chairs.
|
932
|
-
|
933
|
-
[source,shell]
|
934
|
-
----
|
935
|
-
# Fetch groups a user chairs
|
936
|
-
$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
937
|
-
----
|
938
|
-
|
939
|
-
[example]
|
940
|
-
====
|
941
|
-
[source,shell]
|
942
|
-
----
|
943
|
-
$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
944
|
-
---
|
945
|
-
groups:
|
946
|
-
- href: https://api.w3.org/groups/cg/equity
|
947
|
-
title: Equity Community Group
|
948
|
-
----
|
949
|
-
====
|
950
|
-
|
951
|
-
==== Team Contact of Groups
|
952
|
-
|
953
|
-
Getting groups a user is a team contact of.
|
954
|
-
|
955
|
-
[source,shell]
|
956
|
-
----
|
957
|
-
# Fetch groups a user is a team contact of
|
958
|
-
$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
959
|
-
----
|
960
|
-
|
961
|
-
[example]
|
962
|
-
====
|
963
|
-
[source,shell]
|
964
|
-
----
|
965
|
-
$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
966
|
-
groups:
|
967
|
-
- name: Web Platform Working Group
|
968
|
-
href: https://api.w3.org/groups/72825
|
969
|
-
- name: Internationalization Working Group
|
970
|
-
href: https://api.w3.org/groups/32113
|
971
|
-
# Additional groups omitted for brevity
|
972
860
|
----
|
973
861
|
====
|
974
862
|
|
975
|
-
|
976
863
|
=== Groups
|
977
864
|
|
978
865
|
This command provides access to W3C groups.
|
@@ -994,14 +881,10 @@ $ w3c_api group fetch [OPTIONS]
|
|
994
881
|
$ w3c_api group fetch
|
995
882
|
---
|
996
883
|
groups:
|
997
|
-
- href: https://api.w3.org/groups/
|
998
|
-
title:
|
999
|
-
- href: https://api.w3.org/groups/cg/
|
1000
|
-
title: Accessibility
|
1001
|
-
- href: https://api.w3.org/groups/tf/wcag-act
|
1002
|
-
title: Accessibility Conformance Testing (ACT) Task Force
|
1003
|
-
- href: https://api.w3.org/groups/cg/a11y-discov-vocab
|
1004
|
-
title: Accessibility Discoverability Vocabulary for Schema.org Community Group
|
884
|
+
- href: https://api.w3.org/groups/wg/ag
|
885
|
+
title: Accessibility Guidelines Working Group
|
886
|
+
- href: https://api.w3.org/groups/cg/global-inclusion
|
887
|
+
title: Accessibility Internationalization Community Group
|
1005
888
|
# Additional groups omitted for brevity
|
1006
889
|
----
|
1007
890
|
====
|
@@ -1020,262 +903,167 @@ $ w3c_api group fetch --id=109735
|
|
1020
903
|
====
|
1021
904
|
[source,shell]
|
1022
905
|
----
|
906
|
+
$ w3c_api group fetch --id=109735
|
1023
907
|
---
|
1024
908
|
id: 109735
|
1025
909
|
name: Immersive Web Working Group
|
1026
|
-
type: working group
|
1027
|
-
description: The mission of the Immersive Web Working Group is to help bring high-performance
|
1028
|
-
Virtual Reality (VR) and Augmented Reality (AR) (collectively known as XR) to the
|
1029
|
-
open Web via APIs to interact with XR devices and sensors in browsers.
|
1030
910
|
shortname: immersive-web
|
1031
|
-
|
1032
|
-
start_date: '2018-
|
1033
|
-
end_date: '
|
1034
|
-
|
911
|
+
type: working group
|
912
|
+
start_date: '2018-10-01'
|
913
|
+
end_date: '2020-09-30'
|
914
|
+
description: The mission of the Immersive Web Working Group is to help bring
|
915
|
+
high-performance Virtual Reality (VR) and Augmented Reality (AR) to the open Web
|
916
|
+
via APIs to interact with VR and AR devices and sensors in browsers.
|
1035
917
|
_links:
|
1036
918
|
self:
|
1037
919
|
href: https://api.w3.org/groups/wg/immersive-web
|
1038
|
-
|
1039
|
-
href: https://
|
1040
|
-
|
1041
|
-
|
1042
|
-
|
1043
|
-
==== Chairs
|
1044
|
-
|
1045
|
-
Fetching chairs for a group.
|
1046
|
-
|
1047
|
-
[source,shell]
|
1048
|
-
----
|
1049
|
-
# Fetch chairs for a group
|
1050
|
-
$ w3c_api group chairs --id={id}
|
1051
|
-
----
|
1052
|
-
|
1053
|
-
[example]
|
1054
|
-
====
|
1055
|
-
[source,shell]
|
1056
|
-
----
|
1057
|
-
$ w3c_api group chairs --id=109735
|
1058
|
-
---
|
1059
|
-
_links:
|
1060
|
-
self:
|
1061
|
-
href: https://api.w3.org/groups/109735/chairs?page=1&items=100
|
1062
|
-
type: W3cApi::Models::ChairIndex
|
1063
|
-
first:
|
1064
|
-
href: https://api.w3.org/groups/109735/chairs?page=1&items=100
|
1065
|
-
type: W3cApi::Models::ChairIndex
|
1066
|
-
last:
|
1067
|
-
href: https://api.w3.org/groups/109735/chairs?page=1&items=100
|
1068
|
-
type: W3cApi::Models::ChairIndex
|
1069
|
-
up:
|
1070
|
-
href: https://api.w3.org/groups/109735
|
1071
|
-
type: W3cApi::Models::ChairIndex
|
920
|
+
users:
|
921
|
+
href: https://api.w3.org/groups/109735/users
|
922
|
+
specifications:
|
923
|
+
href: https://api.w3.org/groups/109735/specifications
|
1072
924
|
chairs:
|
1073
|
-
|
1074
|
-
|
1075
|
-
|
1076
|
-
|
1077
|
-
|
1078
|
-
type: User
|
1079
|
-
- href: https://api.w3.org/users/m99jqkpi9m8oww84kw4gwccgc4g0ogs
|
1080
|
-
title: Ayşegül Yönet
|
1081
|
-
type: User
|
925
|
+
href: https://api.w3.org/groups/109735/chairs
|
926
|
+
team_contacts:
|
927
|
+
href: https://api.w3.org/groups/109735/teamcontacts
|
928
|
+
charters:
|
929
|
+
href: https://api.w3.org/groups/109735/charters
|
1082
930
|
----
|
1083
931
|
====
|
1084
932
|
|
1085
|
-
====
|
933
|
+
==== Users
|
1086
934
|
|
1087
|
-
|
935
|
+
Getting users in a group.
|
1088
936
|
|
1089
937
|
[source,shell]
|
1090
938
|
----
|
1091
|
-
# Fetch
|
1092
|
-
$ w3c_api group
|
939
|
+
# Fetch users in a group
|
940
|
+
$ w3c_api group users --id=109735
|
1093
941
|
----
|
1094
942
|
|
1095
943
|
[example]
|
1096
944
|
====
|
1097
945
|
[source,shell]
|
1098
946
|
----
|
1099
|
-
$ w3c_api group
|
947
|
+
$ w3c_api group users --id=109735
|
1100
948
|
---
|
1101
|
-
|
1102
|
-
|
1103
|
-
|
1104
|
-
|
1105
|
-
|
1106
|
-
|
1107
|
-
type: W3cApi::Models::TeamContactIndex
|
1108
|
-
last:
|
1109
|
-
href: https://api.w3.org/groups/109735/teamcontacts?page=1&items=100
|
1110
|
-
type: W3cApi::Models::TeamContactIndex
|
1111
|
-
up:
|
1112
|
-
href: https://api.w3.org/groups/109735
|
1113
|
-
type: W3cApi::Models::TeamContactIndex
|
1114
|
-
team-contacts:
|
1115
|
-
- href: https://api.w3.org/users/1eb2xr7ab6zo0k8440o48swso408ksc
|
1116
|
-
title: Atsushi Shimono
|
1117
|
-
type: User
|
949
|
+
users:
|
950
|
+
- href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w
|
951
|
+
title: Jennifer Strickland
|
952
|
+
- href: https://api.w3.org/users/bzb5w20eg68k40gc8w0wg0okk4k84os
|
953
|
+
title: Cullen Jennings
|
954
|
+
# Additional users omitted for brevity
|
1118
955
|
----
|
1119
956
|
====
|
1120
957
|
|
1121
|
-
====
|
958
|
+
==== Specifications
|
1122
959
|
|
1123
|
-
|
960
|
+
Getting specifications delivered by a group.
|
1124
961
|
|
1125
962
|
[source,shell]
|
1126
963
|
----
|
1127
|
-
# Fetch
|
1128
|
-
$ w3c_api group
|
964
|
+
# Fetch specifications delivered by a group
|
965
|
+
$ w3c_api group specifications --id=109735
|
1129
966
|
----
|
1130
967
|
|
1131
968
|
[example]
|
1132
969
|
====
|
1133
970
|
[source,shell]
|
1134
971
|
----
|
1135
|
-
$ w3c_api group
|
972
|
+
$ w3c_api group specifications --id=109735
|
1136
973
|
---
|
1137
|
-
|
1138
|
-
|
1139
|
-
|
1140
|
-
|
1141
|
-
|
1142
|
-
|
1143
|
-
type: ParticipationIndex
|
1144
|
-
last:
|
1145
|
-
href: https://api.w3.org/groups/109735/participations?page=1&items=100
|
1146
|
-
type: ParticipationIndex
|
1147
|
-
up:
|
1148
|
-
href: https://api.w3.org/groups/109735
|
1149
|
-
type: ParticipationIndex
|
1150
|
-
participations:
|
1151
|
-
- href: https://api.w3.org/participations/43367
|
1152
|
-
title: Kodansha, Publishers, Ltd.
|
1153
|
-
type: Participation
|
1154
|
-
- href: https://api.w3.org/participations/43368
|
1155
|
-
title: Institut National de Recherche en Informatique et en Automatique (Inria)
|
1156
|
-
type: Participation
|
1157
|
-
- href: https://api.w3.org/participations/43391
|
1158
|
-
title: Igalia
|
1159
|
-
type: Participation
|
1160
|
-
- href: https://api.w3.org/participations/43415
|
1161
|
-
title: Christine Perey
|
1162
|
-
type: Participation
|
974
|
+
specifications:
|
975
|
+
- title: WebXR Device API
|
976
|
+
href: https://api.w3.org/specifications/webxr
|
977
|
+
- title: WebXR Gamepads Module - Level 1
|
978
|
+
href: https://api.w3.org/specifications/webxr-gamepads-1
|
979
|
+
# Additional specifications omitted for brevity
|
1163
980
|
----
|
1164
981
|
====
|
1165
982
|
|
983
|
+
=== Affiliations
|
1166
984
|
|
1167
|
-
|
985
|
+
This command provides access to W3C affiliations.
|
986
|
+
|
987
|
+
==== Index
|
1168
988
|
|
1169
|
-
Fetching
|
989
|
+
Fetching an index of affiliations.
|
1170
990
|
|
1171
991
|
[source,shell]
|
1172
992
|
----
|
1173
|
-
# Fetch
|
1174
|
-
$ w3c_api
|
993
|
+
# Fetch affiliations
|
994
|
+
$ w3c_api affiliation fetch [OPTIONS]
|
1175
995
|
----
|
1176
996
|
|
1177
997
|
[example]
|
1178
998
|
====
|
1179
999
|
[source,shell]
|
1180
1000
|
----
|
1181
|
-
$ w3c_api
|
1001
|
+
$ w3c_api affiliation fetch
|
1182
1002
|
---
|
1183
|
-
|
1184
|
-
|
1185
|
-
|
1186
|
-
|
1187
|
-
|
1188
|
-
|
1189
|
-
type: Specification
|
1190
|
-
- href: https://api.w3.org/specifications/webxr-gamepads-module-1
|
1191
|
-
title: WebXR Gamepads Module - Level 1
|
1192
|
-
type: Specification
|
1193
|
-
- href: https://api.w3.org/specifications/webxrlayers-1
|
1194
|
-
title: WebXR Layers API Level 1
|
1195
|
-
type: Specification
|
1196
|
-
- href: https://api.w3.org/specifications/webxr-hand-input-1
|
1197
|
-
title: WebXR Hand Input Module - Level 1
|
1198
|
-
type: Specification
|
1199
|
-
- href: https://api.w3.org/specifications/webxr-hit-test-1
|
1200
|
-
title: WebXR Hit Test Module
|
1201
|
-
type: Specification
|
1202
|
-
- href: https://api.w3.org/specifications/webxr-depth-sensing-1
|
1203
|
-
title: WebXR Depth Sensing Module
|
1204
|
-
type: Specification
|
1205
|
-
- href: https://api.w3.org/specifications/webxr-dom-overlays-1
|
1206
|
-
title: WebXR DOM Overlays Module
|
1207
|
-
type: Specification
|
1208
|
-
- href: https://api.w3.org/specifications/webxr
|
1209
|
-
title: WebXR Device API
|
1210
|
-
type: Specification
|
1003
|
+
affiliations:
|
1004
|
+
- href: https://api.w3.org/affiliations/1001
|
1005
|
+
title: Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)
|
1006
|
+
- href: https://api.w3.org/affiliations/1003
|
1007
|
+
title: BackWeb Technologies, Inc.
|
1008
|
+
# Additional affiliations omitted for brevity
|
1211
1009
|
----
|
1212
1010
|
====
|
1213
1011
|
|
1214
|
-
====
|
1012
|
+
==== Get
|
1215
1013
|
|
1216
|
-
|
1014
|
+
Getting an affiliation by ID.
|
1217
1015
|
|
1218
1016
|
[source,shell]
|
1219
1017
|
----
|
1220
|
-
# Fetch
|
1221
|
-
$ w3c_api
|
1018
|
+
# Fetch an affiliation
|
1019
|
+
$ w3c_api affiliation fetch --id=35662
|
1222
1020
|
----
|
1223
1021
|
|
1224
1022
|
[example]
|
1225
1023
|
====
|
1226
1024
|
[source,shell]
|
1227
1025
|
----
|
1228
|
-
$ w3c_api
|
1026
|
+
$ w3c_api affiliation fetch --id=35662
|
1229
1027
|
---
|
1230
|
-
|
1231
|
-
|
1232
|
-
|
1233
|
-
|
1234
|
-
|
1235
|
-
|
1236
|
-
|
1237
|
-
|
1238
|
-
|
1239
|
-
|
1240
|
-
- href: https://api.w3.org/users/ff80kfl6a0gso4oo8s40cg4c4wccgs0
|
1241
|
-
title: Trevor Baron
|
1242
|
-
type: User
|
1028
|
+
id: 35662
|
1029
|
+
name: Google LLC
|
1030
|
+
discr: organization
|
1031
|
+
_links:
|
1032
|
+
self:
|
1033
|
+
href: https://api.w3.org/affiliations/35662
|
1034
|
+
participants:
|
1035
|
+
href: https://api.w3.org/affiliations/35662/participants
|
1036
|
+
participations:
|
1037
|
+
href: https://api.w3.org/affiliations/35662/participations
|
1243
1038
|
----
|
1244
1039
|
====
|
1245
1040
|
|
1246
|
-
====
|
1041
|
+
==== Participants
|
1247
1042
|
|
1248
|
-
|
1043
|
+
Getting participants of an affiliation.
|
1249
1044
|
|
1250
1045
|
[source,shell]
|
1251
1046
|
----
|
1252
|
-
# Fetch
|
1253
|
-
$ w3c_api
|
1047
|
+
# Fetch participants of an affiliation
|
1048
|
+
$ w3c_api affiliation participants --id=35662
|
1254
1049
|
----
|
1255
1050
|
|
1256
1051
|
[example]
|
1257
1052
|
====
|
1258
1053
|
[source,shell]
|
1259
1054
|
----
|
1260
|
-
$ w3c_api
|
1055
|
+
$ w3c_api affiliation participants --id=35662
|
1261
1056
|
---
|
1262
|
-
|
1263
|
-
|
1264
|
-
|
1265
|
-
|
1266
|
-
-
|
1267
|
-
|
1268
|
-
type: Charter
|
1269
|
-
- href: https://api.w3.org/groups/109735/charters/464
|
1270
|
-
title: 2022-07-08 -> 2024-07-07
|
1271
|
-
type: Charter
|
1272
|
-
- href: https://api.w3.org/groups/109735/charters/514
|
1273
|
-
title: 2024-09-26 -> 2026-09-25
|
1274
|
-
type: Charter
|
1057
|
+
participants:
|
1058
|
+
- href: https://api.w3.org/users/bzb5w20eg68k40gc8w0wg0okk4k84os
|
1059
|
+
title: Cullen Jennings
|
1060
|
+
- href: https://api.w3.org/users/f521yr1m6g0kks880s8ocwsgwskgss4
|
1061
|
+
title: Jan-Ivar Bruaroey
|
1062
|
+
# Additional participants omitted for brevity
|
1275
1063
|
----
|
1276
1064
|
====
|
1277
1065
|
|
1278
|
-
===
|
1066
|
+
=== Translations
|
1279
1067
|
|
1280
1068
|
This command provides access to W3C translations.
|
1281
1069
|
|
@@ -1288,33 +1076,19 @@ Fetching an index of translations.
|
|
1288
1076
|
# Fetch translations
|
1289
1077
|
$ w3c_api translation fetch [OPTIONS]
|
1290
1078
|
----
|
1079
|
+
|
1291
1080
|
[example]
|
1292
1081
|
====
|
1293
1082
|
[source,shell]
|
1294
1083
|
----
|
1295
1084
|
$ w3c_api translation fetch
|
1296
1085
|
---
|
1297
|
-
|
1298
|
-
|
1299
|
-
|
1300
|
-
|
1301
|
-
|
1302
|
-
|
1303
|
-
{
|
1304
|
-
"href": "https://api.w3.org/translations/3",
|
1305
|
-
"title": "Vídeo de Introducción a la Accesibilidad Web y Estándares del W3C",
|
1306
|
-
"language": "es"
|
1307
|
-
},
|
1308
|
-
{
|
1309
|
-
"href": "https://api.w3.org/translations/4",
|
1310
|
-
"title": "Video-introductie over Web-toegankelijkheid en W3C-standaarden",
|
1311
|
-
"language": "nl"
|
1312
|
-
},
|
1313
|
-
{
|
1314
|
-
"href": "https://api.w3.org/translations/5",
|
1315
|
-
"title": "网页无障碍和W3C标准的介绍视频",
|
1316
|
-
"language": "zh_Hans"
|
1317
|
-
},...
|
1086
|
+
translations:
|
1087
|
+
- href: https://api.w3.org/translations/1
|
1088
|
+
title: HTML 4.01 Specification
|
1089
|
+
- href: https://api.w3.org/translations/2
|
1090
|
+
title: Cascading Style Sheets, level 1
|
1091
|
+
# Additional translations omitted for brevity
|
1318
1092
|
----
|
1319
1093
|
====
|
1320
1094
|
|
@@ -1325,117 +1099,51 @@ Getting a translation by ID.
|
|
1325
1099
|
[source,shell]
|
1326
1100
|
----
|
1327
1101
|
# Fetch a translation
|
1328
|
-
$ w3c_api translation fetch --id=
|
1102
|
+
$ w3c_api translation fetch --id=2
|
1329
1103
|
----
|
1330
1104
|
|
1331
1105
|
[example]
|
1332
1106
|
====
|
1333
1107
|
[source,shell]
|
1334
1108
|
----
|
1335
|
-
$ w3c_api translation fetch --id=
|
1109
|
+
$ w3c_api translation fetch --id=2
|
1336
1110
|
---
|
1111
|
+
id: 2
|
1112
|
+
title: Cascading Style Sheets, level 1
|
1113
|
+
language: fr
|
1114
|
+
url: https://www.yoyodesign.org/doc/w3c/css1/index.html
|
1337
1115
|
_links:
|
1338
1116
|
self:
|
1339
|
-
href: https://api.w3.org/translations/
|
1340
|
-
type: Translation
|
1341
|
-
uri: http://maujor.com/w3c/xml-base.html
|
1342
|
-
title: XML Base
|
1343
|
-
language: pt_BR
|
1344
|
-
published: '2005-09-23T00:00:00+00:00'
|
1345
|
-
authorized: false
|
1346
|
-
call-for-translation:
|
1347
|
-
_links:
|
1348
|
-
self:
|
1349
|
-
href: https://api.w3.org/callsfortranslation/28
|
1350
|
-
type: CallForTranslation
|
1351
|
-
translations:
|
1352
|
-
href: https://api.w3.org/callsfortranslation/28/translations
|
1353
|
-
type: TranslationIndex
|
1354
|
-
title: XML Base
|
1355
|
-
states:
|
1356
|
-
- published
|
1357
|
-
translators:
|
1358
|
-
- _links:
|
1359
|
-
self:
|
1360
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48
|
1361
|
-
type: User
|
1362
|
-
affiliations:
|
1363
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/affiliations
|
1364
|
-
type: W3cApi::Models::AffiliationIndex
|
1365
|
-
groups:
|
1366
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/groups
|
1367
|
-
type: GroupIndex
|
1368
|
-
specifications:
|
1369
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/specifications
|
1370
|
-
type: SpecificationIndex
|
1371
|
-
participations:
|
1372
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/participations
|
1373
|
-
type: ParticipationIndex
|
1374
|
-
id: '112282'
|
1375
|
-
name: Maurício Samy Silva
|
1376
|
-
given: Maurício
|
1377
|
-
family: Samy Silva
|
1378
|
-
discr: user
|
1117
|
+
href: https://api.w3.org/translations/2
|
1379
1118
|
----
|
1380
1119
|
====
|
1381
1120
|
|
1382
|
-
|
1383
|
-
=== Ecosystem
|
1121
|
+
=== Ecosystems
|
1384
1122
|
|
1385
1123
|
This command provides access to W3C ecosystems.
|
1386
1124
|
|
1387
1125
|
==== Index
|
1388
1126
|
|
1389
1127
|
Fetching an index of ecosystems.
|
1128
|
+
|
1390
1129
|
[source,shell]
|
1391
1130
|
----
|
1392
1131
|
# Fetch ecosystems
|
1393
1132
|
$ w3c_api ecosystem fetch [OPTIONS]
|
1394
1133
|
----
|
1134
|
+
|
1395
1135
|
[example]
|
1396
1136
|
====
|
1397
1137
|
[source,shell]
|
1398
1138
|
----
|
1399
1139
|
$ w3c_api ecosystem fetch
|
1400
1140
|
---
|
1401
|
-
|
1402
|
-
|
1403
|
-
|
1404
|
-
|
1405
|
-
|
1406
|
-
|
1407
|
-
type: W3cApi::Models::EcosystemIndex
|
1408
|
-
last:
|
1409
|
-
href: https://api.w3.org/ecosystems?embed=0&page=1&items=100
|
1410
|
-
type: W3cApi::Models::EcosystemIndex
|
1411
|
-
ecosystems:
|
1412
|
-
- href: https://api.w3.org/ecosystems/advertising
|
1413
|
-
title: Web Advertising
|
1414
|
-
type: Ecosystem
|
1415
|
-
- href: https://api.w3.org/ecosystems/e-commerce
|
1416
|
-
title: E-commerce
|
1417
|
-
type: Ecosystem
|
1418
|
-
- href: https://api.w3.org/ecosystems/media
|
1419
|
-
title: Media & Entertainment
|
1420
|
-
type: Ecosystem
|
1421
|
-
- href: https://api.w3.org/ecosystems/network-communications
|
1422
|
-
title: Network & Communications
|
1423
|
-
type: Ecosystem
|
1424
|
-
- href: https://api.w3.org/ecosystems/publishing
|
1425
|
-
title: Publishing
|
1426
|
-
type: Ecosystem
|
1427
|
-
- href: https://api.w3.org/ecosystems/smart-cities
|
1428
|
-
title: Smart Cities
|
1429
|
-
type: Ecosystem
|
1430
|
-
- href: https://api.w3.org/ecosystems/automotive-transportation
|
1431
|
-
title: Automotive & Transportation
|
1432
|
-
type: Ecosystem
|
1433
|
-
- href: https://api.w3.org/ecosystems/web-of-things
|
1434
|
-
title: Web of Things
|
1435
|
-
type: Ecosystem
|
1436
|
-
- href: https://api.w3.org/ecosystems/data
|
1437
|
-
title: Data and knowledge
|
1438
|
-
type: Ecosystem
|
1141
|
+
ecosystems:
|
1142
|
+
- shortname: advertising
|
1143
|
+
name: Advertising
|
1144
|
+
- shortname: data
|
1145
|
+
name: Data
|
1146
|
+
# Additional ecosystems omitted for brevity
|
1439
1147
|
----
|
1440
1148
|
====
|
1441
1149
|
|
@@ -1446,7 +1154,7 @@ Getting an ecosystem by shortname.
|
|
1446
1154
|
[source,shell]
|
1447
1155
|
----
|
1448
1156
|
# Fetch an ecosystem
|
1449
|
-
$ w3c_api ecosystem fetch --shortname=
|
1157
|
+
$ w3c_api ecosystem fetch --shortname=data
|
1450
1158
|
----
|
1451
1159
|
|
1452
1160
|
[example]
|
@@ -1455,404 +1163,60 @@ $ w3c_api ecosystem fetch --shortname={shortname}
|
|
1455
1163
|
----
|
1456
1164
|
$ w3c_api ecosystem fetch --shortname=data
|
1457
1165
|
---
|
1166
|
+
shortname: data
|
1167
|
+
name: Data
|
1168
|
+
description: The Data ecosystem focuses on technologies and standards for
|
1169
|
+
representing, exchanging, and processing data on the Web.
|
1458
1170
|
_links:
|
1459
1171
|
self:
|
1460
1172
|
href: https://api.w3.org/ecosystems/data
|
1461
|
-
type: Ecosystem
|
1462
|
-
champion:
|
1463
|
-
href: https://api.w3.org/users/t891ludoisggsccsw44o8goccc0s0ks
|
1464
|
-
title: Pierre-Antoine Champin
|
1465
|
-
type: User
|
1466
|
-
evangelists:
|
1467
|
-
href: https://api.w3.org/ecosystems/data/evangelists
|
1468
|
-
type: EvangelistIndex
|
1469
1173
|
groups:
|
1470
1174
|
href: https://api.w3.org/ecosystems/data/groups
|
1471
|
-
type: GroupIndex
|
1472
|
-
member-organizations:
|
1473
|
-
href: https://api.w3.org/ecosystems/data/member-organizations
|
1474
|
-
type: AffiliationIndex
|
1475
|
-
name: Data and knowledge
|
1476
|
-
shortname: data
|
1477
|
-
----
|
1478
|
-
====
|
1479
|
-
|
1480
|
-
==== Evangelists
|
1481
|
-
|
1482
|
-
Getting evangelists for an ecosystem.
|
1483
|
-
|
1484
|
-
[source,shell]
|
1485
|
-
----
|
1486
|
-
# Fetch evangelists for an ecosystem
|
1487
|
-
$ w3c_api ecosystem evangelists --shortname={shortname}
|
1488
|
-
----
|
1489
|
-
[example]
|
1490
|
-
====
|
1491
|
-
[source,shell]
|
1492
|
-
----
|
1493
|
-
$ w3c_api ecosystem evangelists --shortname=publishing
|
1494
|
-
---
|
1495
|
-
_links:
|
1496
|
-
self:
|
1497
|
-
href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
|
1498
|
-
type: EvangelistIndex
|
1499
|
-
first:
|
1500
|
-
href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
|
1501
|
-
type: EvangelistIndex
|
1502
|
-
last:
|
1503
|
-
href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
|
1504
|
-
type: EvangelistIndex
|
1505
|
-
up:
|
1506
|
-
href: https://api.w3.org/ecosystems/publishing
|
1507
|
-
type: EvangelistIndex
|
1508
1175
|
evangelists:
|
1509
|
-
|
1510
|
-
title: Bill Kasdorf
|
1511
|
-
type: User
|
1512
|
-
- href: https://api.w3.org/users/a5eur9p2iyo0ws00448w4gcw4c8sock
|
1513
|
-
title: Daihei Shiohama
|
1514
|
-
type: User
|
1515
|
-
- href: https://api.w3.org/users/qdkk81rtp344c44g0osoocgwwc8o4ss
|
1516
|
-
title: Bobby Tung
|
1517
|
-
type: User
|
1518
|
-
----
|
1519
|
-
====
|
1520
|
-
|
1521
|
-
==== Groups
|
1522
|
-
|
1523
|
-
Getting groups for an ecosystem.
|
1524
|
-
|
1525
|
-
[source,shell]
|
1526
|
-
----
|
1527
|
-
# Fetch groups for an ecosystem
|
1528
|
-
$ w3c_api ecosystem groups --shortname={shortname}
|
1529
|
-
----
|
1530
|
-
|
1531
|
-
[example]
|
1532
|
-
====
|
1533
|
-
[source,shell]
|
1534
|
-
----
|
1535
|
-
$ w3c_api ecosystem groups --shortname=publishing
|
1536
|
-
---
|
1537
|
-
---
|
1538
|
-
_links:
|
1539
|
-
self:
|
1540
|
-
href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
|
1541
|
-
type: GroupIndex
|
1542
|
-
first:
|
1543
|
-
href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
|
1544
|
-
type: GroupIndex
|
1545
|
-
last:
|
1546
|
-
href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
|
1547
|
-
type: GroupIndex
|
1548
|
-
up:
|
1549
|
-
href: https://api.w3.org/ecosystems/publishing
|
1550
|
-
type: GroupIndex
|
1551
|
-
groups:
|
1552
|
-
- href: https://api.w3.org/groups/cg/a11y-discov-vocab
|
1553
|
-
title: Accessibility Discoverability Vocabulary for Schema.org Community Group
|
1554
|
-
type: Group
|
1555
|
-
- href: https://api.w3.org/groups/cg/epub3
|
1556
|
-
title: EPUB 3 Community Group
|
1557
|
-
type: Group
|
1558
|
-
- href: https://api.w3.org/groups/bg/publishingbg
|
1559
|
-
title: Publishing Business Group
|
1560
|
-
type: Group
|
1561
|
-
- href: https://api.w3.org/groups/cg/publishingcg
|
1562
|
-
title: Publishing Community Group
|
1563
|
-
type: Group
|
1564
|
-
- href: https://api.w3.org/groups/wg/pm
|
1565
|
-
title: Publishing Maintenance Working Group
|
1566
|
-
type: Group
|
1567
|
-
----
|
1568
|
-
====
|
1569
|
-
|
1570
|
-
==== Member organizations
|
1571
|
-
|
1572
|
-
Getting member organizations for an ecosystem.
|
1573
|
-
|
1574
|
-
[source,shell]
|
1575
|
-
----
|
1576
|
-
# Fetch member organizations for an ecosystem
|
1577
|
-
$ w3c_api ecosystem member-organizations --shortname={shortname}
|
1578
|
-
----
|
1579
|
-
|
1580
|
-
[example]
|
1581
|
-
====
|
1582
|
-
[source,shell]
|
1583
|
-
----
|
1584
|
-
$ w3c_api ecosystem member-organizations --shortname=publishing
|
1585
|
-
---
|
1586
|
-
_links:
|
1587
|
-
self:
|
1588
|
-
href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
|
1589
|
-
type: W3cApi::Models::AffiliationIndex
|
1590
|
-
first:
|
1591
|
-
href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
|
1592
|
-
type: W3cApi::Models::AffiliationIndex
|
1593
|
-
last:
|
1594
|
-
href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
|
1595
|
-
type: W3cApi::Models::AffiliationIndex
|
1596
|
-
up:
|
1597
|
-
href: https://api.w3.org/ecosystems/publishing
|
1598
|
-
type: W3cApi::Models::AffiliationIndex
|
1599
|
-
affiliations:
|
1600
|
-
- href: https://api.w3.org/affiliations/56103
|
1601
|
-
title: ACCESS CO., LTD.
|
1602
|
-
type: Affiliation
|
1603
|
-
- href: https://api.w3.org/affiliations/1057
|
1604
|
-
title: Adobe
|
1605
|
-
type: Affiliation
|
1606
|
-
- href: https://api.w3.org/affiliations/108617
|
1607
|
-
title: Amazon
|
1608
|
-
type: Affiliation
|
1609
|
-
- href: https://api.w3.org/affiliations/43420
|
1610
|
-
title: Apache Software Foundation
|
1611
|
-
type: Affiliation
|
1612
|
-
...
|
1613
|
-
----
|
1614
|
-
====
|
1615
|
-
|
1616
|
-
=== Affiliations
|
1617
|
-
|
1618
|
-
==== Index
|
1619
|
-
|
1620
|
-
Fetching an index of affiliations.
|
1621
|
-
|
1622
|
-
[source,shell]
|
1623
|
-
----
|
1624
|
-
# Fetch affiliations
|
1625
|
-
$ w3c_api affiliation fetch [OPTIONS]
|
1626
|
-
----
|
1627
|
-
|
1628
|
-
[example]
|
1629
|
-
====
|
1630
|
-
[source,shell]
|
1631
|
-
----
|
1632
|
-
$ w3c_api affiliation fetch
|
1633
|
-
----
|
1634
|
-
====
|
1635
|
-
|
1636
|
-
==== Get
|
1637
|
-
|
1638
|
-
Getting an affiliation by ID.
|
1639
|
-
|
1640
|
-
[source,shell]
|
1641
|
-
----
|
1642
|
-
# Fetch an affiliation
|
1643
|
-
$ w3c_api affiliation fetch --id={id}
|
1644
|
-
----
|
1645
|
-
|
1646
|
-
[example]
|
1647
|
-
====
|
1648
|
-
[source,shell]
|
1649
|
-
----
|
1650
|
-
# Fetch an affiliation
|
1651
|
-
$ w3c_api affiliation fetch --id=1001
|
1652
|
-
---
|
1653
|
-
_links:
|
1654
|
-
self:
|
1655
|
-
href: https://api.w3.org/affiliations/1001
|
1656
|
-
type: Affiliation
|
1657
|
-
homepage:
|
1658
|
-
href: http://www.framkom.se
|
1659
|
-
type: String
|
1660
|
-
participants:
|
1661
|
-
href: https://api.w3.org/affiliations/1001/participants
|
1662
|
-
type: Participant
|
1663
|
-
participations:
|
1664
|
-
href: https://api.w3.org/affiliations/1001/participations
|
1665
|
-
type: Participation
|
1666
|
-
id: 1001
|
1667
|
-
name: Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)
|
1668
|
-
discr: organization
|
1669
|
-
is-member: false
|
1670
|
-
is-member-association: false
|
1671
|
-
is-partner-member: false
|
1672
|
-
----
|
1673
|
-
====
|
1674
|
-
|
1675
|
-
==== Participants
|
1676
|
-
|
1677
|
-
Getting participants for an affiliation.
|
1678
|
-
|
1679
|
-
[source,shell]
|
1680
|
-
----
|
1681
|
-
# Fetch participants for an affiliation
|
1682
|
-
$ w3c_api affiliation participants --id={id}
|
1683
|
-
----
|
1684
|
-
|
1685
|
-
[example]
|
1686
|
-
====
|
1687
|
-
[source,shell]
|
1688
|
-
----
|
1689
|
-
$ w3c_api affiliation participants --id=1104
|
1690
|
-
---
|
1691
|
-
_links:
|
1692
|
-
self:
|
1693
|
-
href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
|
1694
|
-
type: W3cApi::Models::ParticipantIndex
|
1695
|
-
first:
|
1696
|
-
href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
|
1697
|
-
type: W3cApi::Models::ParticipantIndex
|
1698
|
-
last:
|
1699
|
-
href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
|
1700
|
-
type: W3cApi::Models::ParticipantIndex
|
1701
|
-
up:
|
1702
|
-
href: https://api.w3.org/affiliations/1104
|
1703
|
-
type: W3cApi::Models::ParticipantIndex
|
1704
|
-
participants:
|
1705
|
-
- href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
|
1706
|
-
title: Jean-Luc Chevillard
|
1707
|
-
type: User
|
1176
|
+
href: https://api.w3.org/ecosystems/data/evangelists
|
1708
1177
|
----
|
1709
|
-
====
|
1710
1178
|
|
1179
|
+
== Installation
|
1711
1180
|
|
1712
|
-
|
1713
|
-
|
1714
|
-
Getting participations for an affiliation.
|
1715
|
-
|
1716
|
-
[source,shell]
|
1717
|
-
----
|
1718
|
-
# Fetch participations for an affiliation
|
1719
|
-
$ w3c_api affiliation participations --id={id}
|
1720
|
-
----
|
1181
|
+
Add this line to your application's Gemfile:
|
1721
1182
|
|
1722
|
-
[
|
1723
|
-
====
|
1724
|
-
[source,shell]
|
1183
|
+
[source,ruby]
|
1725
1184
|
----
|
1726
|
-
|
1727
|
-
---
|
1728
|
-
_links:
|
1729
|
-
self:
|
1730
|
-
href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
|
1731
|
-
type: ParticipationIndex
|
1732
|
-
first:
|
1733
|
-
href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
|
1734
|
-
type: ParticipationIndex
|
1735
|
-
last:
|
1736
|
-
href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
|
1737
|
-
type: ParticipationIndex
|
1738
|
-
up:
|
1739
|
-
href: https://api.w3.org/affiliations/1104
|
1740
|
-
type: ParticipationIndex
|
1741
|
-
participations:
|
1742
|
-
- href: https://api.w3.org/participations/32932
|
1743
|
-
title: XQuery and XSLT Extensions Community Group
|
1744
|
-
type: Participation
|
1185
|
+
gem 'w3c_api'
|
1745
1186
|
----
|
1746
|
-
====
|
1747
1187
|
|
1748
|
-
|
1749
|
-
|
1750
|
-
==== Get
|
1751
|
-
|
1752
|
-
Getting a participation by ID.
|
1188
|
+
And then execute:
|
1753
1189
|
|
1754
1190
|
[source,shell]
|
1755
1191
|
----
|
1756
|
-
|
1757
|
-
$ w3c_api participation fetch --id={id}
|
1192
|
+
$ bundle install
|
1758
1193
|
----
|
1759
1194
|
|
1760
|
-
|
1761
|
-
====
|
1762
|
-
[source,shell]
|
1763
|
-
----
|
1764
|
-
$ w3c_api participation fetch --id=32932
|
1765
|
-
---
|
1766
|
-
_links:
|
1767
|
-
self:
|
1768
|
-
href: https://api.w3.org/participations/32932
|
1769
|
-
type: Participation
|
1770
|
-
group:
|
1771
|
-
href: https://api.w3.org/groups/cg/xslt-40
|
1772
|
-
title: XQuery and XSLT Extensions Community Group
|
1773
|
-
type: Group
|
1774
|
-
organization:
|
1775
|
-
href: https://api.w3.org/affiliations/1104
|
1776
|
-
title: CNRS
|
1777
|
-
type: Affiliation
|
1778
|
-
participants:
|
1779
|
-
href: https://api.w3.org/participations/32932/participants
|
1780
|
-
type: W3cApi::Models::ParticipantIndex
|
1781
|
-
individual: false
|
1782
|
-
invited-expert: false
|
1783
|
-
created: '2020-11-28T05:59:24+00:00'
|
1784
|
-
----
|
1785
|
-
====
|
1786
|
-
|
1787
|
-
==== Participants
|
1788
|
-
|
1789
|
-
Getting participants for a participation.
|
1195
|
+
Or install it yourself as:
|
1790
1196
|
|
1791
1197
|
[source,shell]
|
1792
1198
|
----
|
1793
|
-
|
1794
|
-
$ w3c_api participation participants --id={id}
|
1795
|
-
----
|
1796
|
-
|
1797
|
-
[example]
|
1798
|
-
====
|
1799
|
-
[source,shell]
|
1199
|
+
$ gem install w3c_api
|
1800
1200
|
----
|
1801
|
-
$ w3c_api participation participants --id=32932
|
1802
|
-
---
|
1803
|
-
_links:
|
1804
|
-
self:
|
1805
|
-
href: https://api.w3.org/participations/32932/participants?page=1&items=100
|
1806
|
-
type: W3cApi::Models::ParticipantIndex
|
1807
|
-
first:
|
1808
|
-
href: https://api.w3.org/participations/32932/participants?page=1&items=100
|
1809
|
-
type: W3cApi::Models::ParticipantIndex
|
1810
|
-
last:
|
1811
|
-
href: https://api.w3.org/participations/32932/participants?page=1&items=100
|
1812
|
-
type: W3cApi::Models::ParticipantIndex
|
1813
|
-
up:
|
1814
|
-
href: https://api.w3.org/participations/32932
|
1815
|
-
type: W3cApi::Models::ParticipantIndex
|
1816
|
-
participants:
|
1817
|
-
- href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
|
1818
|
-
title: Jean-Luc Chevillard
|
1819
|
-
type: User
|
1820
|
-
----
|
1821
|
-
====
|
1822
|
-
|
1823
1201
|
|
1824
|
-
==
|
1202
|
+
== Development
|
1825
1203
|
|
1826
|
-
|
1827
|
-
|
1204
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then,
|
1205
|
+
run `rake spec` to run the tests. You can also run `bin/console` for an
|
1206
|
+
interactive prompt that will allow you to experiment.
|
1828
1207
|
|
1829
|
-
|
1830
|
-
|
1831
|
-
|
1832
|
-
|
1833
|
-
|
1834
|
-
[source,sh]
|
1835
|
-
----
|
1836
|
-
# Enable debug mode
|
1837
|
-
$ export DEBUG_API=1
|
1838
|
-
$ w3c_api specification fetch --shortname=webrtc
|
1839
|
-
----
|
1840
|
-
====
|
1841
|
-
|
1842
|
-
.Enabling debug mode in Ruby
|
1843
|
-
[example]
|
1844
|
-
====
|
1845
|
-
[source,ruby]
|
1846
|
-
----
|
1847
|
-
ENV["DEBUG_API"] = "1"
|
1848
|
-
W3cApi::Hal.instance.register.fetch(:specification_index)
|
1849
|
-
----
|
1850
|
-
====
|
1208
|
+
To install this gem onto your local machine, run `bundle exec rake install`.
|
1209
|
+
To release a new version, update the version number in `version.rb`, and then
|
1210
|
+
run `bundle exec rake release`, which will create a git tag for the version,
|
1211
|
+
push git commits and the created tag, and push the `.gem` file to
|
1212
|
+
https://rubygems.org[rubygems.org].
|
1851
1213
|
|
1214
|
+
== Contributing
|
1852
1215
|
|
1853
|
-
|
1216
|
+
Bug reports and pull requests are welcome on GitHub at
|
1217
|
+
https://github.com/relaton/w3c_api.
|
1854
1218
|
|
1855
|
-
|
1856
|
-
See the link:LICENSE.md[] file for details.
|
1219
|
+
== License
|
1857
1220
|
|
1858
|
-
|
1221
|
+
The gem is available as open source under the terms of the
|
1222
|
+
https://opensource.org/licenses/MIT[MIT License].
|