| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
|
Hi, please take a look at this: https://github.com/splunk/splunk-sdk-python/blob/develop/CONTRIBUTING.md |
Sorry, something went wrong.
|
Thanks for the pointer — here's where this PR stands against CONTRIBUTING.md:
Let me know if anything else is needed to move this forward. |
Sorry, something went wrong.
| Back | FazBrowse Home | New Git URL |
Description of PR
Adds a Dashboard entity and Dashboards collection to splunklib.client, wrapping the data/ui/views/ REST endpoint.
The SDK already provides entity classes for most Splunk resources (indexes, saved searches, inputs, apps, etc.), but dashboards are missing — users currently have to use raw service.get()/service.post() calls. This PR follows the same Entity/Collection pattern used by SavedSearch, Index, Application, and others.
Changes:
Usage:
Testing the changes
Unit tests added in tests/unit/test_dashboard.py (7 tests):
Tested with Python 3.13, Splunk Enterprise 10.4.0. Passes ruff check, ruff format, and basedpyright.
Documentation
Docstrings follow the existing SDK conventions (:return:, :rtype:, :param:). The Service.dashboards property is documented consistently with Service.saved_searches, Service.indexes, etc.
Dependencies and other resources
No external dependencies. Follows the same Entity/Collection pattern as the existing SavedSearch, Index, Application, and Macro classes in client.py.