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

write full OpenAPI spec for api3 (look into drf-spectacular & drf-yasg) #246

Open
Tracked by #238
JasonLovesDoggo opened this issue Jan 3, 2024 · 4 comments
Open
Tracked by #238

write full OpenAPI spec for api3 (look into drf-spectacular & drf-yasg) #246

JasonLovesDoggo opened this issue Jan 3, 2024 · 4 comments
Assignees
@JasonLovesDoggo @ohi-711 @Cqctxs
Labels
documentation Improvements or additions to documentation enhancement New feature or request p2 An issue that needs to be addressed on a reasonable timescale.
Milestone
End of January

Comments

@JasonLovesDoggo
Copy link
Member

No description provided.

@JasonLovesDoggo JasonLovesDoggo mentioned this issue Jan 3, 2024
Open
9 tasks
@JasonLovesDoggo
Copy link
Member Author

drf-spectacular

has been chosen

JasonLovesDoggo added a commit that referenced this issue Jan 3, 2024
@JasonLovesDoggo
started working on #246
6e50164
@JasonLovesDoggo
Copy link
Member Author

https://www.rootstrap.com/blog/automating-django-rest-apis-documentation-made-easy-with-drf-spectacular-part-2
https://www.rootstrap.com/blog/automating-django-rest-apis-documentation-made-easy-with-drf-spectacular-part-1

quite helpful as examples

@JasonLovesDoggo JasonLovesDoggo added documentation Improvements or additions to documentation enhancement New feature or request p2 An issue that needs to be addressed on a reasonable timescale. labels Jan 6, 2024
@JasonLovesDoggo JasonLovesDoggo added this to the End of January milestone Jan 6, 2024
@JasonLovesDoggo
Copy link
Member Author

For comments https://drf-spectacular.readthedocs.io/en/latest/blueprints.html#polymorphic-models
may be needed

@JasonLovesDoggo
Copy link
Member Author

api3 sans api3/obj: @Cqctxs
standard api (all endpoints besides api3): @ohi-711
api3 objects: @JasonLovesDoggo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JasonLovesDoggo JasonLovesDoggo

@ohi-711 ohi-711

@Cqctxs Cqctxs

Labels
documentation Improvements or additions to documentation enhancement New feature or request p2 An issue that needs to be addressed on a reasonable timescale.
Projects
None yet
Milestone
End of January
Development

No branches or pull requests
3 participants
@JasonLovesDoggo @ohi-711 @Cqctxs