Add a note about model-refs in places where they don't work to the 1.2 documentation #2312
Conversation
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
…2 spec It's 3 am. This could've saved me a lot of hours.
Member
|
Sorry for your pain. We don't usually update old specifications. We currently don't have any notion of Errata. We will discuss this in the TSC meeting today. |
Member
|
Is there a similar update that could be made to a more recent document or is this item no longer relevant in the new spec? |
Member
|
The current spec is sufficiently different that these changes are not applicable. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I have no idea if "I'm allowed to do this", but it's currently 3AM and this could've saved me more hours than I want to admit.
In case you're wondering: why is this dude struggeling with a 4 year old spec, I'm trying to use openapi-generator on an API that is described with Swagger 1.2 for some reason. This specification incorrectly declares certain query parameters as "model types", even though they should refer to the ID field of the model. Throwing this at openapi-generator gave me the following (very unhelpful) error:
I might have noticed this problem earlier if this little note was present in the documentation. The only reason I'm sending a PR for a 4 year old spec is to perhaps some day save a fellow community member from my pain.
I have no idea if the wording is correct and all, I tried to stay close to the rest of the document, but I just really want to go to bed. In case this gets rejected for being "too old", I hope this PR will at least show up if somebody Googles this error in the future.