Add links to component tables#584
Merged
eric-schuh merged 25 commits intow3c-ccg:mainfrom Feb 17, 2026
Merged
Conversation
…updates. Added a comment before each header that is linked to in the Component Tables. If the header is updated the corresponding x-componentTableLink parameter in the oas.yaml file needs to be updated for the Component Tables links to continue to function.
The new parameter supports the feature of linking to each endpoint's definition from the Component Tables.
eric-schuh
requested review from
PatStLouis,
dlongley and
msporny
as code owners
Collaborator
Author
|
As a note, this PR is dependent on w3c-ccg/respec-oas#2 |
This was referenced Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
TallTed
reviewed
Feb 3, 2026
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
TallTed
reviewed
Feb 3, 2026
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
TallTed
reviewed
Feb 3, 2026
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
TallTed
reviewed
Feb 3, 2026
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
TallTed
reviewed
Feb 3, 2026
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com>
This was referenced Feb 3, 2026
dlongley
approved these changes
Feb 3, 2026
Collaborator
|
Lets wait until w3c-ccg/respec-oas#2 is addressed then review. |
Updated the component tables to be part of the respec preprocessing step instead of post processing to get the links to display the section numbers properly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated the oas.yml to include a new parameter, x-componentTableLink, and added comments to index.html to support linking to each endpoint's definition from its entry(s) in the component tables.
This isn't the most elegant solution as anytime one of the endpoint definition headers is modified in the index.html the corresponding x-componentTableLink parameter in the oas.yml will need to be updated as well.
Happy to take suggestions for other ways this could be done but I didn't see any way to utilize the existing yml parameters to generate the links to the appropriate definition headers for each endpoint.
This is to address #560