Skip to content

Conversation

@Piyushrathoree
Copy link

@Piyushrathoree Piyushrathoree commented Nov 2, 2025

monitoring/api/views.py added the rest api parameters in the swagger docs #715.

there are some parameter on api/v1/monitoring/dashboard endpoint which are mentioned in the api docs but those parameter are not available in the swagger docs and redoc, and my changes solve this issue I have implemented the @swagger_auto_schema decorator which lets this parameter appear in the swagger ui and redoc.

fixes #715

Checklist

  • I have read the OpenWISP Contributing Guidelines.
  • I have manually tested the changes proposed in this pull request.
  • I have written new test cases for new code and/or updated existing tests for changes to existing code.
  • I have updated the documentation.

Description of Changes

first the swagger ui was not showing the parameter fields on api/v1/monitoring/dashboard endpoint in swagger and redoc , and I've made some changes which lets the parameter fields appear in swagger and redoc docs.

Screenshot

image

@Piyushrathoree
Copy link
Author

PTAL @nemesifier

@Piyushrathoree Piyushrathoree force-pushed the issue/715-bug-Dashboard-API-filters-not-shown-in-API-docs/browsable-API branch from dd02077 to ca71922 Compare November 28, 2025 17:14
@Piyushrathoree Piyushrathoree changed the title monitoring/api/viewws.py added the rest api parameters in the swagge… monitoring/api/views.py added the rest api parameters in the swagge… Dec 2, 2025
@Piyushrathoree
Copy link
Author

@pandafy could you please review this , or if there is any problem please let me know so that I can fix it

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[bug] Dashboard API filters not shown in API docs/browsable API

1 participant