Skip to content
This repository was archived by the owner on Jun 8, 2019. It is now read-only.

Update SDK to match the return of /users/search #119

Conversation

zeripath
Copy link

@zeripath zeripath commented Sep 2, 2018

As per issue go-gitea/gitea#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.

The issue is that this API has been wrong for at least 10 months - therefore tools may have grown up using the incorrect API. I have also created a pull request for the opposite solution go-gitea/gitea#4846 - which if pulled would mean this request was unnecessary.

@zeripath zeripath force-pushed the Correct-Users-Search-Swagger-API-Description branch from 0a03e77 to 694b136 Compare September 2, 2018 12:53
@lunny
Copy link
Member

lunny commented Sep 2, 2018

I don't know what's the different between the changes?

@zeripath
Copy link
Author

zeripath commented Sep 2, 2018

OK, so if you look at the pull-request go-gitea/gitea#4847 - the changes there make a formal UserSearchResults object which means that these changes are needed on the SDK. (This is to fix go-gitea/gitea#4841.)

(There is a way to change to go-gitea/gitea#4847 such that the SDK doesn't need to change - but this involves describing the result of /users/search in the comment rather than extracting out to a separate object.)

The alternative is to change gitea to return a UserList instead and those fixes are on #120 & go-gitea/gitea#4846

@lafriks
Copy link
Member

lafriks commented Jan 27, 2019

Is this still needed?

@zeripath
Copy link
Author

Hmm. I think the swagger description is still a little special for very users list.

Needed is perhaps a strong word though.

Let me have another look.

@zeripath zeripath closed this May 4, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants