Skip to content

Update ReSpec versions for Arazzo #3887

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

Closed
wants to merge 1 commit into from
Closed

Conversation

ncaidin
Copy link
Contributor

@ncaidin ncaidin commented Jun 5, 2024

This pull request is automatically triggered by GitHub action respec.

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

@handrews
Copy link
Member

handrews commented Jun 5, 2024

@frankkilcommins this seems to delete all of the section information in references to RFC3986 which does not seem like a plus. Was that intentional?

@frankkilcommins
Copy link
Contributor

@handrews I was on the fence as to whether to follow the OAS lead and have the RFC link form part of the normative reference table: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#relative-references-in-uris

Indeed the section links get lost during the md2html/respec process as covered by #3863

@github-actions github-actions bot force-pushed the update-respec-version branch from 1a68790 to ea03525 Compare June 6, 2024 11:28
@github-actions github-actions bot closed this Jun 6, 2024
@handrews
Copy link
Member

handrews commented Jun 6, 2024

@frankkilcommins I wouldn't assume anything about how the OAS references rendering is done as an intentional thing to follow at the moment. We've discovered a lot of things that are inconsistent or incorrect about it.

@frankkilcommins
Copy link
Contributor

@handrews no worries. I'm working on improving the md2html script on a local branch to handle the situation where fragments are in the RFC links. Works quite well:
image

so it has the bib link as well as a specific section link

@handrews
Copy link
Member

handrews commented Jun 6, 2024

@frankkilcommins that's great- please make sure @Bellangelo is aware of any scripting changes by updating issue #3863!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants