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

chore: correct api docs #17622

Merged
merged 2 commits into from
Sep 5, 2023
Merged

chore: correct api docs #17622

merged 2 commits into from
Sep 5, 2023

Conversation

tac0turtle
Copy link
Member

Description

swagger is not on by default and mention all endpoints point to localhost by default


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
  • run make lint and make test
  • 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)

@tac0turtle tac0turtle marked this pull request as ready for review September 5, 2023 07:45
@tac0turtle tac0turtle requested a review from a team as a code owner September 5, 2023 07:45
@tac0turtle tac0turtle added T:Docs Changes and features related to documentation. backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release labels Sep 5, 2023
@tac0turtle tac0turtle added this pull request to the merge queue Sep 5, 2023
Merged via the queue into main with commit d73f047 Sep 5, 2023
42 checks passed
@tac0turtle tac0turtle deleted the marko/api_docs branch September 5, 2023 08:29
mergify bot pushed a commit that referenced this pull request Sep 5, 2023
(cherry picked from commit d73f047)
tac0turtle added a commit that referenced this pull request Sep 5, 2023
Co-authored-by: Marko <marbar3778@yahoo.com>
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants