feat(api): Implement dfr-spectacular for OpenAPI spec generation#1378
feat(api): Implement dfr-spectacular for OpenAPI spec generation#137866Bunz wants to merge 9 commits intoFuzzyGrim:feat/add-apifrom
Conversation
…-spectacular and update API authentication methods Co-authored-by: Copilot <copilot@github.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request integrates drf-spectacular for automated OpenAPI schema generation, adding a dedicated management command, documentation instructions, and configurable schema/UI endpoints. Feedback suggests using settings.BASE_DIR for more robust path resolution in the management command and referencing the project's VERSION constant in the configuration to ensure consistency.
| SPECTACULAR_SETTINGS = { | ||
| "TITLE": "Yamtrack API", | ||
| "DESCRIPTION": "OpenAPI schema for Yamtrack's API", | ||
| "VERSION": "0.0.25", |
There was a problem hiding this comment.
The version string is hardcoded here, but a VERSION constant is already defined on line 348 (retrieved from environment variables). Using the existing constant ensures that the OpenAPI documentation stays in sync with the application version.
| "VERSION": "0.0.25", | |
| "VERSION": VERSION, |
There was a problem hiding this comment.
Maybe when the API will be stable, not now
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <copilot@github.com>
…ar spec generation Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <copilot@github.com>
…o endpoints Co-authored-by: Copilot <copilot@github.com>
…istics endpoints Co-authored-by: Copilot <copilot@github.com>
1 participant
No description provided.