Emit required properties and normalize nullable handling for OpenAPI 3.1#165
Open
tom-ioki wants to merge 2 commits into
Open
Emit required properties and normalize nullable handling for OpenAPI 3.1#165tom-ioki wants to merge 2 commits into
tom-ioki wants to merge 2 commits into
Conversation
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request enhances the OpenAPI schema generation in
LightweightSerializer::Documentationby introducing new options for more accurate and standards-compliant output. It adds the ability to emit arequiredarray for non-conditional properties and to optionally omit the deprecatednullable: truekeyword, aligning with OpenAPI 3.1 best practices.OpenAPI schema improvements:
emit_requiredandomit_deprecated_nullableparameters to theopenapi_schemamethod, allowing consumers to opt-in to emitting arequiredarray for unconditional properties and to omit the deprecatednullable: truekeyword in favor of OpenAPI 3.1-style nullability (type: [x, "null"]oroneOf).apply_required!method to populate therequiredarray in the schema, handling both plain and grouped attributes while skipping those gated by a condition. [1] [2]sanitized_documentation_hashandnested_definitionsto conditionally remove thenullable: truekeyword when the new option is enabled, preventing redundant or deprecated output. [1] [2]To opt-in do this in you projects
swagger_helper.rb(the default for these params is set tofalse)