Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ReSpec-rendered specification versions #3986

Merged
merged 1 commit into from
Aug 5, 2024

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Aug 1, 2024

This pull request is automatically triggered by GitHub action respec.

The versions/*.md files have changed, so the HTML files are automatically being regenerated.

@ralfhandl
Copy link
Contributor

ralfhandl commented Aug 1, 2024

These changes merely replace "external" links with links to our "Normative References" appendix, thus completing the appendix:

  • localBiblio added for external references that weren't in the Specref database
    • Note: these will be removed in future pull requests.
  • links to References appendix are now underlined: a.bibref { text-decoration: underline;}
  • "plain markdown" external links have become links to the References appendix, for example
    • old: <a href="https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml">IANA Status Code Registry</a>
    • new: <cite><a class="bibref" data-link-type="biblio" href="#bib-iana-http-status-codes" title="Hypertext Transfer Protocol (HTTP) Status Code Registry">IANA Status Code Registry</a></cite>
  • first mention of "JSON" and "YAML" formats are now bibliography links
  • Normative references have been added for
    • ABNF
    • CommonMark
    • IANA Auth Schemes registry
    • IANA HTTP Status Codes registry
    • JSON Schema draft specification (version depending on OAS version)
    • SPDX Licences List

@github-actions github-actions bot force-pushed the update-respec-version branch 2 times, most recently from 358826d to 8ed512a Compare August 1, 2024 16:33
@ralfhandl ralfhandl added the editorial Wording and stylistic issues label Aug 2, 2024
@ralfhandl ralfhandl requested review from mikekistler and a team August 2, 2024 14:12
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@ralfhandl ralfhandl requested a review from a team August 5, 2024 08:05
@ralfhandl
Copy link
Contributor

@OAI/tsc Second review please, the diffs are not going to get smaller with the next changes to the build script, easier to review them chunk by chunk 😁

Copy link
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. 👍

@ralfhandl ralfhandl merged commit 69722f6 into gh-pages Aug 5, 2024
@ralfhandl ralfhandl deleted the update-respec-version branch August 5, 2024 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Wording and stylistic issues Housekeeping
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants