w3c_api 0.1.3 → 0.1.4

data/README.adoc

@@ -11,27 +11,26 @@ A Ruby client implementation for the W3C web API with a CLI interface.
 This gem provides:
 
 * A complete client for the W3C API (oft-used endpoints implemented)
-
 * Data models created with
 https://github.com/lutaml/lutaml-hal[lutaml-hal] and
 https://github.com/lutaml/lutaml-model[lutaml-model]
 for all W3C API resources
-
-* HAL (Hypertext Application Language) implementation for recursive resource traversal
-
+* HAL (Hypertext Application Language) implementation for recursive resource
+traversal
 * A command-line interface using Thor following GitHub CLI patterns
 
 The endpoint supported is at https://api.w3.org.
 
 This gem is developed against the W3C API documented at https://api.w3.org/doc.
 
-
 == Illustrative example usage
 
 This is an example demonstrating the power of this library as inherited
 from `lutaml-hal`, showing multiple levels of automatic link resolution.
 
 .Calling the Ruby API with multiple levels of link resolution
+[example]
+====
 [source,ruby]
 ----
 > require 'w3c_api'
@@ -64,46 +63,117 @@ from `lutaml-hal`, showing multiple levels of automatic link resolution.
 #       @templated=nil,
 #       @title=nil,
 #       @type="EvangelistIndex">,
-#     @last=
-#      #<W3cApi::Models::EvangelistIndexLink:0x000000010adeb560
-#       @deprecation=nil,
-#       @href="https://api.w3.org/ecosystems/advertising/evangelists?page=1&items=100",
-#       @lang=nil,
-#       @name=nil,
-#       @profile=nil,
-#       @templated=nil,
-#       @title=nil,
-#       @type="EvangelistIndex">,
-#     @next=nil,
-#     @prev=nil,
-#     @self=
-#      #<W3cApi::Models::EvangelistIndexLink:0x000000010c75a8c0
-#       @deprecation=nil,
-#       @href="https://api.w3.org/ecosystems/advertising/evangelists?page=1&items=100",
-#       @lang=nil,
-#       @name=nil,
-#       @profile=nil,
-#       @templated=nil,
-#       @title=nil,
-#       @type="EvangelistIndex">,
-#     @up=
-#      #<W3cApi::Models::EvangelistIndexLink:0x000000011c1be398
-#       @deprecation=nil,
-#       @href="https://api.w3.org/ecosystems/advertising",
-#       @lang=nil,
-#       @name=nil,
-#       @profile=nil,
-#       @templated=nil,
-#       @title=nil,
-#       @type="EvangelistIndex">>,
+#       ...>,
 #   @page=1,
 #   @pages=1,
 #   @total=1>
 ----
-
+====
 
 == Ruby API
 
+=== Embed support with auto-realize
+
+==== General
+
+The W3C API supports embedded content to reduce the number of HTTP requests
+needed to fetch related resources. This gem provides comprehensive embed
+support with automatic link realization for optimal performance.
+
+[source,ruby]
+----
+require 'w3c_api'
+
+# Create a client and use embed parameter directly
+client = W3cApi::Client.new
+
+# Fetch specifications with embedded content
+specs = client.specifications(embed: true, items: 5)
+
+# Fetch groups with embedded content
+groups = client.groups(embed: true, items: 5)
+
+# Fetch series with embedded content
+series = client.series(embed: true, items: 5)
+
+# Discover which endpoints support embed
+supported_endpoints = W3cApi::Client.embed_supported_endpoints
+# => [:group_index, :serie_index, :specification_index]
+
+# Check if specific endpoint supports embed
+client.embed_supported?(:specification_index)  # => true
+----
+
+==== Auto-realize functionality
+
+The gem features automatic embedded content detection that eliminates the need
+to manually pass `parent_resource` parameters. Links automatically detect and
+use embedded content when available, falling back to HTTP requests when needed.
+
+[source,ruby]
+----
+# Fetch specifications with embed enabled
+specs = client.specifications(embed: true, items: 5)
+
+# Links automatically use embedded content - no parent_resource needed!
+specs.links.specifications.each do |spec_link|
+  # This uses embedded data automatically - no HTTP request needed!
+  spec = spec_link.realize
+  puts "#{spec.title} - #{spec.shortname}"
+end
+
+# The auto-realize functionality works by:
+# 1. Links store references to their parent resources automatically
+# 2. Before making HTTP requests, links check for embedded data
+# 3. If embedded content is available, it's used directly
+# 4. If no embedded content exists, normal HTTP requests are made
+----
+
+==== Performance comparison
+
+Using embed with auto-realize provides significant performance improvements:
+
+[source,ruby]
+----
+# Without embed: 1 request for index + N requests for each specification
+specs = client.specifications(items: 5)
+specs.links.specifications.each do |spec_link|
+  spec = spec_link.realize  # Each call makes an HTTP request
+  puts spec.title
+end
+# Total: 6 HTTP requests (1 + 5)
+
+# With embed: 1 request total, embedded data used automatically
+specs = client.specifications(embed: true, items: 5)
+specs.links.specifications.each do |spec_link|
+  spec = spec_link.realize  # Uses embedded data automatically!
+  puts spec.title
+end
+# Total: 1 HTTP request only
+----
+
+==== Embed discovery
+
+The gem provides methods to discover embed capabilities:
+
+[source,ruby]
+----
+# Get list of endpoints that support embed
+W3cApi::Client.embed_supported_endpoints
+# => [:group_index, :serie_index, :specification_index]
+
+# Check if specific endpoint supports embed
+client.embed_supported?(:specification_index)  # => true
+client.embed_supported?(:specification_resource)  # => false
+
+# Get comprehensive embed information
+embed_info = W3cApi::Embed.embed_info
+puts embed_info[:supported_endpoints]
+puts embed_info[:descriptions]
+puts embed_info[:usage_example]
+----
+
+
 === General
 
 [source,ruby]
@@ -238,7 +308,6 @@ ecosystem = client.ecosystem('data')
 This library provides models for various W3C API resources under the
 `W3cApi::Models` namespace.
 
-
 ==== Affiliation
 
 The `W3cApi::Models::Affiliation` represents a W3C affiliation model that
@@ -247,6 +316,7 @@ includes various attributes and methods to interact with affiliated entities.
 .Fetching the affiliation index
 [example]
 ====
+
 [source,ruby]
 ----
 > W3cApi::Hal.instance.register.fetch(:affiliation_index)
@@ -286,6 +356,7 @@ includes various attributes and methods to interact with affiliated entities.
 .Fetching a specific affiliation
 [example]
 ====
+
 [source,ruby]
 ----
 > W3cApi::Hal.instance.register.fetch(:affiliation_resource, id: 35662)
@@ -298,8 +369,6 @@ includes various attributes and methods to interact with affiliated entities.
 ----
 ====
 
-
-
 == Command line interface
 
 === General
@@ -308,8 +377,8 @@ W3C API provides a command-line interface (CLI) for various operations.
 
 The main executable is `w3c_api`.
 
-By default, the output is in YAML format. You can specify the output format using the
-`--format` option, which accepts `json` or `yaml`.
+By default, the output is in YAML format. You can specify the output format
+using the `--format` option, which accepts `json` or `yaml`.
 
 [source,shell]
 ----
@@ -407,7 +476,6 @@ _links:
 ----
 ====
 
-
 ==== Versions
 
 This command provides access to W3C specification versions given a shortname.
@@ -601,8 +669,8 @@ specifications:
 
 This command provides access to W3C users.
 
-[IMPORTANT]
 .User ID formats
+[IMPORTANT]
 ====
 The W3C API uses both numeric IDs (e.g., `128112`) and string IDs (e.g.,
 `f1ovb5rydm8s0go04oco0cgk0sow44w`) for users. All user-related commands
@@ -789,76 +857,9 @@ participations:
   href: https://api.w3.org/participations/38783
 - title: Positive Work Environment Community Group
   href: https://api.w3.org/participations/38784
-- title: Web Performance Working Group
-  href: https://api.w3.org/participations/38786
-- title: Spatio-temporal Data on the Web Working Group
-  href: https://api.w3.org/participations/44558
-- title: W3C Process Community Group
-  href: https://api.w3.org/participations/39267
-- title: Equity Community Group
-  href: https://api.w3.org/participations/39352
-- title: Web Components Community Group
-  href: https://api.w3.org/participations/40553
-- title: Accessible Platform Architectures Working Group
-  href: https://api.w3.org/participations/36682
-- title: Sustainability Community Group
-  href: https://api.w3.org/participations/41861
-- title: Web Applications Working Group
-  href: https://api.w3.org/participations/43789
-- title: Accessibility Internationalization Community Group
-  href: https://api.w3.org/participations/43788
-- title: Sustainable Web Interest Group
-  href: https://api.w3.org/participations/44152
 ----
 ====
 
-==== Chair of groups
-
-Getting groups a user chairs.
-
-[source,shell]
-----
-# Fetch groups a user chairs
-$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
-----
-
-[example]
-====
-[source,shell]
-----
-$ w3c_api user chair-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
----
-groups:
-- href: https://api.w3.org/groups/cg/equity
-  title: Equity Community Group
-----
-====
-
-==== Team Contact of Groups
-
-Getting groups a user is a team contact of.
-
-[source,shell]
-----
-# Fetch groups a user is a team contact of
-$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
-----
-
-[example]
-====
-[source,shell]
-----
-$ w3c_api user team-contact-of-groups --id=f1ovb5rydm8s0go04oco0cgk0sow44w
-groups:
-- name: Web Platform Working Group
-  href: https://api.w3.org/groups/72825
-- name: Internationalization Working Group
-  href: https://api.w3.org/groups/32113
-# Additional groups omitted for brevity
-----
-====
-
-
 === Groups
 
 This command provides access to W3C groups.
@@ -880,14 +881,10 @@ $ w3c_api group fetch [OPTIONS]
 $ w3c_api group fetch
 ---
 groups:
-- href: https://api.w3.org/groups/tf/ab-liaisons-to-bod
-  title: AB Liaisons to the Board of Directors
-- href: https://api.w3.org/groups/cg/a11yedge
-  title: Accessibility at the Edge Community Group
-- href: https://api.w3.org/groups/tf/wcag-act
-  title: Accessibility Conformance Testing (ACT) Task Force
-- href: https://api.w3.org/groups/cg/a11y-discov-vocab
-  title: Accessibility Discoverability Vocabulary for Schema.org Community Group
+- href: https://api.w3.org/groups/wg/ag
+  title: Accessibility Guidelines Working Group
+- href: https://api.w3.org/groups/cg/global-inclusion
+  title: Accessibility Internationalization Community Group
 # Additional groups omitted for brevity
 ----
 ====
@@ -906,293 +903,167 @@ $ w3c_api group fetch --id=109735
 ====
 [source,shell]
 ----
+$ w3c_api group fetch --id=109735
 ---
 id: 109735
 name: Immersive Web Working Group
-type: working group
-description: The mission of the Immersive Web Working Group is to help bring high-performance
-  Virtual Reality (VR) and Augmented Reality (AR) (collectively known as XR) to the
-  open Web via APIs to interact with XR devices and sensors in browsers.
 shortname: immersive-web
-discr: w3cgroup
-start_date: '2018-09-24'
-end_date: '2026-09-25'
-is_closed: false
+type: working group
+start_date: '2018-10-01'
+end_date: '2020-09-30'
+description: The mission of the Immersive Web Working Group is to help bring
+  high-performance Virtual Reality (VR) and Augmented Reality (AR) to the open Web
+  via APIs to interact with VR and AR devices and sensors in browsers.
 _links:
   self:
     href: https://api.w3.org/groups/wg/immersive-web
-  homepage:
-    href: https://www.w3.org/immersive-web/
-----
-====
-
-==== Chairs
-
-Fetching chairs for a group.
-
-[source,shell]
-----
-# Fetch chairs for a group
-$ w3c_api group chairs --id={id}
-----
-
-[example]
-====
-[source,shell]
-----
-$ w3c_api group chairs --id=109735
----
-_links:
-  self:
-    href: https://api.w3.org/groups/109735/chairs?page=1&items=100
-    type: W3cApi::Models::ChairIndex
-  first:
-    href: https://api.w3.org/groups/109735/chairs?page=1&items=100
-    type: W3cApi::Models::ChairIndex
-  last:
-    href: https://api.w3.org/groups/109735/chairs?page=1&items=100
-    type: W3cApi::Models::ChairIndex
-  up:
-    href: https://api.w3.org/groups/109735
-    type: W3cApi::Models::ChairIndex
+  users:
+    href: https://api.w3.org/groups/109735/users
+  specifications:
+    href: https://api.w3.org/groups/109735/specifications
   chairs:
-  - href: https://api.w3.org/users/basy63arxl448c8co0og8ocosocgc0w
-    title: Ada Rose Cannon
-    type: User
-  - href: https://api.w3.org/users/l88ca27n2b4sk00cogosk0skw4s8osc
-    title: Chris Wilson
-    type: User
-  - href: https://api.w3.org/users/m99jqkpi9m8oww84kw4gwccgc4g0ogs
-    title: Ayşegül Yönet
-    type: User
+    href: https://api.w3.org/groups/109735/chairs
+  team_contacts:
+    href: https://api.w3.org/groups/109735/teamcontacts
+  charters:
+    href: https://api.w3.org/groups/109735/charters
 ----
 ====
 
-==== Team contacts
+==== Users
 
-Fetching team contacts for a group.
+Getting users in a group.
 
 [source,shell]
 ----
-# Fetch team contacts for a group
-$ w3c_api group team-contacts --id={id}
+# Fetch users in a group
+$ w3c_api group users --id=109735
 ----
 
 [example]
 ====
 [source,shell]
 ----
-$ w3c_api group team-contacts --id=109735
+$ w3c_api group users --id=109735
 ---
-_links:
-  self:
-    href: https://api.w3.org/groups/109735/teamcontacts?page=1&items=100
-    type: W3cApi::Models::TeamContactIndex
-  first:
-    href: https://api.w3.org/groups/109735/teamcontacts?page=1&items=100
-    type: W3cApi::Models::TeamContactIndex
-  last:
-    href: https://api.w3.org/groups/109735/teamcontacts?page=1&items=100
-    type: W3cApi::Models::TeamContactIndex
-  up:
-    href: https://api.w3.org/groups/109735
-    type: W3cApi::Models::TeamContactIndex
-  team-contacts:
-  - href: https://api.w3.org/users/1eb2xr7ab6zo0k8440o48swso408ksc
-    title: Atsushi Shimono
-    type: User
+users:
+- href: https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w
+  title: Jennifer Strickland
+- href: https://api.w3.org/users/bzb5w20eg68k40gc8w0wg0okk4k84os
+  title: Cullen Jennings
+# Additional users omitted for brevity
 ----
 ====
 
-==== Participations
+==== Specifications
 
-Fetching participations for a group.
+Getting specifications delivered by a group.
 
 [source,shell]
 ----
-# Fetch participations for a group
-$ w3c_api group participations --id={id}
+# Fetch specifications delivered by a group
+$ w3c_api group specifications --id=109735
 ----
 
 [example]
 ====
 [source,shell]
 ----
-$ w3c_api group participations --id=109735
+$ w3c_api group specifications --id=109735
 ---
-_links:
-  self:
-    href: https://api.w3.org/groups/109735/participations?page=1&items=100
-    type: ParticipationIndex
-  first:
-    href: https://api.w3.org/groups/109735/participations?page=1&items=100
-    type: ParticipationIndex
-  last:
-    href: https://api.w3.org/groups/109735/participations?page=1&items=100
-    type: ParticipationIndex
-  up:
-    href: https://api.w3.org/groups/109735
-    type: ParticipationIndex
-  participations:
-  - href: https://api.w3.org/participations/43367
-    title: Kodansha, Publishers, Ltd.
-    type: Participation
-  - href: https://api.w3.org/participations/43368
-    title: Institut National de Recherche en Informatique et en Automatique (Inria)
-    type: Participation
-  - href: https://api.w3.org/participations/43391
-    title: Igalia
-    type: Participation
-  - href: https://api.w3.org/participations/43415
-    title: Christine Perey
-    type: Participation
+specifications:
+- title: WebXR Device API
+  href: https://api.w3.org/specifications/webxr
+- title: WebXR Gamepads Module - Level 1
+  href: https://api.w3.org/specifications/webxr-gamepads-1
+# Additional specifications omitted for brevity
 ----
 ====
 
+=== Affiliations
 
-==== Specifications
+This command provides access to W3C affiliations.
 
-Fetching specifications for a group.
+==== Index
+
+Fetching an index of affiliations.
 
 [source,shell]
 ----
-# Fetch specifications for a group
-$ w3c_api group specifications --id=109735
+# Fetch affiliations
+$ w3c_api affiliation fetch [OPTIONS]
 ----
 
 [example]
 ====
 [source,shell]
 ----
-$ w3c_api group specifications --id=109735
+$ w3c_api affiliation fetch
 ---
-_links:
-  self:
-    href: https://api.w3.org/groups/109735/specifications?page=1&items=100
-    type: SpecificationIndex
-  first:
-    href: https://api.w3.org/groups/109735/specifications?page=1&items=100
-    type: SpecificationIndex
-  last:
-    href: https://api.w3.org/groups/109735/specifications?page=1&items=100
-    type: SpecificationIndex
-  up:
-    href: https://api.w3.org/groups/109735
-    type: SpecificationIndex
-  specifications:
-  - href: https://api.w3.org/specifications/webxr-lighting-estimation-1
-    title: WebXR Lighting Estimation API Level 1
-    type: Specification
-  - href: https://api.w3.org/specifications/webxr-gamepads-module-1
-    title: WebXR Gamepads Module - Level 1
-    type: Specification
-  - href: https://api.w3.org/specifications/webxr-hand-input-1
-    title: WebXR Hand Input Module - Level 1
-    type: Specification
-  - href: https://api.w3.org/specifications/webxr-hit-test-1
-    title: WebXR Hit Test Module
-    type: Specification
-  - href: https://api.w3.org/specifications/webxr-dom-overlays-1
-    title: WebXR DOM Overlays Module
-    type: Specification
+affiliations:
+- href: https://api.w3.org/affiliations/1001
+  title: Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)
+- href: https://api.w3.org/affiliations/1003
+  title: BackWeb Technologies, Inc.
+# Additional affiliations omitted for brevity
 ----
 ====
 
-==== Users
+==== Get
 
-Fetching users for a group.
+Getting an affiliation by ID.
 
 [source,shell]
 ----
-# Fetch users for a group
-$ w3c_api group users --id=109735
+# Fetch an affiliation
+$ w3c_api affiliation fetch --id=35662
 ----
 
 [example]
 ====
 [source,shell]
 ----
-$ w3c_api group users --id=109735
+$ w3c_api affiliation fetch --id=35662
 ---
+id: 35662
+name: Google LLC
+discr: organization
 _links:
   self:
-    href: https://api.w3.org/groups/109735/users?page=1&items=100
-    type: UserIndex
-  first:
-    href: https://api.w3.org/groups/109735/users?page=1&items=100
-    type: UserIndex
-  last:
-    href: https://api.w3.org/groups/109735/users?page=1&items=100
-    type: UserIndex
-  up:
-    href: https://api.w3.org/groups/109735
-    type: UserIndex
-  users:
-  - href: https://api.w3.org/users/9o1jsmhi8ysk088w0k4g00wsssk4c8c
-    title: Muadh Al Kalbani
-    type: User
-  - href: https://api.w3.org/users/rqjspzlmiq8c0kk8goos4c480w8wccs
-    title: Matthew Atkinson
-    type: User
-  - href: https://api.w3.org/users/32hnccz98a68sk0kcog8c4wo4sgckkw
-    title: Ashwin Balasubramaniyan
-    type: User
-  - href: https://api.w3.org/users/ff80kfl6a0gso4oo8s40cg4c4wccgs0
-    title: Trevor Baron
-    type: User
+    href: https://api.w3.org/affiliations/35662
+  participants:
+    href: https://api.w3.org/affiliations/35662/participants
+  participations:
+    href: https://api.w3.org/affiliations/35662/participations
 ----
 ====
 
-==== Charters
+==== Participants
 
-Fetching charters for a group.
+Getting participants of an affiliation.
 
 [source,shell]
 ----
-# Fetch charters for a group
-$ w3c_api group charters --id=109735
+# Fetch participants of an affiliation
+$ w3c_api affiliation participants --id=35662
 ----
 
 [example]
 ====
 [source,shell]
 ----
-$ w3c_api group charters --id=109735
+$ w3c_api affiliation participants --id=35662
 ---
-_links:
-  self:
-    href: https://api.w3.org/groups/109735/charters?page=1&items=100
-    type: W3cApi::Models::CharterIndex
-  first:
-    href: https://api.w3.org/groups/109735/charters?page=1&items=100
-    type: W3cApi::Models::CharterIndex
-  last:
-    href: https://api.w3.org/groups/109735/charters?page=1&items=100
-    type: W3cApi::Models::CharterIndex
-  up:
-    href: https://api.w3.org/groups/109735
-    type: W3cApi::Models::CharterIndex
-  charters:
-  - href: https://api.w3.org/groups/109735/charters/361
-    title: 2018-09-24 -> 2020-03-01
-    type: Charter
-  - href: https://api.w3.org/groups/109735/charters/405
-    title: 2020-05-12 -> 2022-06-01
-    type: Charter
-  - href: https://api.w3.org/groups/109735/charters/464
-    title: 2022-07-08 -> 2024-07-07
-    type: Charter
-  - href: https://api.w3.org/groups/109735/charters/514
-    title: 2024-09-26 -> 2026-09-25
-    type: Charter
-page: 1
-limit: 100
-pages: 1
-total: 4
+participants:
+- href: https://api.w3.org/users/bzb5w20eg68k40gc8w0wg0okk4k84os
+  title: Cullen Jennings
+- href: https://api.w3.org/users/f521yr1m6g0kks880s8ocwsgwskgss4
+  title: Jan-Ivar Bruaroey
+# Additional participants omitted for brevity
 ----
 ====
 
-=== Translation
+=== Translations
 
 This command provides access to W3C translations.
 
@@ -1205,38 +1076,19 @@ Fetching an index of translations.
 # Fetch translations
 $ w3c_api translation fetch [OPTIONS]
 ----
+
 [example]
 ====
 [source,shell]
 ----
 $ w3c_api translation fetch
 ---
-_links:
-  self:
-    href: https://api.w3.org/translations?page=1&items=100
-    type: TranslationIndex
-  next:
-    href: https://api.w3.org/translations?page=2&items=100
-    type: TranslationIndex
-  first:
-    href: https://api.w3.org/translations?page=1&items=100
-    type: TranslationIndex
-  last:
-    href: https://api.w3.org/translations?page=7&items=100
-    type: TranslationIndex
-  translations:
-  - href: https://api.w3.org/translations/2
-    title: 'Vidéo : introduction à l’accessibilité web et aux standards du W3C'
-    type: Translation
-  - href: https://api.w3.org/translations/3
-    title: Vídeo de Introducción a la Accesibilidad Web y Estándares del W3C
-    type: Translation
-  - href: https://api.w3.org/translations/4
-    title: Video-introductie over Web-toegankelijkheid en W3C-standaarden
-    type: Translation
-  - href: https://api.w3.org/translations/5
-    title: 网页无障碍和W3C标准的介绍视频
-    type: Translation
+translations:
+- href: https://api.w3.org/translations/1
+  title: HTML 4.01 Specification
+- href: https://api.w3.org/translations/2
+  title: Cascading Style Sheets, level 1
+# Additional translations omitted for brevity
 ----
 ====
 
@@ -1247,121 +1099,51 @@ Getting a translation by ID.
 [source,shell]
 ----
 # Fetch a translation
-$ w3c_api translation fetch --id=467
+$ w3c_api translation fetch --id=2
 ----
 
 [example]
 ====
 [source,shell]
 ----
-$ w3c_api translation fetch --id=467
+$ w3c_api translation fetch --id=2
 ---
+id: 2
+title: Cascading Style Sheets, level 1
+language: fr
+url: https://www.yoyodesign.org/doc/w3c/css1/index.html
 _links:
   self:
-    href: https://api.w3.org/translations/467
-    type: Translation
-uri: http://maujor.com/w3c/xml-base.html
-title: XML Base
-language: pt_BR
-published: '2005-09-23T00:00:00+00:00'
-authorized: false
-call-for-translation:
-  _links:
-    self:
-      href: https://api.w3.org/callsfortranslation/28
-      type: CallForTranslation
-    translations:
-      href: https://api.w3.org/callsfortranslation/28/translations
-      type: TranslationIndex
-  title: XML Base
-states:
-- published
-translators:
-- _links:
-    self:
-      href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48
-      type: User
-    affiliations:
-      href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/affiliations
-      type: W3cApi::Models::AffiliationIndex
-    groups:
-      href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/groups
-      type: GroupIndex
-    specifications:
-      href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/specifications
-      type: SpecificationIndex
-    participations:
-      href: https://api.w3.org/users/91oj8wozeb0o4wcoo8wswkcsw4oog48/participations
-      type: ParticipationIndex
-  id: '112282'
-  name: Maurício Samy Silva
-  given: Maurício
-  family: Samy Silva
-  discr: user
+    href: https://api.w3.org/translations/2
 ----
 ====
 
-
-=== Ecosystem
+=== Ecosystems
 
 This command provides access to W3C ecosystems.
 
 ==== Index
 
 Fetching an index of ecosystems.
+
 [source,shell]
 ----
 # Fetch ecosystems
 $ w3c_api ecosystem fetch [OPTIONS]
 ----
+
 [example]
 ====
 [source,shell]
 ----
 $ w3c_api ecosystem fetch
 ---
-_links:
-  self:
-    href: https://api.w3.org/ecosystems?embed=0&page=1&items=100
-    type: W3cApi::Models::EcosystemIndex
-  first:
-    href: https://api.w3.org/ecosystems?embed=0&page=1&items=100
-    type: W3cApi::Models::EcosystemIndex
-  last:
-    href: https://api.w3.org/ecosystems?embed=0&page=1&items=100
-    type: W3cApi::Models::EcosystemIndex
-  ecosystems:
-  - href: https://api.w3.org/ecosystems/advertising
-    title: Web Advertising
-    type: Ecosystem
-  - href: https://api.w3.org/ecosystems/e-commerce
-    title: E-commerce
-    type: Ecosystem
-  - href: https://api.w3.org/ecosystems/media
-    title: Media & Entertainment
-    type: Ecosystem
-  - href: https://api.w3.org/ecosystems/network-communications
-    title: Network & Communications
-    type: Ecosystem
-  - href: https://api.w3.org/ecosystems/publishing
-    title: Publishing
-    type: Ecosystem
-  - href: https://api.w3.org/ecosystems/smart-cities
-    title: Smart Cities
-    type: Ecosystem
-  - href: https://api.w3.org/ecosystems/automotive-transportation
-    title: Automotive & Transportation
-    type: Ecosystem
-  - href: https://api.w3.org/ecosystems/web-of-things
-    title: Web of Things
-    type: Ecosystem
-  - href: https://api.w3.org/ecosystems/data
-    title: Data and knowledge
-    type: Ecosystem
-page: 1
-limit: 100
-pages: 1
-total: 9
+ecosystems:
+- shortname: advertising
+  name: Advertising
+- shortname: data
+  name: Data
+# Additional ecosystems omitted for brevity
 ----
 ====
 
@@ -1372,7 +1154,7 @@ Getting an ecosystem by shortname.
 [source,shell]
 ----
 # Fetch an ecosystem
-$ w3c_api ecosystem fetch --shortname={shortname}
+$ w3c_api ecosystem fetch --shortname=data
 ----
 
 [example]
@@ -1381,423 +1163,60 @@ $ w3c_api ecosystem fetch --shortname={shortname}
 ----
 $ w3c_api ecosystem fetch --shortname=data
 ---
+shortname: data
+name: Data
+description: The Data ecosystem focuses on technologies and standards for
+  representing, exchanging, and processing data on the Web.
 _links:
   self:
     href: https://api.w3.org/ecosystems/data
-    type: Ecosystem
-  champion:
-    href: https://api.w3.org/users/t891ludoisggsccsw44o8goccc0s0ks
-    title: Pierre-Antoine Champin
-    type: User
-  evangelists:
-    href: https://api.w3.org/ecosystems/data/evangelists
-    type: EvangelistIndex
   groups:
     href: https://api.w3.org/ecosystems/data/groups
-    type: GroupIndex
-  member-organizations:
-    href: https://api.w3.org/ecosystems/data/member-organizations
-    type: W3cApi::Models::AffiliationIndex
-name: Data and knowledge
-shortname: data
-----
-====
-
-==== Evangelists
-
-Getting evangelists for an ecosystem.
-
-[source,shell]
-----
-# Fetch evangelists for an ecosystem
-$ w3c_api ecosystem evangelists --shortname={shortname}
-----
-[example]
-====
-[source,shell]
-----
-$ w3c_api ecosystem evangelists --shortname=publishing
----
-_links:
-  self:
-    href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
-    type: EvangelistIndex
-  first:
-    href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
-    type: EvangelistIndex
-  last:
-    href: https://api.w3.org/ecosystems/publishing/evangelists?page=1&items=100
-    type: EvangelistIndex
-  up:
-    href: https://api.w3.org/ecosystems/publishing
-    type: EvangelistIndex
   evangelists:
-  - href: https://api.w3.org/users/ni26g4n5gqskg8k80ssgw0ko048wgwg
-    title: Bill Kasdorf
-    type: User
-  - href: https://api.w3.org/users/a5eur9p2iyo0ws00448w4gcw4c8sock
-    title: Daihei Shiohama
-    type: User
-  - href: https://api.w3.org/users/qdkk81rtp344c44g0osoocgwwc8o4ss
-    title: Bobby Tung
-    type: User
-page: 1
-limit: 100
-pages: 1
-total: 3
-----
-====
-
-==== Groups
-
-Getting groups for an ecosystem.
-
-[source,shell]
-----
-# Fetch groups for an ecosystem
-$ w3c_api ecosystem groups --shortname={shortname}
-----
-
-[example]
-====
-[source,shell]
-----
-$ w3c_api ecosystem groups --shortname=publishing
----
-_links:
-  self:
-    href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
-    type: GroupIndex
-  first:
-    href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
-    type: GroupIndex
-  last:
-    href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
-    type: GroupIndex
-  up:
-    href: https://api.w3.org/ecosystems/publishing
-    type: GroupIndex
-  groups:
-  - href: https://api.w3.org/groups/cg/a11y-discov-vocab
-    title: Accessibility Discoverability Vocabulary for Schema.org Community Group
-    type: Group
-  - href: https://api.w3.org/groups/bg/publishingbg
-    title: Publishing Business Group
-    type: Group
-  - href: https://api.w3.org/groups/cg/publishingcg
-    title: Publishing Community Group
-    type: Group
-  - href: https://api.w3.org/groups/wg/pm
-    title: Publishing Maintenance Working Group
-    type: Group
-page: 1
-limit: 100
-pages: 1
-total: 4
-----
-====
-
-==== Member organizations
-
-Getting member organizations for an ecosystem.
-
-[source,shell]
-----
-# Fetch member organizations for an ecosystem
-$ w3c_api ecosystem member-organizations --shortname={shortname}
-----
-
-[example]
-====
-[source,shell]
-----
-$ w3c_api ecosystem member-organizations --shortname=publishing
----
-_links:
-  self:
-    href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
-    type: W3cApi::Models::AffiliationIndex
-  first:
-    href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
-    type: W3cApi::Models::AffiliationIndex
-  last:
-    href: https://api.w3.org/ecosystems/publishing/member-organizations?page=1&items=100
-    type: W3cApi::Models::AffiliationIndex
-  up:
-    href: https://api.w3.org/ecosystems/publishing
-    type: W3cApi::Models::AffiliationIndex
-  affiliations:
-  - href: https://api.w3.org/affiliations/56103
-    title: ACCESS CO., LTD.
-    type: Affiliation
-  - href: https://api.w3.org/affiliations/1057
-    title: Adobe
-    type: Affiliation
-  - href: https://api.w3.org/affiliations/108617
-    title: Amazon
-    type: Affiliation
-  - href: https://api.w3.org/affiliations/43420
-    title: Apache Software Foundation
-    type: Affiliation
-  - href: https://api.w3.org/affiliations/1202
-    title: Apple Inc.
-    type: Affiliation
-...
-----
-====
-
-=== Affiliations
-
-==== Index
-
-Fetching an index of affiliations.
-
-[source,shell]
-----
-# Fetch affiliations
-$ w3c_api affiliation fetch [OPTIONS]
-----
-
-[example]
-====
-[source,shell]
-----
-$ w3c_api affiliation fetch
-----
-====
-
-==== Get
-
-Getting an affiliation by ID.
-
-[source,shell]
-----
-# Fetch an affiliation
-$ w3c_api affiliation fetch --id={id}
-----
-
-[example]
-====
-[source,shell]
-----
-# Fetch an affiliation
-$ w3c_api affiliation fetch --id=1001
----
-_links:
-  self:
-    href: https://api.w3.org/affiliations/1001
-    type: Affiliation
-  homepage:
-    href: http://www.framkom.se
-    type: String
-  participants:
-    href: https://api.w3.org/affiliations/1001/participants
-    type: Participant
-  participations:
-    href: https://api.w3.org/affiliations/1001/participations
-    type: Participation
-id: 1001
-name: Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)
-discr: organization
-is-member: false
-is-member-association: false
-is-partner-member: false
-----
-====
-
-==== Participants
-
-Getting participants for an affiliation.
-
-[source,shell]
-----
-# Fetch participants for an affiliation
-$ w3c_api affiliation participants --id={id}
-----
-
-[example]
-====
-[source,shell]
-----
-$ w3c_api affiliation participants --id=1104
----
-_links:
-  self:
-    href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
-    type: W3cApi::Models::ParticipantIndex
-  first:
-    href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
-    type: W3cApi::Models::ParticipantIndex
-  last:
-    href: https://api.w3.org/affiliations/1104/participants?page=1&items=100
-    type: W3cApi::Models::ParticipantIndex
-  up:
-    href: https://api.w3.org/affiliations/1104
-    type: W3cApi::Models::ParticipantIndex
-  participants:
-  - href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
-    title: Jean-Luc Chevillard
-    type: User
-page: 1
-limit: 100
-pages: 1
-total: 1
+    href: https://api.w3.org/ecosystems/data/evangelists
 ----
-====
-
-
-==== Participations
 
-Getting participations for an affiliation.
+== Installation
 
-[source,shell]
-----
-# Fetch participations for an affiliation
-$ w3c_api affiliation participations --id={id}
-----
+Add this line to your application's Gemfile:
 
-[example]
-====
-[source,shell]
+[source,ruby]
 ----
-$ w3c_api affiliation participations --id=1104
----
-_links:
-  self:
-    href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
-    type: ParticipationIndex
-  first:
-    href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
-    type: ParticipationIndex
-  last:
-    href: https://api.w3.org/affiliations/1104/participations?page=1&items=100
-    type: ParticipationIndex
-  up:
-    href: https://api.w3.org/affiliations/1104
-    type: ParticipationIndex
-  participations:
-  - href: https://api.w3.org/participations/32932
-    title: XQuery and XSLT Extensions Community Group
-    type: Participation
-page: 1
-limit: 100
-pages: 1
-total: 1
+gem 'w3c_api'
 ----
-====
-
-=== Participations
-
-==== Get
-
-Getting a participation by ID.
 
-[source,shell]
-----
-# Fetch a participation
-$ w3c_api participation fetch --id={id}
-----
+And then execute:
 
-[example]
-====
 [source,shell]
 ----
-$ w3c_api participation fetch --id=32932
----
-_links:
-  self:
-    href: https://api.w3.org/participations/32932
-    type: Participation
-  group:
-    href: https://api.w3.org/groups/cg/xslt-40
-    title: XQuery and XSLT Extensions Community Group
-    type: Group
-  organization:
-    href: https://api.w3.org/affiliations/1104
-    title: CNRS
-    type: Affiliation
-  participants:
-    href: https://api.w3.org/participations/32932/participants
-    type: W3cApi::Models::ParticipantIndex
-individual: false
-invited-expert: false
-created: '2020-11-28T05:59:24+00:00'
+$ bundle install
 ----
-====
-
-==== Participants
 
-Getting participants for a participation.
-
-[source,shell]
-----
-# Fetch participants for a participation
-$ w3c_api participation participants --id={id}
-----
+Or install it yourself as:
 
-[example]
-====
 [source,shell]
 ----
-$ w3c_api participation participants --id=32932
----
-_links:
-  self:
-    href: https://api.w3.org/participations/32932/participants?page=1&items=100
-    type: W3cApi::Models::ParticipantIndex
-  first:
-    href: https://api.w3.org/participations/32932/participants?page=1&items=100
-    type: W3cApi::Models::ParticipantIndex
-  last:
-    href: https://api.w3.org/participations/32932/participants?page=1&items=100
-    type: W3cApi::Models::ParticipantIndex
-  up:
-    href: https://api.w3.org/participations/32932
-    type: W3cApi::Models::ParticipantIndex
-  participants:
-  - href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
-    title: Jean-Luc Chevillard
-    type: User
-page: 1
-limit: 100
-pages: 1
-total: 1
+$ gem install w3c_api
 ----
-====
-
-
-== Debug mode
-
-The library supports a debug mode that can be enabled by setting the `DEBUG_API`
-environment variable to a non-empty value.
 
-This will print the HTTP requests and responses made by the API client.
+== Development
 
-.Enabling debug mode on the command line
-[example]
-====
-[source,sh]
-----
-# Enable debug mode
-$ export DEBUG_API=1
-$ w3c_api specification fetch --shortname=webrtc
-----
-====
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
 
-.Enabling debug mode in Ruby
-[example]
-====
-[source,ruby]
-----
-ENV["DEBUG_API"] = "1"
-W3cApi::Hal.instance.register.fetch(:specification_index)
-----
-====
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and the created tag, and push the `.gem` file to
+https://rubygems.org[rubygems.org].
 
+== Contributing
 
-== License and Copyright
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/relaton/w3c_api.
 
-This project is licensed under the BSD 2-clause License.
-See the link:LICENSE.md[] file for details.
+== License
 
-Copyright Ribose.
+The gem is available as open source under the terms of the
+https://opensource.org/licenses/MIT[MIT License].