Merge pull request #79 from cisco-en-programmability/develop

Develop

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,6 +10,7 @@ assignees: ''
 **Prerequisites**
 * [ ] Have you tested the operation in the API directly?
 * [ ] Do you have the latest SDK version?
+* [ ] Review the [compatibility matrix](https://github.com/cisco-en-programmability/dnacentersdk/tree/master#compatibility-matrix) before opening an issue.
 
 **Describe the bug**
 A clear and concise description of what the bug is.

CHANGELOG.md

@@ -6,6 +6,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.5.6] - 2023-01-10
+
+### Added
+- Compatibility matrix added in `readme.rst`
+
+### Fixed
+- Offset and limit now support basestring and int
+  + dnacentersdk.api.v2_3_3_0.application_policy
+  + dnacentersdk.api.v2_3_3_0.applications
+  + dnacentersdk.api.v2_3_3_0.compliance
+  + dnacentersdk.api.v2_3_3_0.configuration_templates
+  + dnacentersdk.api.v2_3_3_0.device_onboarding_pnp
+  + dnacentersdk.api.v2_3_3_0.device_replacement
+  + dnacentersdk.api.v2_3_3_0.devices
+  + dnacentersdk.api.v2_3_3_0.discovery
+  + dnacentersdk.api.v2_3_3_0.event_management
+  + dnacentersdk.api.v2_3_3_0.health_and_performance
+  + dnacentersdk.api.v2_3_3_0.lan_automation
+  + dnacentersdk.api.v2_3_3_0.licenses
+  + dnacentersdk.api.v2_3_3_0.network_settings
+  + dnacentersdk.api.v2_3_3_0.path_trace
+  + dnacentersdk.api.v2_3_3_0.site_design
+  + dnacentersdk.api.v2_3_3_0.sites
+  + dnacentersdk.api.v2_3_3_0.software_image_management_swim
+  + dnacentersdk.api.v2_3_3_0.tag
+  + dnacentersdk.api.v2_3_3_0.task
+
 ## [2.5.5] - 2022-11-17
 
 ### Fixed
@@ -360,4 +387,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [2.5.3]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.5.2...v2.5.3
 [2.5.4]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.5.3...v2.5.4
 [2.5.5]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.5.4...v2.5.5
-[Unreleased]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.5.5...master
+[2.5.6]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.5.5...v2.5.6
+[Unreleased]: https://github.com/cisco-en-programmability/dnacentersdk/compare/v2.5.6...master

README.rst

@@ -139,6 +139,28 @@ Installing and upgrading dnacentersdk is easy:
     $ pip install dnacentersdk --upgrade
 
 
+Compatibility matrix
+--------------------
+The following table shows the supported versions.
+
+.. list-table::
+   :widths: 50 50
+   :header-rows: 1
+
+   * - Cisco DNA Center version
+     - Python "dnacentersdk" version
+   * - 2.1.1
+     - 2.2.5
+   * - 2.2.2.3
+     - 2.3.3
+   * - 2.2.3.3
+     - 2.4.11
+   * - 2.3.3.0
+     - 2.5.6
+
+
+If your SDK is older please consider updating it first.
+
 Documentation
 -------------
 

dnacentersdk/api/v2_3_3_0/application_policy.py

@@ -547,8 +547,8 @@ def get_application_sets(self,
         """Get appllication-sets by offset/limit or by name .
 
         Args:
-            offset(int): offset query parameter.
-            limit(int): limit query parameter.
+            offset(basestring, int): offset query parameter.
+            limit(basestring, int): limit query parameter.
             name(basestring): name query parameter.
             headers(dict): Dictionary of HTTP Headers to send with the Request
                 .
@@ -565,8 +565,8 @@ def get_application_sets(self,
             ApiError: If the DNA Center cloud returns an error.
         """
         check_type(headers, dict)
-        check_type(offset, int)
-        check_type(limit, int)
+        check_type(offset, (basestring, int))
+        check_type(limit, (basestring, int))
         check_type(name, basestring)
         if headers is not None:
             if 'X-Auth-Token' in headers:
@@ -964,8 +964,8 @@ def get_applications(self,
         """Get applications by offset/limit or by name .
 
         Args:
-            offset(int): offset query parameter. The offset of the first application to be returned .
-            limit(int): limit query parameter. The maximum number of applications to be returned .
+            offset(basestring, int): offset query parameter. The offset of the first application to be returned .
+            limit(basestring, int): limit query parameter. The maximum number of applications to be returned .
             name(basestring): name query parameter. Application's name .
             headers(dict): Dictionary of HTTP Headers to send with the Request
                 .
@@ -982,8 +982,8 @@ def get_applications(self,
             ApiError: If the DNA Center cloud returns an error.
         """
         check_type(headers, dict)
-        check_type(offset, int)
-        check_type(limit, int)
+        check_type(offset, (basestring, int))
+        check_type(limit, (basestring, int))
         check_type(name, basestring)
         if headers is not None:
             if 'X-Auth-Token' in headers:

dnacentersdk/api/v2_3_3_0/applications.py

@@ -93,9 +93,9 @@ def applications(self,
             end_time(int): endTime query parameter. Ending epoch time in milliseconds of time window .
             application_health(basestring): applicationHealth query parameter. Application health category (POOR,
                 FAIR, or GOOD.  Optionally use with siteId only) .
-            offset(int): offset query parameter. The offset of the first application in the returned data
+            offset(basestring, int): offset query parameter. The offset of the first application in the returned data
                 (optionally used with siteId only) .
-            limit(int): limit query parameter. The max number of application entries in returned data [1, 1000]
+            limit(basestring, int): limit query parameter. The max number of application entries in returned data [1, 1000]
                 (optionally used with siteId only) .
             application_name(basestring): applicationName query parameter. The name of the application to get
                 information on .
@@ -120,8 +120,8 @@ def applications(self,
         check_type(start_time, int)
         check_type(end_time, int)
         check_type(application_health, basestring)
-        check_type(offset, int)
-        check_type(limit, int)
+        check_type(offset, (basestring, int))
+        check_type(limit, (basestring, int))
         check_type(application_name, basestring)
         if headers is not None:
             if 'X-Auth-Token' in headers:

dnacentersdk/api/v2_3_3_0/compliance.py

@@ -79,8 +79,8 @@ def get_compliance_status_(self,
             compliance_status(basestring): complianceStatus query parameter. Compliance status can be have value
                 among 'COMPLIANT','NON_COMPLIANT','IN_PROGRESS', 'ERROR' .
             device_uuid(basestring): deviceUuid query parameter. Comma separated deviceUuids .
-            offset(int): offset query parameter. offset/starting row .
-            limit(int): limit query parameter. Number of records to be retrieved .
+            offset(basestring, int): offset query parameter. offset/starting row .
+            limit(basestring, int): limit query parameter. Number of records to be retrieved .
             headers(dict): Dictionary of HTTP Headers to send with the Request
                 .
             **request_parameters: Additional request parameters (provides
@@ -115,8 +115,8 @@ def get_compliance_status(self,
             compliance_status(basestring): complianceStatus query parameter. Compliance status can be have value
                 among 'COMPLIANT','NON_COMPLIANT','IN_PROGRESS', 'ERROR' .
             device_uuid(basestring): deviceUuid query parameter. Comma separated deviceUuids .
-            offset(int): offset query parameter. offset/starting row .
-            limit(int): limit query parameter. Number of records to be retrieved .
+            offset(basestring, int): offset query parameter. offset/starting row .
+            limit(basestring, int): limit query parameter. Number of records to be retrieved .
             headers(dict): Dictionary of HTTP Headers to send with the Request
                 .
             **request_parameters: Additional request parameters (provides
@@ -134,8 +134,8 @@ def get_compliance_status(self,
         check_type(headers, dict)
         check_type(compliance_status, basestring)
         check_type(device_uuid, basestring)
-        check_type(offset, int)
-        check_type(limit, int)
+        check_type(offset, (basestring, int))
+        check_type(limit, (basestring, int))
         if headers is not None:
             if 'X-Auth-Token' in headers:
                 check_type(headers.get('X-Auth-Token'),
@@ -329,8 +329,8 @@ def get_compliance_detail(self,
                 'COMPLIANT', 'NON_COMPLIANT', 'IN_PROGRESS', 'NOT_AVAILABLE', 'NOT_APPLICABLE', 'ERROR'
                 .
             device_uuid(basestring): deviceUuid query parameter. Comma separated deviceUuids .
-            offset(basestring): offset query parameter. offset/starting row .
-            limit(basestring): limit query parameter. Number of records to be retrieved .
+            offset(basestring, int): offset query parameter. offset/starting row .
+            limit(basestring, int): limit query parameter. Number of records to be retrieved .
             headers(dict): Dictionary of HTTP Headers to send with the Request
                 .
             **request_parameters: Additional request parameters (provides
@@ -349,8 +349,8 @@ def get_compliance_detail(self,
         check_type(compliance_type, basestring)
         check_type(compliance_status, basestring)
         check_type(device_uuid, basestring)
-        check_type(offset, basestring)
-        check_type(limit, basestring)
+        check_type(offset, (basestring, int))
+        check_type(limit, (basestring, int))
         if headers is not None:
             if 'X-Auth-Token' in headers:
                 check_type(headers.get('X-Auth-Token'),

dnacentersdk/api/v2_3_3_0/configuration_templates.py

@@ -1760,8 +1760,8 @@ def get_projects_details(self,
         Args:
             id(basestring): id query parameter. Id of project to be searched .
             name(basestring): name query parameter. Name of project to be searched .
-            offset(int): offset query parameter. Index of first result .
-            limit(int): limit query parameter. Limits number of results .
+            offset(basestring, int): offset query parameter. Index of first result .
+            limit(basestring, int): limit query parameter. Limits number of results .
             sort_order(basestring): sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .
             headers(dict): Dictionary of HTTP Headers to send with the Request
                 .
@@ -1780,8 +1780,8 @@ def get_projects_details(self,
         check_type(headers, dict)
         check_type(id, basestring)
         check_type(name, basestring)
-        check_type(offset, int)
-        check_type(limit, int)
+        check_type(offset, (basestring, int))
+        check_type(limit, (basestring, int))
         check_type(sort_order, basestring)
         if headers is not None:
             if 'X-Auth-Token' in headers:
@@ -1862,8 +1862,8 @@ def get_templates_details(self,
             sort_order(basestring): sortOrder query parameter. Sort Order Ascending (asc) or Descending (dsc) .
             all_template_attributes(bool): allTemplateAttributes query parameter. Return all template attributes .
             include_version_details(bool): includeVersionDetails query parameter. Include template version details .
-            offset(int): offset query parameter. Index of first result .
-            limit(int): limit query parameter. Limits number of results .
+            offset(basestring, int): offset query parameter. Index of first result .
+            limit(basestring, int): limit query parameter. Limits number of results .
             headers(dict): Dictionary of HTTP Headers to send with the Request
                 .
             **request_parameters: Additional request parameters (provides
@@ -1894,8 +1894,8 @@ def get_templates_details(self,
         check_type(sort_order, basestring)
         check_type(all_template_attributes, bool)
         check_type(include_version_details, bool)
-        check_type(offset, int)
-        check_type(limit, int)
+        check_type(offset, (basestring, int))
+        check_type(limit, (basestring, int))
         if headers is not None:
             if 'X-Auth-Token' in headers:
                 check_type(headers.get('X-Auth-Token'),

dnacentersdk/api/v2_3_3_0/device_onboarding_pnp.py

@@ -199,8 +199,8 @@ def get_device_list(self,
         devices. Pagination and sorting are also supported by this endpoint .
 
         Args:
-            limit(int): limit query parameter. Limits number of results .
-            offset(int): offset query parameter. Index of first result .
+            limit(basestring, int): limit query parameter. Limits number of results .
+            offset(basestring, int): offset query parameter. Index of first result .
             sort(basestring, list, set, tuple): sort query parameter. Comma seperated list of fields to sort on .
             sort_order(basestring): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .
             serial_number(basestring, list, set, tuple): serialNumber query parameter. Device Serial Number .
@@ -237,8 +237,8 @@ def get_device_list(self,
             ApiError: If the DNA Center cloud returns an error.
         """
         check_type(headers, dict)
-        check_type(limit, int)
-        check_type(offset, int)
+        check_type(limit, (basestring, int))
+        check_type(offset, (basestring, int))
         check_type(sort, (basestring, list, set, tuple))
         check_type(sort_order, basestring)
         check_type(serial_number, (basestring, list, set, tuple))
@@ -2035,8 +2035,8 @@ def get_workflows(self,
         50 workflows. Pagination and sorting are also supported by this endpoint .
 
         Args:
-            limit(int): limit query parameter. Limits number of results .
-            offset(int): offset query parameter. Index of first result .
+            limit(basestring, int): limit query parameter. Limits number of results .
+            offset(basestring, int): offset query parameter. Index of first result .
             sort(basestring, list, set, tuple): sort query parameter. Comma seperated lost of fields to sort on .
             sort_order(basestring): sortOrder query parameter. Sort Order Ascending (asc) or Descending (des) .
             type(basestring, list, set, tuple): type query parameter. Workflow Type .
@@ -2057,8 +2057,8 @@ def get_workflows(self,
             ApiError: If the DNA Center cloud returns an error.
         """
         check_type(headers, dict)
-        check_type(limit, int)
-        check_type(offset, int)
+        check_type(limit, (basestring, int))
+        check_type(offset, (basestring, int))
         check_type(sort, (basestring, list, set, tuple))
         check_type(sort_order, basestring)
         check_type(type, (basestring, list, set, tuple))

dnacentersdk/api/v2_3_3_0/device_replacement.py

@@ -101,8 +101,8 @@ def return_replacement_devices_with_details(self,
             sort_by(basestring): sortBy query parameter. SortBy this field. SortBy is mandatory when order is used.
                 .
             sort_order(basestring): sortOrder query parameter. Order on displayName[ASC,DESC] .
-            offset(int): offset query parameter.
-            limit(int): limit query parameter.
+            offset(basestring, int): offset query parameter.
+            limit(basestring, int): limit query parameter.
             headers(dict): Dictionary of HTTP Headers to send with the Request
                 .
             **request_parameters: Additional request parameters (provides
@@ -127,8 +127,8 @@ def return_replacement_devices_with_details(self,
         check_type(family, (basestring, list, set, tuple))
         check_type(sort_by, basestring)
         check_type(sort_order, basestring)
-        check_type(offset, int)
-        check_type(limit, int)
+        check_type(offset, (basestring, int))
+        check_type(limit, (basestring, int))
         if headers is not None:
             if 'X-Auth-Token' in headers:
                 check_type(headers.get('X-Auth-Token'),