Update Swagger API to match the return of /users/search #4847
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
zeripath
force-pushed
the
Correct-Users-Search-Swagger-API-Description
branch
from
7456c5e
to
bd8842b
Compare
zeripath
force-pushed
the
Correct-Users-Search-Swagger-API-Description
branch
from
bd8842b
to
412c705
Compare
jonasfranz
approved these changes
Sep 18, 2018
bkcsoft
added
the
lgtm/need 1
sapk
approved these changes
Sep 18, 2018
bkcsoft
added
lgtm/done
Signed-off-by: Andrew Thornton <art27@cantab.net>
zeripath
force-pushed
the
Correct-Users-Search-Swagger-API-Description
branch
from
412c705
to
3046702
Compare
lafriks
added
type/docs
Codecov Report
@@ Coverage Diff @@
## master #4847 +/- ##
=========================================
+ Coverage 37.39% 37.4% +<.01%
=========================================
Files 306 306
Lines 45334 45343 +9
=========================================
+ Hits 16954 16959 +5
- Misses 25926 25931 +5
+ Partials 2454 2453 -1
Continue to review full report at Codecov.
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
As per issue #4841 . The current implementation of the /users/search API does not return a UserList but rather an object similar to the SearchResults object returned by /repos/search. This pull request fixes swagger API so that it actually describes the reality of what is returned.
This pull-request requires go-gitea/go-sdk#119
The issue is that this API has been wrong for at least 10 months - therefore tools may have grown up using the incorrect API even though the SDK is incorrect. I have also created a pull request for the opposite solution #4846 - which if pulled would mean this request was unnecessary.