[fix] Add dashboard API filters to browsable API docs #715

[sargunn20]

Added @swagger_auto_schema to DashboardTimeseriesView.get() to expose
query parameters (organization_slug, location_id, floorplan_id, time,
start, end, timezone, csv) in the Swagger/browsable API documentation.

Since DashboardTimeseriesView extends APIView and manually reads query
parameters from request.query_params, drf-yasg had no way to discover them.

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.

Reference to Existing Issue

Closes #715

Description of Changes

• Added @swagger_auto_schema decorator to DashboardTimeseriesView.get() in monitoring/api/views.py with all 8 query parameters explicitly declared
• Added a regression test test_dashboard_api_filters_in_schema to verify the parameters are properly exposed

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a resilient OpenAPI/Swagger shim and documents DashboardTimeseriesView GET query parameters using swagger_auto_schema (manual_parameters: organization_slug, location_id, floorplan_id, time, start, end, timezone, csv). Introduces a fallback _OpenApiShim when drf_yasg is unavailable so imports do not fail. Adds a regression test test_dashboard_api_filters_in_schema to assert the documented parameter names. Also reformats multi-line JavaScript strings in several Selenium tests without functional changes. No runtime request handling or public method signatures were altered.

Sequence Diagram(s)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	❓ Inconclusive	The PR includes minimal out-of-scope changes: reformatting of JavaScript strings in test_selenium.py unrelated to the main objective, and addition of an OpenAPI shim for resilience.	Clarify whether the test_selenium.py formatting changes and OpenAPI shim addition are intentional or should be removed to keep the PR focused on issue #715.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: adding dashboard API filters to browsable API docs to address issue #715.
Description check	✅ Passed	The description covers the main change, rationale, test additions, checklist completion, and issue reference; all required template sections are addressed.
Linked Issues check	✅ Passed	The PR successfully implements the requirement to expose 8 query parameters in Swagger/browsable API docs via @swagger_auto_schema decorator and includes regression test verification.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@openwisp_monitoring/monitoring/api/views.py`:
- Around line 3-4: Unconditional drf_yasg imports cause import errors when the
package is not installed; either add drf-yasg to runtime dependencies or guard
the imports and provide fallbacks: wrap the imports of openapi and
swagger_auto_schema in a try/except ImportError and, on ImportError, define
no-op stand-ins (e.g., a dummy swagger_auto_schema decorator and a minimal
openapi namespace) so code using `@swagger_auto_schema` (used on the view
function/class where the decorator is applied) continues to import in
environments without drf_yasg.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5a49c671-8e5d-4f2e-9439-02b0e6983f45

📥 Commits

Reviewing files that changed from the base of the PR and between cbb97c0 and cfb8707.

📒 Files selected for processing (2)

• openwisp_monitoring/monitoring/api/views.py
• openwisp_monitoring/monitoring/tests/test_api.py

📜 Review details

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

• GitHub Check: Python==3.10 | django~=4.2.0
• GitHub Check: Python==3.12 | django~=4.2.0
• GitHub Check: Python==3.12 | django~=5.2.0
• GitHub Check: Python==3.10 | django~=5.1.0
• GitHub Check: Python==3.12 | django~=5.1.0
• GitHub Check: Python==3.11 | django~=4.2.0
• GitHub Check: Python==3.13 | django~=5.1.0
• GitHub Check: Python==3.11 | django~=5.2.0
• GitHub Check: Python==3.11 | django~=5.1.0
• GitHub Check: Python==3.13 | django~=5.2.0
• GitHub Check: Python==3.10 | django~=5.2.0

🧰 Additional context used

🧠 Learnings (3)

📚 Learning: 2026-02-21T01:03:37.822Z

Learnt from: nemesifier
Repo: openwisp/openwisp-monitoring PR: 738
File: openwisp_monitoring/tests/test_selenium.py:827-859
Timestamp: 2026-02-21T01:03:37.822Z
Learning: In Selenium tests (e.g., in openwisp_monitoring/tests/test_selenium.py and similar test files), when testing JS animations on dashboards or elements driven by JavaScript (such as real-time location updates), insert a short sleep (e.g., sleep(0.3)) before WebDriverWait assertions to allow animations to complete and reduce flakiness. Note: use this as a targeted workaround and prefer explicit waits or animation-end checks where possible to avoid relying on fixed delays.

Applied to files:

• openwisp_monitoring/monitoring/tests/test_api.py

📚 Learning: 2026-02-21T18:44:28.852Z

Learnt from: dee077
Repo: openwisp/openwisp-monitoring PR: 738
File: openwisp_monitoring/device/api/views.py:263-281
Timestamp: 2026-02-21T18:44:28.852Z
Learning: In openwisp-monitoring, MonitoringIndoorCoordinatesList inherits organization scoping from the parent IndoorCoordinatesList (from openwisp-controller), which uses FilterByParentManaged mixin and filters by location_id in get_queryset(). The child class only overrides the queryset attribute to add monitoring-specific select_related fields; this pattern is safe as long as get_queryset() from the parent is not bypassed. During reviews, verify that MonitoringIndoorCoordinatesList continues to rely on the parent's get_queryset() and that any added select_related fields in the child do not alter the parent's filtering logic.

Applied to files:

• openwisp_monitoring/monitoring/tests/test_api.py
• openwisp_monitoring/monitoring/api/views.py

📚 Learning: 2026-02-25T18:42:08.825Z

Learnt from: dee077
Repo: openwisp/openwisp-monitoring PR: 738
File: openwisp_monitoring/tests/test_selenium.py:309-317
Timestamp: 2026-02-25T18:42:08.825Z
Learning: In Selenium tests that use ChannelsLiveServerTestCase (e.g., openwisp_monitoring/tests/test_selenium.py), override settings to configure CHANNEL_LAYERS with channels_redis.core.RedisChannelLayer instead of InMemoryChannelLayer. This is required because the live server runs in a separate process from the test process, and InMemoryChannelLayer is per-process only and cannot handle cross-process WebSocket broadcasting needed for real-time location update tests.

Applied to files:

• openwisp_monitoring/monitoring/tests/test_api.py

🔇 Additional comments (2)

openwisp_monitoring/monitoring/api/views.py (1)

186-243: Good schema coverage for dashboard filters.

The manual parameter set matches the dashboard query filters and closes the discoverability gap in browsable/Swagger docs.

openwisp_monitoring/monitoring/tests/test_api.py (1)

728-760: Regression test is focused and useful.

This test cleanly enforces the exact documented filter set for the dashboard schema.

[sargunn20]

Just noting that the two CI failures (Python 3.12/3.13 with Django 5.2) appear to be pre-existing issues in the repository and are unrelated to these changes, identical to the failures in #716.

[atif09]

There is an unresolved comment made by code rabbit, please address it or reply to it saying why you dont agree to it

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@openwisp_monitoring/monitoring/api/views.py`:
- Around line 19-23: The fallback swagger_auto_schema decorator currently
returns the original function without metadata; update the swagger_auto_schema
in monitoring/api/views.py so the inner _decorator attaches the decorator kwargs
(or a representative object) as func._swagger_auto_schema before returning func
(i.e., set func._swagger_auto_schema = kwargs or similar) so tests like
test_dashboard_api_filters_in_schema can introspect the stored parameters from
DashboardTimeseriesView.get._swagger_auto_schema.

In `@openwisp_monitoring/monitoring/tests/test_api.py`:
- Around line 728-759: The test test_dashboard_api_filters_in_schema fails when
drf_yasg is not installed because manual_parameters may contain None from the
shim; update the test function test_dashboard_api_filters_in_schema to import
drf_yasg in a try/except and call self.skipTest("drf_yasg is not installed")
when ImportError is raised so the rest of the assertions against
DashboardTimeseriesView.get and its "_swagger_auto_schema" decorator only run
when drf_yasg is available.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: baba5074-16a5-4a59-b89d-151ecfdadecf

📥 Commits

Reviewing files that changed from the base of the PR and between cfb8707 and 0029558.

📒 Files selected for processing (3)

• openwisp_monitoring/monitoring/api/views.py
• openwisp_monitoring/monitoring/tests/test_api.py
• openwisp_monitoring/tests/test_selenium.py

📜 Review details

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)

• GitHub Check: Python==3.11 | django~=5.1.0
• GitHub Check: Python==3.10 | django~=5.1.0
• GitHub Check: Python==3.11 | django~=5.2.0
• GitHub Check: Python==3.12 | django~=4.2.0
• GitHub Check: Python==3.10 | django~=4.2.0
• GitHub Check: Python==3.11 | django~=4.2.0
• GitHub Check: Python==3.10 | django~=5.2.0
• GitHub Check: Python==3.12 | django~=5.1.0
• GitHub Check: Python==3.13 | django~=5.1.0

🧰 Additional context used

🧠 Learnings (3)

📚 Learning: 2026-02-21T01:03:37.822Z

Learnt from: nemesifier
Repo: openwisp/openwisp-monitoring PR: 738
File: openwisp_monitoring/tests/test_selenium.py:827-859
Timestamp: 2026-02-21T01:03:37.822Z
Learning: In Selenium tests (e.g., in openwisp_monitoring/tests/test_selenium.py and similar test files), when testing JS animations on dashboards or elements driven by JavaScript (such as real-time location updates), insert a short sleep (e.g., sleep(0.3)) before WebDriverWait assertions to allow animations to complete and reduce flakiness. Note: use this as a targeted workaround and prefer explicit waits or animation-end checks where possible to avoid relying on fixed delays.

Applied to files:

• openwisp_monitoring/monitoring/tests/test_api.py
• openwisp_monitoring/tests/test_selenium.py

📚 Learning: 2026-02-21T18:44:28.852Z

Learnt from: dee077
Repo: openwisp/openwisp-monitoring PR: 738
File: openwisp_monitoring/device/api/views.py:263-281
Timestamp: 2026-02-21T18:44:28.852Z
Learning: In openwisp-monitoring, MonitoringIndoorCoordinatesList inherits organization scoping from the parent IndoorCoordinatesList (from openwisp-controller), which uses FilterByParentManaged mixin and filters by location_id in get_queryset(). The child class only overrides the queryset attribute to add monitoring-specific select_related fields; this pattern is safe as long as get_queryset() from the parent is not bypassed. During reviews, verify that MonitoringIndoorCoordinatesList continues to rely on the parent's get_queryset() and that any added select_related fields in the child do not alter the parent's filtering logic.

Applied to files:

• openwisp_monitoring/monitoring/tests/test_api.py
• openwisp_monitoring/tests/test_selenium.py
• openwisp_monitoring/monitoring/api/views.py

📚 Learning: 2026-02-25T18:42:08.825Z

Learnt from: dee077
Repo: openwisp/openwisp-monitoring PR: 738
File: openwisp_monitoring/tests/test_selenium.py:309-317
Timestamp: 2026-02-25T18:42:08.825Z
Learning: In Selenium tests that use ChannelsLiveServerTestCase (e.g., openwisp_monitoring/tests/test_selenium.py), override settings to configure CHANNEL_LAYERS with channels_redis.core.RedisChannelLayer instead of InMemoryChannelLayer. This is required because the live server runs in a separate process from the test process, and InMemoryChannelLayer is per-process only and cannot handle cross-process WebSocket broadcasting needed for real-time location update tests.

Applied to files:

• openwisp_monitoring/monitoring/tests/test_api.py
• openwisp_monitoring/tests/test_selenium.py

🔇 Additional comments (2)

openwisp_monitoring/tests/test_selenium.py (1)

763-769: LGTM!

The changes are purely cosmetic - reflowing multi-line JavaScript string literals without altering the executed code. No functional impact.

Also applies to: 780-786, 836-844, 870-878, 903-911

openwisp_monitoring/monitoring/api/views.py (1)

207-265: LGTM!

The @swagger_auto_schema decorator correctly documents all eight query parameters used by DashboardTimeseriesView and its parent MonitoringApiViewMixin. The parameter descriptions are accurate and align with the implementation.

[sargunn20]

There is an unresolved comment made by code rabbit, please address it or reply to it saying why you dont agree to it

[sargunn20]

@atif09 Thanks for the catch! Just wanted to note that I've addressed the CodeRabbit comment. The drf_yasg imports (openapi and swagger_auto_schema) are now wrapped in a try...except ImportError block with fallback shims. This ensures production environments won't get ImportErrors if drf-yasg isn't installed. The fix is pushed and the CodeRabbit conversation is resolved!

[nemesifier]

@sargunn20 why did you close this?