Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger: Fix response for the search users endpoint #71272

Merged
merged 2 commits into from Jul 13, 2023
Merged

Conversation

papagian
Copy link
Contributor

@papagian papagian commented Jul 10, 2023

What is this feature?

[Add a brief description of what the feature or update does.]

Why do we need this feature?

[Add a description of the problem the feature is trying to solve.]

Who is this feature for?

[Add information on what kind of user the feature is for.]

Which issue(s) does this PR fix?:

Fixes #71106

Special notes for your reviewer:
to review the changes:
start grafana server and navigate to:
http://localhost:3000/swagger-ui#/users/searchUsers
http://localhost:3000/swagger-ui#/users/searchUsersWithPaging

in the specification there are additional changes because in #65241
the enterprise endpoints were removed (the specification was generated without enterprise enabled) and re-introduced in this one

Please check that:

  • It works as expected from a user's perspective.
  • If this is a pre-GA feature, it is behind a feature toggle.
  • The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

@papagian papagian added this to the 10.1.x milestone Jul 10, 2023
@papagian papagian requested a review from a team as a code owner July 10, 2023 10:37
@papagian papagian requested review from sakjur, zserge and yangkb09 and removed request for a team July 10, 2023 10:37
@papagian papagian merged commit 32ff712 into main Jul 13, 2023
21 checks passed
@papagian papagian deleted the papagian/fix-71106 branch July 13, 2023 08:35
polibb pushed a commit that referenced this pull request Jul 14, 2023
* Regenerate OpenAPI specs for fetching the latest changes

* Fix swagger annotations for search users API
@ricky-undeadcoders ricky-undeadcoders modified the milestones: 10.1.x, 10.1.0 Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

HTTP-API - searchUsers response schema mismatch
4 participants