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

docs: add swagger ui in docs #15241

Merged
merged 5 commits into from
Mar 2, 2023
Merged

docs: add swagger ui in docs #15241

merged 5 commits into from
Mar 2, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Mar 2, 2023

Description

Closes: #15112
ref: #15209 (comment)

Note: there is no endpoint to query behind, as it will be the same swagger that there are on nodes, but on GH Pages (where our docs is deployed).


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@julienrbrt julienrbrt requested review from tac0turtle and a team as code owners March 2, 2023 11:57
@github-prbot github-prbot requested review from a team and aaronc and removed request for a team March 2, 2023 11:57
@tac0turtle
Copy link
Member

as long as we document that a user can input an endpoint that works

@julienrbrt
Copy link
Member Author

julienrbrt commented Mar 2, 2023

as long as we document that a user can input an endpoint that works

Unfortunately, not presently. It does not seem like you can let an user input a host url (https://swagger.io/docs/specification/2-0/api-host-and-base-path/).
It seems like it needs to be defined in the swagger.yaml.

EDIT: NVM, we can always use the url to set another endpoint.

@julienrbrt julienrbrt enabled auto-merge (squash) March 2, 2023 12:38
@github-actions github-actions bot added the C:CLI label Mar 2, 2023
@julienrbrt julienrbrt merged commit 0141817 into main Mar 2, 2023
@julienrbrt julienrbrt deleted the julien/swagg branch March 2, 2023 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: swagger docs are outdated and dont work.
2 participants