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

API: Enable serving Swagger UI by default and add docs and guidelines #63489

Merged
merged 8 commits into from
Mar 1, 2023

Conversation

papagian
Copy link
Contributor

What is this feature?

  • removes swaggerUi feature toggle
  • enables serving the Swagger UI by default (it used to be behind the feature flag)
  • updates HTTP API docs
  • adds developer guidelines for maintaining the specifications

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 #

Special notes for your reviewer:

@papagian papagian added no-backport Skip backport of PR no-changelog Skip including change in changelog/release notes labels Feb 21, 2023
@papagian papagian added this to the 9.5.0 milestone Feb 21, 2023
@papagian papagian requested review from a team and chri2547 as code owners February 21, 2023 11:07
@papagian papagian requested review from joshhunt, JoaoSilvaGrafana, mckn, sakjur, mildwonkey and yangkb09 and removed request for a team February 21, 2023 11:07
@grafanabot grafanabot added area/backend area/frontend type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project labels Feb 21, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 21, 2023

⚠️   Possible breaking changes

(Open the links below in a new tab to go to the correct steps)

grafana-data has possible breaking changes (more info)

Console output
Read our guideline

@grafanabot grafanabot added the levitate breaking change A label indicating a breaking change and assigned by Levitate. label Feb 21, 2023
papagian and others added 2 commits February 21, 2023 13:48
Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
Copy link
Collaborator

@chri2547 chri2547 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The feature toggles docs removal LGTM, so approved pending Engr approval. Including @josmperez to take a look at the addition to the dev docs. Thank you for the contribution!

@chri2547 chri2547 requested a review from josmperez February 23, 2023 16:23
pkg/api/README.md Outdated Show resolved Hide resolved
pkg/api/README.md Outdated Show resolved Hide resolved
pkg/api/README.md Outdated Show resolved Hide resolved
pkg/api/README.md Outdated Show resolved Hide resolved
pkg/api/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@josmperez josmperez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor editorial suggestions.

Copy link
Contributor

@mckn mckn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@papagian papagian requested a review from Eve832 as a code owner February 24, 2023 15:51
@papagian papagian requested a review from josmperez February 24, 2023 15:54
@papagian
Copy link
Contributor Author

@josmperez I made some changes following your review; can you check once again, thank you!

@papagian papagian added add to changelog and removed no-changelog Skip including change in changelog/release notes labels Mar 1, 2023
@papagian papagian merged commit 8aae7be into main Mar 1, 2023
@papagian papagian deleted the papagian/enable-swagger-ui branch March 1, 2023 14:36
ryantxu pushed a commit that referenced this pull request Mar 2, 2023
…#63489)

* Enable serving Swagger UI by default

It used to be served behind the `swaggerUi` feature toggle.

* Remove `swaggerUi` feature toggle

* Add docs and guidelines for updating swagger

* Apply suggestions from code review

Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
@BartG95
Copy link

BartG95 commented Apr 26, 2023

Please be advised that this feature loads stuff from unpkg.com, which to me is a third party. Both technical measures such as CSP, and legal measures such as the GDPR, may prevent this from working.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add to changelog area/backend area/frontend levitate breaking change A label indicating a breaking change and assigned by Levitate. no-backport Skip backport of PR type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants