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

Update swagger documentation #2063

Closed
4 tasks
iramiller opened this issue Jul 2, 2024 · 1 comment · Fixed by #2070
Closed
4 tasks

Update swagger documentation #2063

iramiller opened this issue Jul 2, 2024 · 1 comment · Fixed by #2070
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@iramiller
Copy link
Member

Summary

Current swagger documentation could use some additional refinement and grouping of methods along with general dependency updates

Problem Definition

The current swagger listing puts all endpoints in one very large list without any categories. In addition it relies on the out of date statik build/resource flow instead of the native go embed approach.

Proposal

  • Update the swagger/openapi build flow with additional documentation, descriptions, and method tag organization.
  • Move to the go embed flow from the existing statik compiled resource approach.
  • Update to current versions of the swagger bundled css/javascript

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@iramiller iramiller added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 2, 2024
@SpicyLemon
Copy link
Contributor

Issue #404 looks like a copy of this one, so I'm closing that one. It linked to a related SDK issue as a reference, and also an article about swagger 2 vs openapi 3: https://medium.com/@tgtshanika/open-api-3-0-vs-swagger-2-0-94a80f121022

@SpicyLemon SpicyLemon added this to the v1.19.0 milestone Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Development

Successfully merging a pull request may close this issue.

2 participants