Re-introduce OpenAPI schema documentation for NAV API#3380
Draft
lunkwill42 wants to merge 3 commits intomasterfrom
Draft
Re-introduce OpenAPI schema documentation for NAV API#3380lunkwill42 wants to merge 3 commits intomasterfrom
lunkwill42 wants to merge 3 commits intomasterfrom
Conversation
For OpenAPI schema generation.
lunkwill42
added
nonews
lunkwill42
force-pushed
the
feature/openapi-schema
branch
from
8c22277 to
aab16fd
Compare
Test results 12 files 12 suites 11m 43s ⏱️ Results for commit 494fb75. ♻️ This comment has been updated with latest results. |
lunkwill42
force-pushed
the
feature/openapi-schema
branch
from
aab16fd to
494fb75
Compare
|
Member
Author
|
I really don't think the OpenAPI output is up-to-snuff - but this may simply be because our DRF API definitions are pretty screwed up. I tried generating a Python API client (using openapi-python-client) from the spec produced by this PR, and it was pretty wonky and non-functional, making references to things that don't exist in our schema. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When the NAV API first began, it did automatically provide an OpenAPI schema, courtesy of Django REST Framework (DRF). However, at some point, DRF removed this functionality and it was unintentionally lost from NAV because we never noticed.
This PR tries to add back in an OpenAPI schema (and a swagger-ui schema browser) using
drf-spectacular. I'm leaving it as a draft so we can test and discuss what this should look like.Sticking the
nonewslabel on it while in draft-mode, since I don't know what to write in a news fragment until this feature has taken its final shape.