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

Gateway: add swagger / openapi docs #1165

Closed
IceKhan13 opened this issue Jan 17, 2024 · 3 comments · Fixed by #1205
Closed

Gateway: add swagger / openapi docs #1165

IceKhan13 opened this issue Jan 17, 2024 · 3 comments · Fixed by #1205
Assignees
@david-alber
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers priority: high High priority project: gateway Label to identify features related with gateway project
Milestone
Q1'24

Comments

@IceKhan13
Copy link
Member

What is the expected enhancement?

Add swagger and openapi docs for gateway and document everything related to that API.

Epic #1164
@IceKhan13 IceKhan13 added documentation Improvements or additions to documentation good first issue Good for newcomers priority: high High priority project: gateway Label to identify features related with gateway project labels Jan 17, 2024
@IceKhan13 IceKhan13 added this to the Q1'24 milestone Jan 17, 2024
@IceKhan13 IceKhan13 mentioned this issue Jan 17, 2024
Open
@IceKhan13 IceKhan13 self-assigned this Jan 18, 2024
@david-alber
Copy link
Contributor

hi @IceKhan13 are you on this already?
If still available, I would love to give it a shot to learn more about gateway APIs.

@IceKhan13
Copy link
Member Author

IceKhan13 commented Jan 22, 2024 •
edited
Loading

Hey @david-alber ! Sure, take it away! and let us know if you need anything

Assigned to you!

@IceKhan13 IceKhan13 assigned david-alber and unassigned IceKhan13 Jan 22, 2024
@IceKhan13
Copy link
Member Author

ref https://drf-yasg.readthedocs.io/en/stable/readme.html#openapi-3-0-note

@david-alber david-alber mentioned this issue Feb 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@david-alber david-alber

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers priority: high High priority project: gateway Label to identify features related with gateway project
Projects
None yet
Milestone
Q1'24
Development

Successfully merging a pull request may close this issue.

Adding Swagger documentation to Gateway david-alber/quantum-serverless
2 participants
@IceKhan13 @david-alber