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

[3pt]Review openapi schema #1588

Open
4 tasks
fridex opened this issue Jan 5, 2022 · 4 comments
Open
4 tasks

[3pt]Review openapi schema #1588

fridex opened this issue Jan 5, 2022 · 4 comments
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/stack-guidance Categorizes an issue or PR as relevant to SIG Stack Guidance. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@fridex
Copy link
Contributor

fridex commented Jan 5, 2022

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 page are declared just once
  • check that HTTP headers in responses are well documented (ex. paginated responses)
@fridex fridex added kind/feature Categorizes issue or PR as related to a new feature. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Jan 5, 2022
@fridex fridex mentioned this issue Jan 7, 2022
Closed
1 task
@goern
Copy link
Member

goern commented Jan 17, 2022

/priority important-longterm

@sesheta sesheta added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Jan 17, 2022
@sesheta
Copy link
Member

sesheta commented Apr 17, 2022

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@sesheta sesheta added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 17, 2022
@harshad16
Copy link
Member

/lifecycle frozen

@sesheta sesheta added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 18, 2022
@harshad16
Copy link
Member

/triage accepted
/sig stack-guidance

@sesheta sesheta added triage/accepted Indicates an issue or PR is ready to be actively worked on. sig/stack-guidance Categorizes an issue or PR as relevant to SIG Stack Guidance. labels Jun 17, 2022
@mayaCostantini mayaCostantini changed the title Review openapi schema [3pt]Review openapi schema Jul 18, 2022
@goern goern added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. labels Feb 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/stack-guidance Categorizes an issue or PR as relevant to SIG Stack Guidance. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Planning Board
Status: 📋 Backlog
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update and polish OpenAPI schema fridex/user-api
4 participants
@goern @fridex @harshad16 @sesheta