openapi: remove all the extra data info #4277
Merged
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
This change makes the `eventData` object nullable (because it is), and also removes all the properties that we had to declare to have an example. This should help us avoid a fair few warnings about data being mismatched when it can really be anything.
Sonatype Lift is retiringSonatype Lift will be retiring on Sep 12, 2023, with its analysis stopping on Aug 12, 2023. We understand that this news may come as a disappointment, and Sonatype is committed to helping you transition off it seamlessly. If you’d like to retain your data, please export your issues from the web console. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
This lets us use this on our schemas.
Tymek
approved these changes
Jul 19, 2023
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 change makes the
eventDataobject nullable (because it is),and also removes all the properties that we had to declare to have an
example.
This should help us avoid a fair few warnings about data being
mismatched when it can really be anything.
Context
The OpenAPI enforcer gives you warnings when you provide examples that use additional properties. But since we really don't know what the data is in this case, that's the best way forward.
There's two options: either allow additional properties in all examples or use the
x-enforcer-exception-skip-codesto allow it only in a single place.I'm leaning towards the latter (and that's what's in this PR) because it can be useful to have the warning in other places, so I don't think we should ignore it completely. The tradeoff is that the OpenAPI schema gets rendered with that extra property in it.