-
Notifications
You must be signed in to change notification settings - Fork 44
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
base: v1.0.0-dev
Are you sure you want to change the base?
Conversation
@@ -1,7 +1,7 @@ | |||
{ | |||
"$id": "https://spec.openapis.org/arazzo/1.0/schema/2024-08-01", |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this 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.
Should be merged after #289 and the resulting publishing PR in the OAS repo. |
There was a problem hiding this 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
it's been removed in #286 |
$comment
symlinksThis 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: