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

Remaining JSON Schema Tweaks for OAS 3.1 #2099

Closed
philsturgeon opened this issue Jan 10, 2020 · 4 comments
Closed

Remaining JSON Schema Tweaks for OAS 3.1 #2099

philsturgeon opened this issue Jan 10, 2020 · 4 comments
Milestone

Comments

@philsturgeon
Copy link
Contributor

philsturgeon commented Jan 10, 2020

With #1977 in the bag, the majority of the work for aligning JSON Schema and OpenAPI Schema Objects has been done for v3.1 (🥳).

Here is a list of remaining clarifications and "further discussions", split into individual issues to avoid overloading any one of them with an unmanageable amount of comments.

Description Owner Issue Status
Clarify text relating to formats @philsturgeon #2093 Somebody wanna tell me some words to write?
Make clear the difference between OAS examples object and JSON Schema examples array @darrelmiller #2094 Unknown
$schema guidance @philsturgeon #2017 PR going through feedback #2266
Improve explanation of Reference Object #388 Done
So what do we do about $ref siblings @MikeRalphson #2089 Done in #2181
Define the scope of $id resolution @darrelmiller #2092 Done
Clarify Nullable properties with default vales @tedepstein #2115 Done
Clarify spec wrt readOnly and writeOnly in referenced schemas @tedepstein #1622 Done (dropped readOnly/writeOnly definition in the OAS spec to use JSON Schema definitions instead)
v3.1 Meta Schema (Schema Object Only) @handrews #2016
v3.1 Meta-schema (all of OpenAPI)
Deprecate discriminator? @tedepstein #2143 Generally seems like a yes, but we need to be more confident in the OpenAPI Vocab direction first? So that a "simple code gen" vocab can be used to restrict some of these keywords or put discriminator back if it ever leaves.
@handrews
Copy link
Member

Thanks, @philsturgeon.

@darrelmiller @webron while we sort these things out, keep in mind that I expect we'll publish a draft-handrews-json-schema-03 (or whatever) with clarifications and bugfixes. So we can also tweak wording and add clarifications on the JSON Schema side.

If we find something that needs it, we can also release a new meta-schema (e.g. 2020-03 or something). It's not like many implementations have caught up to 2019-09 yet, so rolling out a minor update will just mean that they'll target 2020-NN instead of 2019-09.

@handrews
Copy link
Member

handrews commented Feb 6, 2020

@OAI/tsc Progress on the bugfix/clarification JSON Schema draft mentioned in the previous comment can be tracked under the draft-08-patch1 milestone.

@handrews
Copy link
Member

handrews commented Feb 6, 2020

@philsturgeon #2016 is only a meta-schema for the schema object.
We should have a separate issue tracking a schema (not meta-schema) for the entire OAS 3.1 document.

@darrelmiller
Copy link
Member

Open issues have been moved to appropriate milestones.

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

No branches or pull requests

4 participants