w3c_api 0.1.3 → 0.1.5
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.yml +16 -1
- data/.rubocop_todo.yml +23 -32
- data/README.adoc +297 -827
- data/Rakefile +3 -3
- data/demo/rate_limiting_demo.rb +135 -0
- data/demo/test_embed_functionality.rb +88 -0
- data/demo/test_improved_embed_functionality.rb +92 -0
- data/examples/rate_limiting_stress_test.rb +239 -0
- data/exe/w3c_api +1 -1
- data/lib/w3c_api/cli.rb +29 -28
- data/lib/w3c_api/client.rb +30 -7
- data/lib/w3c_api/commands/affiliation.rb +15 -12
- data/lib/w3c_api/commands/ecosystem.rb +22 -15
- data/lib/w3c_api/commands/group.rb +32 -25
- data/lib/w3c_api/commands/output_formatter.rb +1 -1
- data/lib/w3c_api/commands/participation.rb +11 -9
- data/lib/w3c_api/commands/series.rb +11 -9
- data/lib/w3c_api/commands/specification.rb +59 -45
- data/lib/w3c_api/commands/specification_version.rb +21 -12
- data/lib/w3c_api/commands/translation.rb +7 -6
- data/lib/w3c_api/commands/user.rb +36 -24
- data/lib/w3c_api/embed.rb +40 -0
- data/lib/w3c_api/hal.rb +374 -164
- data/lib/w3c_api/models/account.rb +3 -3
- data/lib/w3c_api/models/affiliation.rb +8 -7
- data/lib/w3c_api/models/affiliation_index.rb +3 -2
- data/lib/w3c_api/models/call_for_translation.rb +4 -3
- data/lib/w3c_api/models/chair_index.rb +2 -2
- data/lib/w3c_api/models/charter.rb +5 -5
- data/lib/w3c_api/models/charter_index.rb +3 -2
- data/lib/w3c_api/models/connected_account.rb +2 -2
- data/lib/w3c_api/models/deliverer_index.rb +3 -2
- data/lib/w3c_api/models/ecosystem.rb +8 -6
- data/lib/w3c_api/models/ecosystem_index.rb +3 -2
- data/lib/w3c_api/models/editor_index.rb +2 -2
- data/lib/w3c_api/models/evangelist_index.rb +3 -2
- data/lib/w3c_api/models/group.rb +16 -13
- data/lib/w3c_api/models/group_index.rb +2 -2
- data/lib/w3c_api/models/groups.rb +2 -2
- data/lib/w3c_api/models/participant_index.rb +3 -2
- data/lib/w3c_api/models/participation.rb +6 -5
- data/lib/w3c_api/models/participation_index.rb +3 -2
- data/lib/w3c_api/models/photo.rb +1 -1
- data/lib/w3c_api/models/serie.rb +6 -4
- data/lib/w3c_api/models/serie_index.rb +3 -2
- data/lib/w3c_api/models/spec_version.rb +10 -7
- data/lib/w3c_api/models/spec_version_index.rb +3 -2
- data/lib/w3c_api/models/spec_version_predecessor_index.rb +3 -2
- data/lib/w3c_api/models/spec_version_successor_index.rb +3 -2
- data/lib/w3c_api/models/specification.rb +17 -9
- data/lib/w3c_api/models/specification_index.rb +3 -2
- data/lib/w3c_api/models/team_contact_index.rb +3 -2
- data/lib/w3c_api/models/testimonial.rb +2 -2
- data/lib/w3c_api/models/translation.rb +4 -4
- data/lib/w3c_api/models/translation_index.rb +3 -2
- data/lib/w3c_api/models/user.rb +16 -11
- data/lib/w3c_api/models/user_index.rb +2 -2
- data/lib/w3c_api/models.rb +52 -37
- data/lib/w3c_api/version.rb +1 -1
- data/lib/w3c_api.rb +8 -7
- metadata +10 -19
data/README.adoc
CHANGED
@@ -11,27 +11,27 @@ A Ruby client implementation for the W3C web API with a CLI interface.
|
|
11
11
|
This gem provides:
|
12
12
|
|
13
13
|
* A complete client for the W3C API (oft-used endpoints implemented)
|
14
|
-
|
15
14
|
* Data models created with
|
16
15
|
https://github.com/lutaml/lutaml-hal[lutaml-hal] and
|
17
16
|
https://github.com/lutaml/lutaml-model[lutaml-model]
|
18
17
|
for all W3C API resources
|
19
|
-
|
20
|
-
|
21
|
-
|
18
|
+
* HAL (Hypertext Application Language) implementation for recursive resource
|
19
|
+
traversal
|
20
|
+
* Built-in rate limiting with exponential backoff for reliable API access
|
22
21
|
* A command-line interface using Thor following GitHub CLI patterns
|
23
22
|
|
24
23
|
The endpoint supported is at https://api.w3.org.
|
25
24
|
|
26
25
|
This gem is developed against the W3C API documented at https://api.w3.org/doc.
|
27
26
|
|
28
|
-
|
29
27
|
== Illustrative example usage
|
30
28
|
|
31
29
|
This is an example demonstrating the power of this library as inherited
|
32
30
|
from `lutaml-hal`, showing multiple levels of automatic link resolution.
|
33
31
|
|
34
32
|
.Calling the Ruby API with multiple levels of link resolution
|
33
|
+
[example]
|
34
|
+
====
|
35
35
|
[source,ruby]
|
36
36
|
----
|
37
37
|
> require 'w3c_api'
|
@@ -64,46 +64,167 @@ from `lutaml-hal`, showing multiple levels of automatic link resolution.
|
|
64
64
|
# @templated=nil,
|
65
65
|
# @title=nil,
|
66
66
|
# @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">>,
|
67
|
+
# ...>,
|
99
68
|
# @page=1,
|
100
69
|
# @pages=1,
|
101
70
|
# @total=1>
|
102
71
|
----
|
103
|
-
|
72
|
+
====
|
104
73
|
|
105
74
|
== Ruby API
|
106
75
|
|
76
|
+
=== Rate limiting
|
77
|
+
|
78
|
+
The W3C API client includes built-in rate limiting with exponential backoff to handle API rate limits gracefully. Rate limiting is enabled by default and works transparently with all API operations.
|
79
|
+
|
80
|
+
==== Quick start
|
81
|
+
|
82
|
+
[source,ruby]
|
83
|
+
----
|
84
|
+
require 'w3c_api'
|
85
|
+
|
86
|
+
# Rate limiting is enabled by default
|
87
|
+
client = W3cApi::Client.new
|
88
|
+
|
89
|
+
# Configure rate limiting if needed
|
90
|
+
W3cApi::Hal.instance.configure_rate_limiting(
|
91
|
+
max_retries: 5, # Maximum retry attempts
|
92
|
+
base_delay: 1.0, # Initial delay in seconds
|
93
|
+
max_delay: 60.0, # Maximum delay cap
|
94
|
+
backoff_factor: 2.0 # Exponential backoff multiplier
|
95
|
+
)
|
96
|
+
|
97
|
+
# Make requests - rate limiting works automatically
|
98
|
+
specifications = client.specifications
|
99
|
+
----
|
100
|
+
|
101
|
+
==== Demo and examples
|
102
|
+
|
103
|
+
To see rate limiting in action, run the included demonstration scripts:
|
104
|
+
|
105
|
+
[source,shell]
|
106
|
+
----
|
107
|
+
# Basic rate limiting demo
|
108
|
+
$ ruby demo/rate_limiting_demo.rb
|
109
|
+
|
110
|
+
# Advanced stress testing and performance analysis
|
111
|
+
$ ruby examples/rate_limiting_stress_test.rb
|
112
|
+
----
|
113
|
+
|
114
|
+
The demo script shows:
|
115
|
+
* Default rate limiting configuration
|
116
|
+
* Custom configuration examples
|
117
|
+
* Enabling/disabling rate limiting
|
118
|
+
* Status checking
|
119
|
+
|
120
|
+
The stress test example demonstrates:
|
121
|
+
* Rapid sequential requests
|
122
|
+
* Cross-endpoint performance analysis
|
123
|
+
* Dynamic configuration changes
|
124
|
+
* Bulk operation patterns
|
125
|
+
|
126
|
+
=== Embed support with auto-realize
|
127
|
+
|
128
|
+
==== General
|
129
|
+
|
130
|
+
The W3C API supports embedded content to reduce the number of HTTP requests
|
131
|
+
needed to fetch related resources. This gem provides comprehensive embed
|
132
|
+
support with automatic link realization for optimal performance.
|
133
|
+
|
134
|
+
[source,ruby]
|
135
|
+
----
|
136
|
+
require 'w3c_api'
|
137
|
+
|
138
|
+
# Create a client and use embed parameter directly
|
139
|
+
client = W3cApi::Client.new
|
140
|
+
|
141
|
+
# Fetch specifications with embedded content
|
142
|
+
specs = client.specifications(embed: true, items: 5)
|
143
|
+
|
144
|
+
# Fetch groups with embedded content
|
145
|
+
groups = client.groups(embed: true, items: 5)
|
146
|
+
|
147
|
+
# Fetch series with embedded content
|
148
|
+
series = client.series(embed: true, items: 5)
|
149
|
+
|
150
|
+
# Discover which endpoints support embed
|
151
|
+
supported_endpoints = W3cApi::Client.embed_supported_endpoints
|
152
|
+
# => [:group_index, :serie_index, :specification_index]
|
153
|
+
|
154
|
+
# Check if specific endpoint supports embed
|
155
|
+
client.embed_supported?(:specification_index) # => true
|
156
|
+
----
|
157
|
+
|
158
|
+
==== Auto-realize functionality
|
159
|
+
|
160
|
+
The gem features automatic embedded content detection that eliminates the need
|
161
|
+
to manually pass `parent_resource` parameters. Links automatically detect and
|
162
|
+
use embedded content when available, falling back to HTTP requests when needed.
|
163
|
+
|
164
|
+
[source,ruby]
|
165
|
+
----
|
166
|
+
# Fetch specifications with embed enabled
|
167
|
+
specs = client.specifications(embed: true, items: 5)
|
168
|
+
|
169
|
+
# Links automatically use embedded content - no parent_resource needed!
|
170
|
+
specs.links.specifications.each do |spec_link|
|
171
|
+
# This uses embedded data automatically - no HTTP request needed!
|
172
|
+
spec = spec_link.realize
|
173
|
+
puts "#{spec.title} - #{spec.shortname}"
|
174
|
+
end
|
175
|
+
|
176
|
+
# The auto-realize functionality works by:
|
177
|
+
# 1. Links store references to their parent resources automatically
|
178
|
+
# 2. Before making HTTP requests, links check for embedded data
|
179
|
+
# 3. If embedded content is available, it's used directly
|
180
|
+
# 4. If no embedded content exists, normal HTTP requests are made
|
181
|
+
----
|
182
|
+
|
183
|
+
==== Performance comparison
|
184
|
+
|
185
|
+
Using embed with auto-realize provides significant performance improvements:
|
186
|
+
|
187
|
+
[source,ruby]
|
188
|
+
----
|
189
|
+
# Without embed: 1 request for index + N requests for each specification
|
190
|
+
specs = client.specifications(items: 5)
|
191
|
+
specs.links.specifications.each do |spec_link|
|
192
|
+
spec = spec_link.realize # Each call makes an HTTP request
|
193
|
+
puts spec.title
|
194
|
+
end
|
195
|
+
# Total: 6 HTTP requests (1 + 5)
|
196
|
+
|
197
|
+
# With embed: 1 request total, embedded data used automatically
|
198
|
+
specs = client.specifications(embed: true, items: 5)
|
199
|
+
specs.links.specifications.each do |spec_link|
|
200
|
+
spec = spec_link.realize # Uses embedded data automatically!
|
201
|
+
puts spec.title
|
202
|
+
end
|
203
|
+
# Total: 1 HTTP request only
|
204
|
+
----
|
205
|
+
|
206
|
+
==== Embed discovery
|
207
|
+
|
208
|
+
The gem provides methods to discover embed capabilities:
|
209
|
+
|
210
|
+
[source,ruby]
|
211
|
+
----
|
212
|
+
# Get list of endpoints that support embed
|
213
|
+
W3cApi::Client.embed_supported_endpoints
|
214
|
+
# => [:group_index, :serie_index, :specification_index]
|
215
|
+
|
216
|
+
# Check if specific endpoint supports embed
|
217
|
+
client.embed_supported?(:specification_index) # => true
|
218
|
+
client.embed_supported?(:specification_resource) # => false
|
219
|
+
|
220
|
+
# Get comprehensive embed information
|
221
|
+
embed_info = W3cApi::Embed.embed_info
|
222
|
+
puts embed_info[:supported_endpoints]
|
223
|
+
puts embed_info[:descriptions]
|
224
|
+
puts embed_info[:usage_example]
|
225
|
+
----
|
226
|
+
|
227
|
+
|
107
228
|
=== General
|
108
229
|
|
109
230
|
[source,ruby]
|
@@ -238,7 +359,6 @@ ecosystem = client.ecosystem('data')
|
|
238
359
|
This library provides models for various W3C API resources under the
|
239
360
|
`W3cApi::Models` namespace.
|
240
361
|
|
241
|
-
|
242
362
|
==== Affiliation
|
243
363
|
|
244
364
|
The `W3cApi::Models::Affiliation` represents a W3C affiliation model that
|
@@ -247,6 +367,7 @@ includes various attributes and methods to interact with affiliated entities.
|
|
247
367
|
.Fetching the affiliation index
|
248
368
|
[example]
|
249
369
|
====
|
370
|
+
|
250
371
|
[source,ruby]
|
251
372
|
----
|
252
373
|
> W3cApi::Hal.instance.register.fetch(:affiliation_index)
|
@@ -286,6 +407,7 @@ includes various attributes and methods to interact with affiliated entities.
|
|
286
407
|
.Fetching a specific affiliation
|
287
408
|
[example]
|
288
409
|
====
|
410
|
+
|
289
411
|
[source,ruby]
|
290
412
|
----
|
291
413
|
> W3cApi::Hal.instance.register.fetch(:affiliation_resource, id: 35662)
|
@@ -298,8 +420,6 @@ includes various attributes and methods to interact with affiliated entities.
|
|
298
420
|
----
|
299
421
|
====
|
300
422
|
|
301
|
-
|
302
|
-
|
303
423
|
== Command line interface
|
304
424
|
|
305
425
|
=== General
|
@@ -308,8 +428,8 @@ W3C API provides a command-line interface (CLI) for various operations.
|
|
308
428
|
|
309
429
|
The main executable is `w3c_api`.
|
310
430
|
|
311
|
-
By default, the output is in YAML format. You can specify the output format
|
312
|
-
`--format` option, which accepts `json` or `yaml`.
|
431
|
+
By default, the output is in YAML format. You can specify the output format
|
432
|
+
using the `--format` option, which accepts `json` or `yaml`.
|
313
433
|
|
314
434
|
[source,shell]
|
315
435
|
----
|
@@ -407,7 +527,6 @@ _links:
|
|
407
527
|
----
|
408
528
|
====
|
409
529
|
|
410
|
-
|
411
530
|
==== Versions
|
412
531
|
|
413
532
|
This command provides access to W3C specification versions given a shortname.
|
@@ -601,8 +720,8 @@ specifications:
|
|
601
720
|
|
602
721
|
This command provides access to W3C users.
|
603
722
|
|
604
|
-
[IMPORTANT]
|
605
723
|
.User ID formats
|
724
|
+
[IMPORTANT]
|
606
725
|
====
|
607
726
|
The W3C API uses both numeric IDs (e.g., `128112`) and string IDs (e.g.,
|
608
727
|
`f1ovb5rydm8s0go04oco0cgk0sow44w`) for users. All user-related commands
|
@@ -789,76 +908,9 @@ participations:
|
|
789
908
|
href: https://api.w3.org/participations/38783
|
790
909
|
- title: Positive Work Environment Community Group
|
791
910
|
href: https://api.w3.org/participations/38784
|
792
|
-
- title: Web Performance Working Group
|
793
|
-
href: https://api.w3.org/participations/38786
|
794
|
-
- title: Spatio-temporal Data on the Web Working Group
|
795
|
-
href: https://api.w3.org/participations/44558
|
796
|
-
- title: W3C Process Community Group
|
797
|
-
href: https://api.w3.org/participations/39267
|
798
|
-
- title: Equity Community Group
|
799
|
-
href: https://api.w3.org/participations/39352
|
800
|
-
- title: Web Components Community Group
|
801
|
-
href: https://api.w3.org/participations/40553
|
802
|
-
- title: Accessible Platform Architectures Working Group
|
803
|
-
href: https://api.w3.org/participations/36682
|
804
|
-
- title: Sustainability Community Group
|
805
|
-
href: https://api.w3.org/participations/41861
|
806
|
-
- title: Web Applications Working Group
|
807
|
-
href: https://api.w3.org/participations/43789
|
808
|
-
- title: Accessibility Internationalization Community Group
|
809
|
-
href: https://api.w3.org/participations/43788
|
810
|
-
- title: Sustainable Web Interest Group
|
811
|
-
href: https://api.w3.org/participations/44152
|
812
|
-
----
|
813
|
-
====
|
814
|
-
|
815
|
-
==== Chair of groups
|
816
|
-
|
817
|
-
Getting groups a user chairs.
|
818
|
-
|
819
|
-
[source,shell]
|
820
|
-
----
|
821
|
-
# Fetch groups a user chairs
|
822
|
-
$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
823
|
-
----
|
824
|
-
|
825
|
-
[example]
|
826
|
-
====
|
827
|
-
[source,shell]
|
828
|
-
----
|
829
|
-
$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
830
|
-
---
|
831
|
-
groups:
|
832
|
-
- href: https://api.w3.org/groups/cg/equity
|
833
|
-
title: Equity Community Group
|
834
911
|
----
|
835
912
|
====
|
836
913
|
|
837
|
-
==== Team Contact of Groups
|
838
|
-
|
839
|
-
Getting groups a user is a team contact of.
|
840
|
-
|
841
|
-
[source,shell]
|
842
|
-
----
|
843
|
-
# Fetch groups a user is a team contact of
|
844
|
-
$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
845
|
-
----
|
846
|
-
|
847
|
-
[example]
|
848
|
-
====
|
849
|
-
[source,shell]
|
850
|
-
----
|
851
|
-
$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
|
852
|
-
groups:
|
853
|
-
- name: Web Platform Working Group
|
854
|
-
href: https://api.w3.org/groups/72825
|
855
|
-
- name: Internationalization Working Group
|
856
|
-
href: https://api.w3.org/groups/32113
|
857
|
-
# Additional groups omitted for brevity
|
858
|
-
----
|
859
|
-
====
|
860
|
-
|
861
|
-
|
862
914
|
=== Groups
|
863
915
|
|
864
916
|
This command provides access to W3C groups.
|
@@ -880,14 +932,10 @@ $ w3c_api group fetch [OPTIONS]
|
|
880
932
|
$ w3c_api group fetch
|
881
933
|
---
|
882
934
|
groups:
|
883
|
-
- href: https://api.w3.org/groups/
|
884
|
-
title:
|
885
|
-
- href: https://api.w3.org/groups/cg/
|
886
|
-
title: Accessibility
|
887
|
-
- href: https://api.w3.org/groups/tf/wcag-act
|
888
|
-
title: Accessibility Conformance Testing (ACT) Task Force
|
889
|
-
- href: https://api.w3.org/groups/cg/a11y-discov-vocab
|
890
|
-
title: Accessibility Discoverability Vocabulary for Schema.org Community Group
|
935
|
+
- href: https://api.w3.org/groups/wg/ag
|
936
|
+
title: Accessibility Guidelines Working Group
|
937
|
+
- href: https://api.w3.org/groups/cg/global-inclusion
|
938
|
+
title: Accessibility Internationalization Community Group
|
891
939
|
# Additional groups omitted for brevity
|
892
940
|
----
|
893
941
|
====
|
@@ -906,293 +954,167 @@ $ w3c_api group fetch --id=109735
|
|
906
954
|
====
|
907
955
|
[source,shell]
|
908
956
|
----
|
957
|
+
$ w3c_api group fetch --id=109735
|
909
958
|
---
|
910
959
|
id: 109735
|
911
960
|
name: Immersive Web Working Group
|
912
|
-
type: working group
|
913
|
-
description: The mission of the Immersive Web Working Group is to help bring high-performance
|
914
|
-
Virtual Reality (VR) and Augmented Reality (AR) (collectively known as XR) to the
|
915
|
-
open Web via APIs to interact with XR devices and sensors in browsers.
|
916
961
|
shortname: immersive-web
|
917
|
-
|
918
|
-
start_date: '2018-
|
919
|
-
end_date: '
|
920
|
-
|
962
|
+
type: working group
|
963
|
+
start_date: '2018-10-01'
|
964
|
+
end_date: '2020-09-30'
|
965
|
+
description: The mission of the Immersive Web Working Group is to help bring
|
966
|
+
high-performance Virtual Reality (VR) and Augmented Reality (AR) to the open Web
|
967
|
+
via APIs to interact with VR and AR devices and sensors in browsers.
|
921
968
|
_links:
|
922
969
|
self:
|
923
970
|
href: https://api.w3.org/groups/wg/immersive-web
|
924
|
-
|
925
|
-
href: https://
|
926
|
-
|
927
|
-
|
928
|
-
|
929
|
-
==== Chairs
|
930
|
-
|
931
|
-
Fetching chairs for a group.
|
932
|
-
|
933
|
-
[source,shell]
|
934
|
-
----
|
935
|
-
# Fetch chairs for a group
|
936
|
-
$ w3c_api group chairs --id={id}
|
937
|
-
----
|
938
|
-
|
939
|
-
[example]
|
940
|
-
====
|
941
|
-
[source,shell]
|
942
|
-
----
|
943
|
-
$ w3c_api group chairs --id=109735
|
944
|
-
---
|
945
|
-
_links:
|
946
|
-
self:
|
947
|
-
href: https://api.w3.org/groups/109735/chairs?page=1&items=100
|
948
|
-
type: W3cApi::Models::ChairIndex
|
949
|
-
first:
|
950
|
-
href: https://api.w3.org/groups/109735/chairs?page=1&items=100
|
951
|
-
type: W3cApi::Models::ChairIndex
|
952
|
-
last:
|
953
|
-
href: https://api.w3.org/groups/109735/chairs?page=1&items=100
|
954
|
-
type: W3cApi::Models::ChairIndex
|
955
|
-
up:
|
956
|
-
href: https://api.w3.org/groups/109735
|
957
|
-
type: W3cApi::Models::ChairIndex
|
971
|
+
users:
|
972
|
+
href: https://api.w3.org/groups/109735/users
|
973
|
+
specifications:
|
974
|
+
href: https://api.w3.org/groups/109735/specifications
|
958
975
|
chairs:
|
959
|
-
|
960
|
-
|
961
|
-
|
962
|
-
|
963
|
-
|
964
|
-
type: User
|
965
|
-
- href: https://api.w3.org/users/m99jqkpi9m8oww84kw4gwccgc4g0ogs
|
966
|
-
title: Ayşegül Yönet
|
967
|
-
type: User
|
976
|
+
href: https://api.w3.org/groups/109735/chairs
|
977
|
+
team_contacts:
|
978
|
+
href: https://api.w3.org/groups/109735/teamcontacts
|
979
|
+
charters:
|
980
|
+
href: https://api.w3.org/groups/109735/charters
|
968
981
|
----
|
969
982
|
====
|
970
983
|
|
971
|
-
====
|
984
|
+
==== Users
|
972
985
|
|
973
|
-
|
986
|
+
Getting users in a group.
|
974
987
|
|
975
988
|
[source,shell]
|
976
989
|
----
|
977
|
-
# Fetch
|
978
|
-
$ w3c_api group
|
990
|
+
# Fetch users in a group
|
991
|
+
$ w3c_api group users --id=109735
|
979
992
|
----
|
980
993
|
|
981
994
|
[example]
|
982
995
|
====
|
983
996
|
[source,shell]
|
984
997
|
----
|
985
|
-
$ w3c_api group
|
998
|
+
$ w3c_api group users --id=109735
|
986
999
|
---
|
987
|
-
|
988
|
-
|
989
|
-
|
990
|
-
|
991
|
-
|
992
|
-
|
993
|
-
type: W3cApi::Models::TeamContactIndex
|
994
|
-
last:
|
995
|
-
href: https://api.w3.org/groups/109735/teamcontacts?page=1&items=100
|
996
|
-
type: W3cApi::Models::TeamContactIndex
|
997
|
-
up:
|
998
|
-
href: https://api.w3.org/groups/109735
|
999
|
-
type: W3cApi::Models::TeamContactIndex
|
1000
|
-
team-contacts:
|
1001
|
-
- href: https://api.w3.org/users/1eb2xr7ab6zo0k8440o48swso408ksc
|
1002
|
-
title: Atsushi Shimono
|
1003
|
-
type: User
|
1000
|
+
users:
|
1001
|
+
- href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w
|
1002
|
+
title: Jennifer Strickland
|
1003
|
+
- href: https://api.w3.org/users/bzb5w20eg68k40gc8w0wg0okk4k84os
|
1004
|
+
title: Cullen Jennings
|
1005
|
+
# Additional users omitted for brevity
|
1004
1006
|
----
|
1005
1007
|
====
|
1006
1008
|
|
1007
|
-
====
|
1009
|
+
==== Specifications
|
1008
1010
|
|
1009
|
-
|
1011
|
+
Getting specifications delivered by a group.
|
1010
1012
|
|
1011
1013
|
[source,shell]
|
1012
1014
|
----
|
1013
|
-
# Fetch
|
1014
|
-
$ w3c_api group
|
1015
|
+
# Fetch specifications delivered by a group
|
1016
|
+
$ w3c_api group specifications --id=109735
|
1015
1017
|
----
|
1016
1018
|
|
1017
1019
|
[example]
|
1018
1020
|
====
|
1019
1021
|
[source,shell]
|
1020
1022
|
----
|
1021
|
-
$ w3c_api group
|
1023
|
+
$ w3c_api group specifications --id=109735
|
1022
1024
|
---
|
1023
|
-
|
1024
|
-
|
1025
|
-
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
type: ParticipationIndex
|
1030
|
-
last:
|
1031
|
-
href: https://api.w3.org/groups/109735/participations?page=1&items=100
|
1032
|
-
type: ParticipationIndex
|
1033
|
-
up:
|
1034
|
-
href: https://api.w3.org/groups/109735
|
1035
|
-
type: ParticipationIndex
|
1036
|
-
participations:
|
1037
|
-
- href: https://api.w3.org/participations/43367
|
1038
|
-
title: Kodansha, Publishers, Ltd.
|
1039
|
-
type: Participation
|
1040
|
-
- href: https://api.w3.org/participations/43368
|
1041
|
-
title: Institut National de Recherche en Informatique et en Automatique (Inria)
|
1042
|
-
type: Participation
|
1043
|
-
- href: https://api.w3.org/participations/43391
|
1044
|
-
title: Igalia
|
1045
|
-
type: Participation
|
1046
|
-
- href: https://api.w3.org/participations/43415
|
1047
|
-
title: Christine Perey
|
1048
|
-
type: Participation
|
1025
|
+
specifications:
|
1026
|
+
- title: WebXR Device API
|
1027
|
+
href: https://api.w3.org/specifications/webxr
|
1028
|
+
- title: WebXR Gamepads Module - Level 1
|
1029
|
+
href: https://api.w3.org/specifications/webxr-gamepads-1
|
1030
|
+
# Additional specifications omitted for brevity
|
1049
1031
|
----
|
1050
1032
|
====
|
1051
1033
|
|
1034
|
+
=== Affiliations
|
1052
1035
|
|
1053
|
-
|
1036
|
+
This command provides access to W3C affiliations.
|
1054
1037
|
|
1055
|
-
|
1038
|
+
==== Index
|
1039
|
+
|
1040
|
+
Fetching an index of affiliations.
|
1056
1041
|
|
1057
1042
|
[source,shell]
|
1058
1043
|
----
|
1059
|
-
# Fetch
|
1060
|
-
$ w3c_api
|
1044
|
+
# Fetch affiliations
|
1045
|
+
$ w3c_api affiliation fetch [OPTIONS]
|
1061
1046
|
----
|
1062
1047
|
|
1063
1048
|
[example]
|
1064
1049
|
====
|
1065
1050
|
[source,shell]
|
1066
1051
|
----
|
1067
|
-
$ w3c_api
|
1052
|
+
$ w3c_api affiliation fetch
|
1068
1053
|
---
|
1069
|
-
|
1070
|
-
|
1071
|
-
|
1072
|
-
|
1073
|
-
|
1074
|
-
|
1075
|
-
type: SpecificationIndex
|
1076
|
-
last:
|
1077
|
-
href: https://api.w3.org/groups/109735/specifications?page=1&items=100
|
1078
|
-
type: SpecificationIndex
|
1079
|
-
up:
|
1080
|
-
href: https://api.w3.org/groups/109735
|
1081
|
-
type: SpecificationIndex
|
1082
|
-
specifications:
|
1083
|
-
- href: https://api.w3.org/specifications/webxr-lighting-estimation-1
|
1084
|
-
title: WebXR Lighting Estimation API Level 1
|
1085
|
-
type: Specification
|
1086
|
-
- href: https://api.w3.org/specifications/webxr-gamepads-module-1
|
1087
|
-
title: WebXR Gamepads Module - Level 1
|
1088
|
-
type: Specification
|
1089
|
-
- href: https://api.w3.org/specifications/webxr-hand-input-1
|
1090
|
-
title: WebXR Hand Input Module - Level 1
|
1091
|
-
type: Specification
|
1092
|
-
- href: https://api.w3.org/specifications/webxr-hit-test-1
|
1093
|
-
title: WebXR Hit Test Module
|
1094
|
-
type: Specification
|
1095
|
-
- href: https://api.w3.org/specifications/webxr-dom-overlays-1
|
1096
|
-
title: WebXR DOM Overlays Module
|
1097
|
-
type: Specification
|
1054
|
+
affiliations:
|
1055
|
+
- href: https://api.w3.org/affiliations/1001
|
1056
|
+
title: Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)
|
1057
|
+
- href: https://api.w3.org/affiliations/1003
|
1058
|
+
title: BackWeb Technologies, Inc.
|
1059
|
+
# Additional affiliations omitted for brevity
|
1098
1060
|
----
|
1099
1061
|
====
|
1100
1062
|
|
1101
|
-
====
|
1063
|
+
==== Get
|
1102
1064
|
|
1103
|
-
|
1065
|
+
Getting an affiliation by ID.
|
1104
1066
|
|
1105
1067
|
[source,shell]
|
1106
1068
|
----
|
1107
|
-
# Fetch
|
1108
|
-
$ w3c_api
|
1069
|
+
# Fetch an affiliation
|
1070
|
+
$ w3c_api affiliation fetch --id=35662
|
1109
1071
|
----
|
1110
1072
|
|
1111
1073
|
[example]
|
1112
1074
|
====
|
1113
1075
|
[source,shell]
|
1114
1076
|
----
|
1115
|
-
$ w3c_api
|
1077
|
+
$ w3c_api affiliation fetch --id=35662
|
1116
1078
|
---
|
1079
|
+
id: 35662
|
1080
|
+
name: Google LLC
|
1081
|
+
discr: organization
|
1117
1082
|
_links:
|
1118
1083
|
self:
|
1119
|
-
href: https://api.w3.org/
|
1120
|
-
|
1121
|
-
|
1122
|
-
|
1123
|
-
|
1124
|
-
last:
|
1125
|
-
href: https://api.w3.org/groups/109735/users?page=1&items=100
|
1126
|
-
type: UserIndex
|
1127
|
-
up:
|
1128
|
-
href: https://api.w3.org/groups/109735
|
1129
|
-
type: UserIndex
|
1130
|
-
users:
|
1131
|
-
- href: https://api.w3.org/users/9o1jsmhi8ysk088w0k4g00wsssk4c8c
|
1132
|
-
title: Muadh Al Kalbani
|
1133
|
-
type: User
|
1134
|
-
- href: https://api.w3.org/users/rqjspzlmiq8c0kk8goos4c480w8wccs
|
1135
|
-
title: Matthew Atkinson
|
1136
|
-
type: User
|
1137
|
-
- href: https://api.w3.org/users/32hnccz98a68sk0kcog8c4wo4sgckkw
|
1138
|
-
title: Ashwin Balasubramaniyan
|
1139
|
-
type: User
|
1140
|
-
- href: https://api.w3.org/users/ff80kfl6a0gso4oo8s40cg4c4wccgs0
|
1141
|
-
title: Trevor Baron
|
1142
|
-
type: User
|
1084
|
+
href: https://api.w3.org/affiliations/35662
|
1085
|
+
participants:
|
1086
|
+
href: https://api.w3.org/affiliations/35662/participants
|
1087
|
+
participations:
|
1088
|
+
href: https://api.w3.org/affiliations/35662/participations
|
1143
1089
|
----
|
1144
1090
|
====
|
1145
1091
|
|
1146
|
-
====
|
1092
|
+
==== Participants
|
1147
1093
|
|
1148
|
-
|
1094
|
+
Getting participants of an affiliation.
|
1149
1095
|
|
1150
1096
|
[source,shell]
|
1151
1097
|
----
|
1152
|
-
# Fetch
|
1153
|
-
$ w3c_api
|
1098
|
+
# Fetch participants of an affiliation
|
1099
|
+
$ w3c_api affiliation participants --id=35662
|
1154
1100
|
----
|
1155
1101
|
|
1156
1102
|
[example]
|
1157
1103
|
====
|
1158
1104
|
[source,shell]
|
1159
1105
|
----
|
1160
|
-
$ w3c_api
|
1106
|
+
$ w3c_api affiliation participants --id=35662
|
1161
1107
|
---
|
1162
|
-
|
1163
|
-
|
1164
|
-
|
1165
|
-
|
1166
|
-
|
1167
|
-
|
1168
|
-
type: W3cApi::Models::CharterIndex
|
1169
|
-
last:
|
1170
|
-
href: https://api.w3.org/groups/109735/charters?page=1&items=100
|
1171
|
-
type: W3cApi::Models::CharterIndex
|
1172
|
-
up:
|
1173
|
-
href: https://api.w3.org/groups/109735
|
1174
|
-
type: W3cApi::Models::CharterIndex
|
1175
|
-
charters:
|
1176
|
-
- href: https://api.w3.org/groups/109735/charters/361
|
1177
|
-
title: 2018-09-24 -> 2020-03-01
|
1178
|
-
type: Charter
|
1179
|
-
- href: https://api.w3.org/groups/109735/charters/405
|
1180
|
-
title: 2020-05-12 -> 2022-06-01
|
1181
|
-
type: Charter
|
1182
|
-
- href: https://api.w3.org/groups/109735/charters/464
|
1183
|
-
title: 2022-07-08 -> 2024-07-07
|
1184
|
-
type: Charter
|
1185
|
-
- href: https://api.w3.org/groups/109735/charters/514
|
1186
|
-
title: 2024-09-26 -> 2026-09-25
|
1187
|
-
type: Charter
|
1188
|
-
page: 1
|
1189
|
-
limit: 100
|
1190
|
-
pages: 1
|
1191
|
-
total: 4
|
1108
|
+
participants:
|
1109
|
+
- href: https://api.w3.org/users/bzb5w20eg68k40gc8w0wg0okk4k84os
|
1110
|
+
title: Cullen Jennings
|
1111
|
+
- href: https://api.w3.org/users/f521yr1m6g0kks880s8ocwsgwskgss4
|
1112
|
+
title: Jan-Ivar Bruaroey
|
1113
|
+
# Additional participants omitted for brevity
|
1192
1114
|
----
|
1193
1115
|
====
|
1194
1116
|
|
1195
|
-
===
|
1117
|
+
=== Translations
|
1196
1118
|
|
1197
1119
|
This command provides access to W3C translations.
|
1198
1120
|
|
@@ -1205,38 +1127,19 @@ Fetching an index of translations.
|
|
1205
1127
|
# Fetch translations
|
1206
1128
|
$ w3c_api translation fetch [OPTIONS]
|
1207
1129
|
----
|
1130
|
+
|
1208
1131
|
[example]
|
1209
1132
|
====
|
1210
1133
|
[source,shell]
|
1211
1134
|
----
|
1212
1135
|
$ w3c_api translation fetch
|
1213
1136
|
---
|
1214
|
-
|
1215
|
-
|
1216
|
-
|
1217
|
-
|
1218
|
-
|
1219
|
-
|
1220
|
-
type: TranslationIndex
|
1221
|
-
first:
|
1222
|
-
href: https://api.w3.org/translations?page=1&items=100
|
1223
|
-
type: TranslationIndex
|
1224
|
-
last:
|
1225
|
-
href: https://api.w3.org/translations?page=7&items=100
|
1226
|
-
type: TranslationIndex
|
1227
|
-
translations:
|
1228
|
-
- href: https://api.w3.org/translations/2
|
1229
|
-
title: 'Vidéo : introduction à l’accessibilité web et aux standards du W3C'
|
1230
|
-
type: Translation
|
1231
|
-
- href: https://api.w3.org/translations/3
|
1232
|
-
title: Vídeo de Introducción a la Accesibilidad Web y Estándares del W3C
|
1233
|
-
type: Translation
|
1234
|
-
- href: https://api.w3.org/translations/4
|
1235
|
-
title: Video-introductie over Web-toegankelijkheid en W3C-standaarden
|
1236
|
-
type: Translation
|
1237
|
-
- href: https://api.w3.org/translations/5
|
1238
|
-
title: 网页无障碍和W3C标准的介绍视频
|
1239
|
-
type: Translation
|
1137
|
+
translations:
|
1138
|
+
- href: https://api.w3.org/translations/1
|
1139
|
+
title: HTML 4.01 Specification
|
1140
|
+
- href: https://api.w3.org/translations/2
|
1141
|
+
title: Cascading Style Sheets, level 1
|
1142
|
+
# Additional translations omitted for brevity
|
1240
1143
|
----
|
1241
1144
|
====
|
1242
1145
|
|
@@ -1247,121 +1150,51 @@ Getting a translation by ID.
|
|
1247
1150
|
[source,shell]
|
1248
1151
|
----
|
1249
1152
|
# Fetch a translation
|
1250
|
-
$ w3c_api translation fetch --id=
|
1153
|
+
$ w3c_api translation fetch --id=2
|
1251
1154
|
----
|
1252
1155
|
|
1253
1156
|
[example]
|
1254
1157
|
====
|
1255
1158
|
[source,shell]
|
1256
1159
|
----
|
1257
|
-
$ w3c_api translation fetch --id=
|
1160
|
+
$ w3c_api translation fetch --id=2
|
1258
1161
|
---
|
1162
|
+
id: 2
|
1163
|
+
title: Cascading Style Sheets, level 1
|
1164
|
+
language: fr
|
1165
|
+
url: https://www.yoyodesign.org/doc/w3c/css1/index.html
|
1259
1166
|
_links:
|
1260
1167
|
self:
|
1261
|
-
href: https://api.w3.org/translations/
|
1262
|
-
type: Translation
|
1263
|
-
uri: http://maujor.com/w3c/xml-base.html
|
1264
|
-
title: XML Base
|
1265
|
-
language: pt_BR
|
1266
|
-
published: '2005-09-23T00:00:00+00:00'
|
1267
|
-
authorized: false
|
1268
|
-
call-for-translation:
|
1269
|
-
_links:
|
1270
|
-
self:
|
1271
|
-
href: https://api.w3.org/callsfortranslation/28
|
1272
|
-
type: CallForTranslation
|
1273
|
-
translations:
|
1274
|
-
href: https://api.w3.org/callsfortranslation/28/translations
|
1275
|
-
type: TranslationIndex
|
1276
|
-
title: XML Base
|
1277
|
-
states:
|
1278
|
-
- published
|
1279
|
-
translators:
|
1280
|
-
- _links:
|
1281
|
-
self:
|
1282
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48
|
1283
|
-
type: User
|
1284
|
-
affiliations:
|
1285
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/affiliations
|
1286
|
-
type: W3cApi::Models::AffiliationIndex
|
1287
|
-
groups:
|
1288
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/groups
|
1289
|
-
type: GroupIndex
|
1290
|
-
specifications:
|
1291
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/specifications
|
1292
|
-
type: SpecificationIndex
|
1293
|
-
participations:
|
1294
|
-
href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/participations
|
1295
|
-
type: ParticipationIndex
|
1296
|
-
id: '112282'
|
1297
|
-
name: Maurício Samy Silva
|
1298
|
-
given: Maurício
|
1299
|
-
family: Samy Silva
|
1300
|
-
discr: user
|
1168
|
+
href: https://api.w3.org/translations/2
|
1301
1169
|
----
|
1302
1170
|
====
|
1303
1171
|
|
1304
|
-
|
1305
|
-
=== Ecosystem
|
1172
|
+
=== Ecosystems
|
1306
1173
|
|
1307
1174
|
This command provides access to W3C ecosystems.
|
1308
1175
|
|
1309
1176
|
==== Index
|
1310
1177
|
|
1311
1178
|
Fetching an index of ecosystems.
|
1179
|
+
|
1312
1180
|
[source,shell]
|
1313
1181
|
----
|
1314
1182
|
# Fetch ecosystems
|
1315
1183
|
$ w3c_api ecosystem fetch [OPTIONS]
|
1316
1184
|
----
|
1185
|
+
|
1317
1186
|
[example]
|
1318
1187
|
====
|
1319
1188
|
[source,shell]
|
1320
1189
|
----
|
1321
1190
|
$ w3c_api ecosystem fetch
|
1322
1191
|
---
|
1323
|
-
|
1324
|
-
|
1325
|
-
|
1326
|
-
|
1327
|
-
|
1328
|
-
|
1329
|
-
type: W3cApi::Models::EcosystemIndex
|
1330
|
-
last:
|
1331
|
-
href: https://api.w3.org/ecosystems?embed=0&page=1&items=100
|
1332
|
-
type: W3cApi::Models::EcosystemIndex
|
1333
|
-
ecosystems:
|
1334
|
-
- href: https://api.w3.org/ecosystems/advertising
|
1335
|
-
title: Web Advertising
|
1336
|
-
type: Ecosystem
|
1337
|
-
- href: https://api.w3.org/ecosystems/e-commerce
|
1338
|
-
title: E-commerce
|
1339
|
-
type: Ecosystem
|
1340
|
-
- href: https://api.w3.org/ecosystems/media
|
1341
|
-
title: Media & Entertainment
|
1342
|
-
type: Ecosystem
|
1343
|
-
- href: https://api.w3.org/ecosystems/network-communications
|
1344
|
-
title: Network & Communications
|
1345
|
-
type: Ecosystem
|
1346
|
-
- href: https://api.w3.org/ecosystems/publishing
|
1347
|
-
title: Publishing
|
1348
|
-
type: Ecosystem
|
1349
|
-
- href: https://api.w3.org/ecosystems/smart-cities
|
1350
|
-
title: Smart Cities
|
1351
|
-
type: Ecosystem
|
1352
|
-
- href: https://api.w3.org/ecosystems/automotive-transportation
|
1353
|
-
title: Automotive & Transportation
|
1354
|
-
type: Ecosystem
|
1355
|
-
- href: https://api.w3.org/ecosystems/web-of-things
|
1356
|
-
title: Web of Things
|
1357
|
-
type: Ecosystem
|
1358
|
-
- href: https://api.w3.org/ecosystems/data
|
1359
|
-
title: Data and knowledge
|
1360
|
-
type: Ecosystem
|
1361
|
-
page: 1
|
1362
|
-
limit: 100
|
1363
|
-
pages: 1
|
1364
|
-
total: 9
|
1192
|
+
ecosystems:
|
1193
|
+
- shortname: advertising
|
1194
|
+
name: Advertising
|
1195
|
+
- shortname: data
|
1196
|
+
name: Data
|
1197
|
+
# Additional ecosystems omitted for brevity
|
1365
1198
|
----
|
1366
1199
|
====
|
1367
1200
|
|
@@ -1372,7 +1205,7 @@ Getting an ecosystem by shortname.
|
|
1372
1205
|
[source,shell]
|
1373
1206
|
----
|
1374
1207
|
# Fetch an ecosystem
|
1375
|
-
$ w3c_api ecosystem fetch --shortname=
|
1208
|
+
$ w3c_api ecosystem fetch --shortname=data
|
1376
1209
|
----
|
1377
1210
|
|
1378
1211
|
[example]
|
@@ -1381,423 +1214,60 @@ $ w3c_api ecosystem fetch --shortname={shortname}
|
|
1381
1214
|
----
|
1382
1215
|
$ w3c_api ecosystem fetch --shortname=data
|
1383
1216
|
---
|
1217
|
+
shortname: data
|
1218
|
+
name: Data
|
1219
|
+
description: The Data ecosystem focuses on technologies and standards for
|
1220
|
+
representing, exchanging, and processing data on the Web.
|
1384
1221
|
_links:
|
1385
1222
|
self:
|
1386
1223
|
href: https://api.w3.org/ecosystems/data
|
1387
|
-
type: Ecosystem
|
1388
|
-
champion:
|
1389
|
-
href: https://api.w3.org/users/t891ludoisggsccsw44o8goccc0s0ks
|
1390
|
-
title: Pierre-Antoine Champin
|
1391
|
-
type: User
|
1392
|
-
evangelists:
|
1393
|
-
href: https://api.w3.org/ecosystems/data/evangelists
|
1394
|
-
type: EvangelistIndex
|
1395
1224
|
groups:
|
1396
1225
|
href: https://api.w3.org/ecosystems/data/groups
|
1397
|
-
type: GroupIndex
|
1398
|
-
member-organizations:
|
1399
|
-
href: https://api.w3.org/ecosystems/data/member-organizations
|
1400
|
-
type: W3cApi::Models::AffiliationIndex
|
1401
|
-
name: Data and knowledge
|
1402
|
-
shortname: data
|
1403
|
-
----
|
1404
|
-
====
|
1405
|
-
|
1406
|
-
==== Evangelists
|
1407
|
-
|
1408
|
-
Getting evangelists for an ecosystem.
|
1409
|
-
|
1410
|
-
[source,shell]
|
1411
|
-
----
|
1412
|
-
# Fetch evangelists for an ecosystem
|
1413
|
-
$ w3c_api ecosystem evangelists --shortname={shortname}
|
1414
|
-
----
|
1415
|
-
[example]
|
1416
|
-
====
|
1417
|
-
[source,shell]
|
1418
|
-
----
|
1419
|
-
$ w3c_api ecosystem evangelists --shortname=publishing
|
1420
|
-
---
|
1421
|
-
_links:
|
1422
|
-
self:
|
1423
|
-
href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
|
1424
|
-
type: EvangelistIndex
|
1425
|
-
first:
|
1426
|
-
href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
|
1427
|
-
type: EvangelistIndex
|
1428
|
-
last:
|
1429
|
-
href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
|
1430
|
-
type: EvangelistIndex
|
1431
|
-
up:
|
1432
|
-
href: https://api.w3.org/ecosystems/publishing
|
1433
|
-
type: EvangelistIndex
|
1434
1226
|
evangelists:
|
1435
|
-
|
1436
|
-
title: Bill Kasdorf
|
1437
|
-
type: User
|
1438
|
-
- href: https://api.w3.org/users/a5eur9p2iyo0ws00448w4gcw4c8sock
|
1439
|
-
title: Daihei Shiohama
|
1440
|
-
type: User
|
1441
|
-
- href: https://api.w3.org/users/qdkk81rtp344c44g0osoocgwwc8o4ss
|
1442
|
-
title: Bobby Tung
|
1443
|
-
type: User
|
1444
|
-
page: 1
|
1445
|
-
limit: 100
|
1446
|
-
pages: 1
|
1447
|
-
total: 3
|
1448
|
-
----
|
1449
|
-
====
|
1450
|
-
|
1451
|
-
==== Groups
|
1452
|
-
|
1453
|
-
Getting groups for an ecosystem.
|
1454
|
-
|
1455
|
-
[source,shell]
|
1456
|
-
----
|
1457
|
-
# Fetch groups for an ecosystem
|
1458
|
-
$ w3c_api ecosystem groups --shortname={shortname}
|
1459
|
-
----
|
1460
|
-
|
1461
|
-
[example]
|
1462
|
-
====
|
1463
|
-
[source,shell]
|
1464
|
-
----
|
1465
|
-
$ w3c_api ecosystem groups --shortname=publishing
|
1466
|
-
---
|
1467
|
-
_links:
|
1468
|
-
self:
|
1469
|
-
href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
|
1470
|
-
type: GroupIndex
|
1471
|
-
first:
|
1472
|
-
href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
|
1473
|
-
type: GroupIndex
|
1474
|
-
last:
|
1475
|
-
href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
|
1476
|
-
type: GroupIndex
|
1477
|
-
up:
|
1478
|
-
href: https://api.w3.org/ecosystems/publishing
|
1479
|
-
type: GroupIndex
|
1480
|
-
groups:
|
1481
|
-
- href: https://api.w3.org/groups/cg/a11y-discov-vocab
|
1482
|
-
title: Accessibility Discoverability Vocabulary for Schema.org Community Group
|
1483
|
-
type: Group
|
1484
|
-
- href: https://api.w3.org/groups/bg/publishingbg
|
1485
|
-
title: Publishing Business Group
|
1486
|
-
type: Group
|
1487
|
-
- href: https://api.w3.org/groups/cg/publishingcg
|
1488
|
-
title: Publishing Community Group
|
1489
|
-
type: Group
|
1490
|
-
- href: https://api.w3.org/groups/wg/pm
|
1491
|
-
title: Publishing Maintenance Working Group
|
1492
|
-
type: Group
|
1493
|
-
page: 1
|
1494
|
-
limit: 100
|
1495
|
-
pages: 1
|
1496
|
-
total: 4
|
1497
|
-
----
|
1498
|
-
====
|
1499
|
-
|
1500
|
-
==== Member organizations
|
1501
|
-
|
1502
|
-
Getting member organizations for an ecosystem.
|
1503
|
-
|
1504
|
-
[source,shell]
|
1505
|
-
----
|
1506
|
-
# Fetch member organizations for an ecosystem
|
1507
|
-
$ w3c_api ecosystem member-organizations --shortname={shortname}
|
1508
|
-
----
|
1509
|
-
|
1510
|
-
[example]
|
1511
|
-
====
|
1512
|
-
[source,shell]
|
1513
|
-
----
|
1514
|
-
$ w3c_api ecosystem member-organizations --shortname=publishing
|
1515
|
-
---
|
1516
|
-
_links:
|
1517
|
-
self:
|
1518
|
-
href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
|
1519
|
-
type: W3cApi::Models::AffiliationIndex
|
1520
|
-
first:
|
1521
|
-
href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
|
1522
|
-
type: W3cApi::Models::AffiliationIndex
|
1523
|
-
last:
|
1524
|
-
href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
|
1525
|
-
type: W3cApi::Models::AffiliationIndex
|
1526
|
-
up:
|
1527
|
-
href: https://api.w3.org/ecosystems/publishing
|
1528
|
-
type: W3cApi::Models::AffiliationIndex
|
1529
|
-
affiliations:
|
1530
|
-
- href: https://api.w3.org/affiliations/56103
|
1531
|
-
title: ACCESS CO., LTD.
|
1532
|
-
type: Affiliation
|
1533
|
-
- href: https://api.w3.org/affiliations/1057
|
1534
|
-
title: Adobe
|
1535
|
-
type: Affiliation
|
1536
|
-
- href: https://api.w3.org/affiliations/108617
|
1537
|
-
title: Amazon
|
1538
|
-
type: Affiliation
|
1539
|
-
- href: https://api.w3.org/affiliations/43420
|
1540
|
-
title: Apache Software Foundation
|
1541
|
-
type: Affiliation
|
1542
|
-
- href: https://api.w3.org/affiliations/1202
|
1543
|
-
title: Apple Inc.
|
1544
|
-
type: Affiliation
|
1545
|
-
...
|
1546
|
-
----
|
1547
|
-
====
|
1548
|
-
|
1549
|
-
=== Affiliations
|
1550
|
-
|
1551
|
-
==== Index
|
1552
|
-
|
1553
|
-
Fetching an index of affiliations.
|
1554
|
-
|
1555
|
-
[source,shell]
|
1556
|
-
----
|
1557
|
-
# Fetch affiliations
|
1558
|
-
$ w3c_api affiliation fetch [OPTIONS]
|
1559
|
-
----
|
1560
|
-
|
1561
|
-
[example]
|
1562
|
-
====
|
1563
|
-
[source,shell]
|
1564
|
-
----
|
1565
|
-
$ w3c_api affiliation fetch
|
1566
|
-
----
|
1567
|
-
====
|
1568
|
-
|
1569
|
-
==== Get
|
1570
|
-
|
1571
|
-
Getting an affiliation by ID.
|
1572
|
-
|
1573
|
-
[source,shell]
|
1574
|
-
----
|
1575
|
-
# Fetch an affiliation
|
1576
|
-
$ w3c_api affiliation fetch --id={id}
|
1577
|
-
----
|
1578
|
-
|
1579
|
-
[example]
|
1580
|
-
====
|
1581
|
-
[source,shell]
|
1582
|
-
----
|
1583
|
-
# Fetch an affiliation
|
1584
|
-
$ w3c_api affiliation fetch --id=1001
|
1585
|
-
---
|
1586
|
-
_links:
|
1587
|
-
self:
|
1588
|
-
href: https://api.w3.org/affiliations/1001
|
1589
|
-
type: Affiliation
|
1590
|
-
homepage:
|
1591
|
-
href: http://www.framkom.se
|
1592
|
-
type: String
|
1593
|
-
participants:
|
1594
|
-
href: https://api.w3.org/affiliations/1001/participants
|
1595
|
-
type: Participant
|
1596
|
-
participations:
|
1597
|
-
href: https://api.w3.org/affiliations/1001/participations
|
1598
|
-
type: Participation
|
1599
|
-
id: 1001
|
1600
|
-
name: Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)
|
1601
|
-
discr: organization
|
1602
|
-
is-member: false
|
1603
|
-
is-member-association: false
|
1604
|
-
is-partner-member: false
|
1605
|
-
----
|
1606
|
-
====
|
1607
|
-
|
1608
|
-
==== Participants
|
1609
|
-
|
1610
|
-
Getting participants for an affiliation.
|
1611
|
-
|
1612
|
-
[source,shell]
|
1613
|
-
----
|
1614
|
-
# Fetch participants for an affiliation
|
1615
|
-
$ w3c_api affiliation participants --id={id}
|
1616
|
-
----
|
1617
|
-
|
1618
|
-
[example]
|
1619
|
-
====
|
1620
|
-
[source,shell]
|
1621
|
-
----
|
1622
|
-
$ w3c_api affiliation participants --id=1104
|
1623
|
-
---
|
1624
|
-
_links:
|
1625
|
-
self:
|
1626
|
-
href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
|
1627
|
-
type: W3cApi::Models::ParticipantIndex
|
1628
|
-
first:
|
1629
|
-
href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
|
1630
|
-
type: W3cApi::Models::ParticipantIndex
|
1631
|
-
last:
|
1632
|
-
href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
|
1633
|
-
type: W3cApi::Models::ParticipantIndex
|
1634
|
-
up:
|
1635
|
-
href: https://api.w3.org/affiliations/1104
|
1636
|
-
type: W3cApi::Models::ParticipantIndex
|
1637
|
-
participants:
|
1638
|
-
- href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
|
1639
|
-
title: Jean-Luc Chevillard
|
1640
|
-
type: User
|
1641
|
-
page: 1
|
1642
|
-
limit: 100
|
1643
|
-
pages: 1
|
1644
|
-
total: 1
|
1227
|
+
href: https://api.w3.org/ecosystems/data/evangelists
|
1645
1228
|
----
|
1646
|
-
====
|
1647
|
-
|
1648
|
-
|
1649
|
-
==== Participations
|
1650
1229
|
|
1651
|
-
|
1230
|
+
== Installation
|
1652
1231
|
|
1653
|
-
|
1654
|
-
----
|
1655
|
-
# Fetch participations for an affiliation
|
1656
|
-
$ w3c_api affiliation participations --id={id}
|
1657
|
-
----
|
1232
|
+
Add this line to your application's Gemfile:
|
1658
1233
|
|
1659
|
-
[
|
1660
|
-
====
|
1661
|
-
[source,shell]
|
1234
|
+
[source,ruby]
|
1662
1235
|
----
|
1663
|
-
|
1664
|
-
---
|
1665
|
-
_links:
|
1666
|
-
self:
|
1667
|
-
href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
|
1668
|
-
type: ParticipationIndex
|
1669
|
-
first:
|
1670
|
-
href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
|
1671
|
-
type: ParticipationIndex
|
1672
|
-
last:
|
1673
|
-
href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
|
1674
|
-
type: ParticipationIndex
|
1675
|
-
up:
|
1676
|
-
href: https://api.w3.org/affiliations/1104
|
1677
|
-
type: ParticipationIndex
|
1678
|
-
participations:
|
1679
|
-
- href: https://api.w3.org/participations/32932
|
1680
|
-
title: XQuery and XSLT Extensions Community Group
|
1681
|
-
type: Participation
|
1682
|
-
page: 1
|
1683
|
-
limit: 100
|
1684
|
-
pages: 1
|
1685
|
-
total: 1
|
1236
|
+
gem 'w3c_api'
|
1686
1237
|
----
|
1687
|
-
====
|
1688
1238
|
|
1689
|
-
|
1690
|
-
|
1691
|
-
==== Get
|
1692
|
-
|
1693
|
-
Getting a participation by ID.
|
1239
|
+
And then execute:
|
1694
1240
|
|
1695
1241
|
[source,shell]
|
1696
1242
|
----
|
1697
|
-
|
1698
|
-
$ w3c_api participation fetch --id={id}
|
1243
|
+
$ bundle install
|
1699
1244
|
----
|
1700
1245
|
|
1701
|
-
|
1702
|
-
====
|
1703
|
-
[source,shell]
|
1704
|
-
----
|
1705
|
-
$ w3c_api participation fetch --id=32932
|
1706
|
-
---
|
1707
|
-
_links:
|
1708
|
-
self:
|
1709
|
-
href: https://api.w3.org/participations/32932
|
1710
|
-
type: Participation
|
1711
|
-
group:
|
1712
|
-
href: https://api.w3.org/groups/cg/xslt-40
|
1713
|
-
title: XQuery and XSLT Extensions Community Group
|
1714
|
-
type: Group
|
1715
|
-
organization:
|
1716
|
-
href: https://api.w3.org/affiliations/1104
|
1717
|
-
title: CNRS
|
1718
|
-
type: Affiliation
|
1719
|
-
participants:
|
1720
|
-
href: https://api.w3.org/participations/32932/participants
|
1721
|
-
type: W3cApi::Models::ParticipantIndex
|
1722
|
-
individual: false
|
1723
|
-
invited-expert: false
|
1724
|
-
created: '2020-11-28T05:59:24+00:00'
|
1725
|
-
----
|
1726
|
-
====
|
1727
|
-
|
1728
|
-
==== Participants
|
1729
|
-
|
1730
|
-
Getting participants for a participation.
|
1731
|
-
|
1732
|
-
[source,shell]
|
1733
|
-
----
|
1734
|
-
# Fetch participants for a participation
|
1735
|
-
$ w3c_api participation participants --id={id}
|
1736
|
-
----
|
1246
|
+
Or install it yourself as:
|
1737
1247
|
|
1738
|
-
[example]
|
1739
|
-
====
|
1740
1248
|
[source,shell]
|
1741
1249
|
----
|
1742
|
-
$
|
1743
|
-
---
|
1744
|
-
_links:
|
1745
|
-
self:
|
1746
|
-
href: https://api.w3.org/participations/32932/participants?page=1&items=100
|
1747
|
-
type: W3cApi::Models::ParticipantIndex
|
1748
|
-
first:
|
1749
|
-
href: https://api.w3.org/participations/32932/participants?page=1&items=100
|
1750
|
-
type: W3cApi::Models::ParticipantIndex
|
1751
|
-
last:
|
1752
|
-
href: https://api.w3.org/participations/32932/participants?page=1&items=100
|
1753
|
-
type: W3cApi::Models::ParticipantIndex
|
1754
|
-
up:
|
1755
|
-
href: https://api.w3.org/participations/32932
|
1756
|
-
type: W3cApi::Models::ParticipantIndex
|
1757
|
-
participants:
|
1758
|
-
- href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
|
1759
|
-
title: Jean-Luc Chevillard
|
1760
|
-
type: User
|
1761
|
-
page: 1
|
1762
|
-
limit: 100
|
1763
|
-
pages: 1
|
1764
|
-
total: 1
|
1250
|
+
$ gem install w3c_api
|
1765
1251
|
----
|
1766
|
-
====
|
1767
1252
|
|
1253
|
+
== Development
|
1768
1254
|
|
1769
|
-
|
1255
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then,
|
1256
|
+
run `rake spec` to run the tests. You can also run `bin/console` for an
|
1257
|
+
interactive prompt that will allow you to experiment.
|
1770
1258
|
|
1771
|
-
|
1772
|
-
|
1773
|
-
|
1774
|
-
|
1775
|
-
|
1776
|
-
.Enabling debug mode on the command line
|
1777
|
-
[example]
|
1778
|
-
====
|
1779
|
-
[source,sh]
|
1780
|
-
----
|
1781
|
-
# Enable debug mode
|
1782
|
-
$ export DEBUG_API=1
|
1783
|
-
$ w3c_api specification fetch --shortname=webrtc
|
1784
|
-
----
|
1785
|
-
====
|
1786
|
-
|
1787
|
-
.Enabling debug mode in Ruby
|
1788
|
-
[example]
|
1789
|
-
====
|
1790
|
-
[source,ruby]
|
1791
|
-
----
|
1792
|
-
ENV["DEBUG_API"] = "1"
|
1793
|
-
W3cApi::Hal.instance.register.fetch(:specification_index)
|
1794
|
-
----
|
1795
|
-
====
|
1259
|
+
To install this gem onto your local machine, run `bundle exec rake install`.
|
1260
|
+
To release a new version, update the version number in `version.rb`, and then
|
1261
|
+
run `bundle exec rake release`, which will create a git tag for the version,
|
1262
|
+
push git commits and the created tag, and push the `.gem` file to
|
1263
|
+
https://rubygems.org[rubygems.org].
|
1796
1264
|
|
1265
|
+
== Contributing
|
1797
1266
|
|
1798
|
-
|
1267
|
+
Bug reports and pull requests are welcome on GitHub at
|
1268
|
+
https://github.com/relaton/w3c_api.
|
1799
1269
|
|
1800
|
-
|
1801
|
-
See the link:LICENSE.md[] file for details.
|
1270
|
+
== License
|
1802
1271
|
|
1803
|
-
|
1272
|
+
The gem is available as open source under the terms of the
|
1273
|
+
https://opensource.org/licenses/MIT[MIT License].
|