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

Updates to the JSON Schema - symlinks and root description #285

Open
wants to merge 1 commit into
base: v1.0.0-dev
Choose a base branch
from

Conversation

jeremyfiel
Copy link

@jeremyfiel jeremyfiel commented Nov 21, 2024

  • update $comment symlinks
  • update root description

This PR assumes we will follow OAS and Overlay in providing $comment metadata in the schema which points to symlinks on the spec site.

symlinks need to be updated on the main openapis.org site to support the changes here:

@jeremyfiel jeremyfiel changed the title V1.0.0-dev Updates to the JSON Schema - symlinks and root description Nov 21, 2024
@@ -1,7 +1,7 @@
{
"$id": "https://spec.openapis.org/arazzo/1.0/schema/2024-08-01",
Copy link
Author

@jeremyfiel jeremyfiel Nov 21, 2024

Choose a reason for hiding this comment

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

we may also want to consider the $id WORK-IN-PROGRESS for schema development purposes. Overlay and OAS have included changing this to the deployment date with a build script on merge

Copy link
Collaborator

@ralfhandl ralfhandl Nov 22, 2024

Choose a reason for hiding this comment

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

@frankkilcommins Should the JSON version be removed?

OAS only maintains the YAML representation and produces the JSON representation on-the-fly when publishing the schema.

Copy link
Author

Choose a reason for hiding this comment

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

Arazzo doesn't have the full publishing process just yet

Copy link
Collaborator

Choose a reason for hiding this comment

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

Will be added with #290

Copy link
Collaborator

@ralfhandl ralfhandl 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, WORK-IN-PROGRESS marker and removal of JSON representation can be done in subsequent PRs.

@ralfhandl
Copy link
Collaborator

Should be merged after #289 and the resulting publishing PR in the OAS repo.

Copy link
Collaborator

@ralfhandl ralfhandl left a comment

Choose a reason for hiding this comment

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

@jeremyfiel please remove the JSON representation

@jeremyfiel
Copy link
Author

@jeremyfiel please remove the JSON representation

it's been removed in #286

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

Successfully merging this pull request may close these issues.

2 participants