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.

Sign up for GitHub

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

Jump to bottom

⚡ OpenAPI Documents #3668

Open
3 tasks
LocalNewsTV opened this issue Nov 13, 2024 · 0 comments
Open
3 tasks

⚡ OpenAPI Documents #3668

LocalNewsTV opened this issue Nov 13, 2024 · 0 comments
Labels
Documentation Improvements or additions to documentation Enhancement New feature or request to be prioritized by team and PO

Comments

@LocalNewsTV
Copy link
Collaborator

Describe the task

If the task will only make sense to a dev, add a ⚡ to the title.

Rewrite the OpenAPI Docs in our endpoints to be less boilerplate / general, and more tuned to our application to shed more context on the application

Value Add

  • More Usable Docs
  • Living Documentation in the Repo
  • Helps internal and external developers understand the application

Acceptance Criteria

  • Rewrite OpenAPI Docs to be less general and more specific to their use cases
  • second
  • third

Additional Context
@LocalNewsTV LocalNewsTV added Documentation Improvements or additions to documentation Enhancement New feature or request to be prioritized by team and PO labels Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Improvements or additions to documentation Enhancement New feature or request to be prioritized by team and PO
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@LocalNewsTV