[change] Added CSV batch download endpoint visibility on Swagger #602
Conversation
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
Wrapped PrivateStorageDetailView with DRF APIView and added @extend_schema metadata for Swagger documentation generation. This ensures the CSV download endpoint is now visible and documented properly in the Swagger UI. Fixes openwisp#373
Tested visibility of csv batch download endpoint on swagger and working of the endpoint via admin dashboad and curl. Fixes openwisp#373
github-project-automation
bot
moved this to To do (general)
in OpenWISP Contributor's Board
Added drf-spectacular in requirements-test.txt tp prevent build failure. Fixes openwisp#373
nemesifier
requested changes
Sep 20, 2025
|
|
||
|
|
||
| # this is a drf wrapper view | ||
| @extend_schema( |
There was a problem hiding this comment.
It should not be needed to add a new dependency to do this, please refer to https://github.com/openwisp/openwisp-controller/pull/1086/files#diff-3e530f9831121ff0f6b2c2d5a9dcb9ffe54d1bba1a1e3629095b50bce9521f88R79-R91.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Checklist
Reference to Existing Issue
Closes #373.
Description of Changes
Integrated PrivateStorageDetailView within a DRF APIView and applied @extend_schema to enable proper Swagger documentation. This update ensures the CSV download endpoint is both functional and visible in the Swagger UI. Verified the endpoint works correctly and appears as expected in the API docs.
Screenshot