Skip to content

Port format / integer changes from 3.1.1 #4053

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

Merged
merged 1 commit into from
Aug 28, 2024

Conversation

handrews
Copy link
Member

This is a slightly different change due to the different JSON Schema draft being referenced. Please check it carefully as it would have been easy for me to miss something!

Most notably, the older draft has a section on type applicability, so there is an extra link here that is not present in 3.1.1.

This is a slightly different change due to the different JSON Schema
draft being referenced.

Most notably, the older draft has a section on type applicability,
so there is an extra link here that is not present in 3.1.1.

Co-authored-by: Mike Kistler <[email protected]>
@handrews handrews added the editorial Wording and stylistic issues label Aug 27, 2024
@handrews handrews added this to the v3.0.4 milestone Aug 27, 2024
@handrews handrews requested a review from a team August 27, 2024 22:58
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! 👍

Do we need to fix the 3.0.4 spec to exclude "null" as an OAS type as is done here?

Models are defined using the [Schema Object](#schema-object), which is an extended subset of JSON Schema Specification Wright Draft 00.
Data types in the OAS are based on the non-`null` types supported by the [JSON Schema Validation Specification Draft Wright-00](https://datatracker.ietf.org/doc/html/draft-wright-json-schema-validation-00#autoid-32):
"boolean", "object", "array", "number", "string", or "integer".
See [`nullable`](#schema-nullable) for an alternative solution to "null" as a type.
Copy link
Contributor

Choose a reason for hiding this comment

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

Oh wow! I totally forgot about "null" when we were working on the 3.0.4 version. We need to exclude null there too, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

@mikekistler this is the 3.0.4 version- I did this change backwards (3.1.1 first) because 3.1.1 was easier as it uses JSON Schema as-is. Hopefully I didn't miss anything in this PR where null needed to be removed.

@ralfhandl ralfhandl merged commit 1927438 into OAI:v3.0.4-dev Aug 28, 2024
1 check passed
ralfhandl added a commit to ralfhandl/OpenAPI-Specification that referenced this pull request Aug 28, 2024
@handrews handrews deleted the format-304 branch August 28, 2024 16:05
ralfhandl added a commit that referenced this pull request Aug 28, 2024
…aft-wright-00

3.0.4: use same reference style for draft wright as #4053
@ralfhandl ralfhandl mentioned this pull request Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Wording and stylistic issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants