Update to OpenAPI spec v3.1.0 #910
Closed
Conversation
This file contains 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
The current implementation uses the deprecated field `example` which causes test failures whenever creating a new Bullet Train application, and whenever a new Super Scaffold is generated. This PR updates the implementation to use the current `examples` field instead. SEE: https://spec.openapis.org/oas/latest.html#fixed-fields-5
|
Note that I still have a few places to patch up. Working on that now. |
|
That first stab was an AI recommendation. It points the way... sort of, but I believe the issue is in the bullet-train-co/jbuilder-schema gem. Taking a deeper look. |
|
Abandoning this and will leave to the OpenAPI domain experts that did the original implementation. |
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.
The current implementation uses the deprecated
examplefield which causes test failures whenever creating a new Bullet Train application, and whenever a new Super Scaffold is generated.This PR updates the implementation to use the current
examplesfield instead.SEE: https://spec.openapis.org/oas/latest.html#fixed-fields-5
Note
This change satisifies the test failure problem but we should verify that it returns what's truly needed for the OpenAPI docs.
Related: bullet-train-co/bullet_train#1520