-
Notifications
You must be signed in to change notification settings - Fork 17
Open
Labels
good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.kind/featureCategorizes issue or PR as related to a new feature.Categorizes issue or PR as related to a new feature.priority/backlogHigher priority than priority/awaiting-more-evidence.Higher priority than priority/awaiting-more-evidence.sig/stack-guidanceCategorizes an issue or PR as relevant to SIG Stack Guidance.Categorizes an issue or PR as relevant to SIG Stack Guidance.triage/acceptedIndicates an issue or PR is ready to be actively worked on.Indicates an issue or PR is ready to be actively worked on.
Description
Is your feature request related to a problem? Please describe.
As a user of Thoth and a consumer of API endpoints, I would like to have a clear overview of what API endpoints can provide, what are the outputs and responses.
Describe the solution you'd like
Review the openapi schema and unify it, namely:
- check that models are properly documented and are unified
- check that all the return codes are respected and documented in openapi
- make sure the schema is well structured - ex. it has references to the sections and comon inputs, such as
pageare declared just once - check that HTTP headers in responses are well documented (ex. paginated responses)
harshad16
Metadata
Metadata
Assignees
Labels
good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.kind/featureCategorizes issue or PR as related to a new feature.Categorizes issue or PR as related to a new feature.priority/backlogHigher priority than priority/awaiting-more-evidence.Higher priority than priority/awaiting-more-evidence.sig/stack-guidanceCategorizes an issue or PR as relevant to SIG Stack Guidance.Categorizes an issue or PR as relevant to SIG Stack Guidance.triage/acceptedIndicates an issue or PR is ready to be actively worked on.Indicates an issue or PR is ready to be actively worked on.
Type
Projects
Status
π Backlog