Two fixes for OpenAPI 2.0 version of the API. #188
Closed
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
|
Are these fixes associated with any open issue(s) in this repository?
…On Sat, Sep 30, 2017 at 4:29 PM, Zachary Hirsch ***@***.***> wrote:
1.
The "currentpage" parameter in some methods should be in the query,
not in the path.
2.
The "components" parameter in some methods cannot use a $ref to
specify the schema. Instead, specify its type as an integer. OpenAPI 3.0
allows $ref, apparently.
These fixes are necessary to generate a client library with
https://github.com/go-swagger/go-swagger.
Thanks!
------------------------------
You can view, comment on, or merge this pull request online at:
#188
Commit Summary
- Fix currentpage parameter: it should be in the query, not the path.
- Fix components parameter: OpenAPI 2.0 does not allow $ref in query
parameters.
File Changes
- *M* openapi-2.json
<https://github.com/Bungie-net/api/pull/188/files#diff-0> (50)
Patch Links:
- https://github.com/Bungie-net/api/pull/188.patch
- https://github.com/Bungie-net/api/pull/188.diff
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#188>, or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAFqDKJWZHVaTTaIcTWzULysyODYEj7zks5sns6_gaJpZM4PpujI>
.
|
Instead of type=object,allOf{$ref} just do $ref.
These cause go-swagger to generate non-determinstic output, i.e. regenerating the client library multiple times in a row results in different output.
|
I didn't file any issues related to these fixes, but other users might have reported related issues. EDIT: I found an issue for the "currentpage" fix, and I filed a new one for the "components" fix. |
|
I moved this to #192, sorry for any confusion. |
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 "currentpage" parameter in some methods should be in the query, not in the path (fixes Multiple GroupV2 Query Problems. #124).
The "components" parameter in some methods cannot use a $ref to specify the schema. Instead, specify its type as an integer. OpenAPI 3.0 allows $ref, apparently (fixes $ref not allowed in array-type query parameters in OpenAPI 2.0 spec #190).
These fixes are necessary to generate a client library with https://github.com/go-swagger/go-swagger.
Thanks!