Skip to content

Conversation

@KarthikSKumar98
Copy link
Collaborator

@KarthikSKumar98 KarthikSKumar98 commented Dec 10, 2025

This release focuses on expanding troubleshooting capabilities and improving how the SDK documents and exposes its public APIs.

New Features

  • Added new troubleshooting modules that expose additional troubleshooting methods - list_show_commands, list_active_tasks, run_show_command, initiate_show_command, get_show_command_result
  • Introduced troubleshooting helpers in the Devices class to support new methods mentioned above.

Updates

  • Migrated docstrings from Sphinx style to Google style across core modules (e.g. Devices, Monitoring, Troubleshooting, Sites, Profiles, and related utilities).
    • Standardized parameter/return/exception sections for better readability and IDE support.
    • Added missing docstrings for existing public methods to keep behavior and usage clearly documented.
  • Removed legacy Sphinx documentation files that are no longer used by the current docs pipeline.
  • Removed unused custom exceptions such as UnsupportedCapabilityError & GenericOperationError
  • Replaced direct exit calls with raised exceptions so error handling is consistent and easier for applications to manage.

Improvements

  • Removed duplicate endpoint implementations in the Devices class where equivalent functionality already exists in the Monitoring modules; Devices now reuses the Monitoring implementations instead of maintaining separate copies.
  • Improved overall error-handling to align with the new exception model.

Karthik Satheesh Kumar added 11 commits December 10, 2025 06:47
…documentation -

- Updated docstrings in base_utils.py to provide clearer descriptions of function parameters, return types, and exceptions.
- Enhanced docstrings in common_utils.py for better clarity on attribute setting and file parsing functions.
- Revised constants.py to improve the description of constant values and their usage.
- Improved glp_utils.py documentation for rate limiting and API progress checking functions.
- Clarified monitoring_utils.py functions with detailed descriptions of parameters and return values.
- Enhanced profile_utils.py to provide better validation documentation for local profile attributes.
- Updated scope_utils.py to improve clarity on fetching and updating attributes, as well as API calls for scope elements.
- Enhanced troubleshooting_utils.py with detailed descriptions of supported device types and troubleshooting mappings.
- Improved url_utils.py documentation for URL prefix and generation functions, including parameter and return type descriptions.
…alization for clearer messages & removed exit() usage in all modules
…s, run_show_command, and list_active_tasks
…e error logging for inventory fetch failures
@KarthikSKumar98 KarthikSKumar98 merged commit eb59aa8 into v2(pre-release) Dec 10, 2025
@KarthikSKumar98 KarthikSKumar98 deleted the v2.0a12 branch December 10, 2025 15:53
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.

2 participants