Dna docs open api spec only - #204
Merged
Merged
Conversation
FastAPI already generates the spec at /openapi.json; export it to docs/openapi.json so the API surface shows up in review and can feed client codegen without a running server. - scripts/export_openapi.py writes the spec (sorted keys, stable diffs) and has a --check mode for staleness - tests/test_openapi_spec.py fails on drift, and on any endpoint missing a tag, summary, description, or security requirement - make openapi / make openapi-check for regeneration via the api container - declare the Attachments tag and add docstrings to the five Note QC handlers, both of which the new checks caught as gaps - document the spec and regen workflow in the backend README Signed-off-by: Cameron Target <camerontarget@gmail.com>
Signed-off-by: Cameron Target <camerontarget@gmail.com>
Signed-off-by: Cameron Target <camerontarget@gmail.com>
Signed-off-by: Cameron Target <camerontarget@gmail.com>
The spec was exported from the backend/OpenAPI_spec branch, whose base differs from this one, so the drift test failed after the replay. Rerun scripts/export_openapi.py and dna-docs/scripts/fetch-openapi.sh. Drops the five /rv-sync/* paths (not present on this branch) and picks up the add_version request changes (version_name/project_id/link_entity_*). Signed-off-by: Cameron Target <camerontarget@gmail.com>
Signed-off-by: Cameron Target <camerontarget@gmail.com>
3 tasks
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.
Summary
Added OpenAPI spec as well as the docusaurus documentation for DNA.
Testing
How I Tested
Stood the docs site up in a browser.