diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index acdc1cc2..b989b947 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.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. diff --git a/CHANGELOG.md b/CHANGELOG.md index 838685d7..49f4e637 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/README.rst b/README.rst index 2e435d10..6a80ca06 100755 --- a/README.rst +++ b/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 ------------- diff --git a/dnacentersdk/api/v2_3_3_0/application_policy.py b/dnacentersdk/api/v2_3_3_0/application_policy.py index 3e7589bd..c766658c 100644 --- a/dnacentersdk/api/v2_3_3_0/application_policy.py +++ b/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: diff --git a/dnacentersdk/api/v2_3_3_0/applications.py b/dnacentersdk/api/v2_3_3_0/applications.py index 94da4799..101e1245 100644 --- a/dnacentersdk/api/v2_3_3_0/applications.py +++ b/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: diff --git a/dnacentersdk/api/v2_3_3_0/compliance.py b/dnacentersdk/api/v2_3_3_0/compliance.py index a4b6cb12..72bb1270 100644 --- a/dnacentersdk/api/v2_3_3_0/compliance.py +++ b/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'), diff --git a/dnacentersdk/api/v2_3_3_0/configuration_templates.py b/dnacentersdk/api/v2_3_3_0/configuration_templates.py index be0f6570..72af22c4 100644 --- a/dnacentersdk/api/v2_3_3_0/configuration_templates.py +++ b/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'), diff --git a/dnacentersdk/api/v2_3_3_0/device_onboarding_pnp.py b/dnacentersdk/api/v2_3_3_0/device_onboarding_pnp.py index b4097798..b6ef0e74 100644 --- a/dnacentersdk/api/v2_3_3_0/device_onboarding_pnp.py +++ b/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)) diff --git a/dnacentersdk/api/v2_3_3_0/device_replacement.py b/dnacentersdk/api/v2_3_3_0/device_replacement.py index b54a9a4c..78e4952e 100644 --- a/dnacentersdk/api/v2_3_3_0/device_replacement.py +++ b/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'), diff --git a/dnacentersdk/api/v2_3_3_0/devices.py b/dnacentersdk/api/v2_3_3_0/devices.py index ff1decd5..507e918b 100644 --- a/dnacentersdk/api/v2_3_3_0/devices.py +++ b/dnacentersdk/api/v2_3_3_0/devices.py @@ -77,8 +77,8 @@ def get_planned_access_points_for_building(self, Args: building_id(basestring): buildingId path parameter. Building Id . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(basestring, int): limit query parameter. + offset(basestring, int): offset query parameter. radios(bool): radios query parameter. inlcude planned radio details . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -95,8 +95,8 @@ def get_planned_access_points_for_building(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(radios, bool) check_type(building_id, basestring, may_be_none=False) @@ -289,9 +289,9 @@ def devices(self, health(basestring): health query parameter. The device overall health (One of POOR, FAIR, GOOD) . start_time(int): startTime query parameter. UTC epoch time in milliseconds . end_time(int): endTime query parameter. UTC epoch time in miliseconds . - limit(int): limit query parameter. Max number of device entries in the response (default to 50. Max at + limit(basestring, int): limit query parameter. Max number of device entries in the response (default to 50. Max at 1000) . - offset(int): offset query parameter. The offset of the first device in the returned data . + offset(basestring, int): offset query parameter. The offset of the first device in the returned data . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -312,8 +312,8 @@ def devices(self, check_type(health, basestring) check_type(start_time, int) check_type(end_time, int) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (basestring, int)) + check_type(offset, (basestring, int)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -368,8 +368,8 @@ def get_planned_access_points_for_floor(self, Args: floor_id(basestring): floorId path parameter. Floor Id . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(basestring, int): limit query parameter. + offset(basestring, int): offset query parameter. radios(bool): radios query parameter. inlcude planned radio details . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -386,8 +386,8 @@ def get_planned_access_points_for_floor(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(radios, bool) check_type(floor_id, basestring, may_be_none=False) @@ -436,8 +436,8 @@ def get_all_interfaces(self, """Returns all available interfaces. This endpoint can return a maximum of 500 interfaces . Args: - 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 @@ -453,8 +453,8 @@ def get_all_interfaces(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)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), @@ -1309,8 +1309,8 @@ def get_device_list(self, the given ids. If invalid or not-found ids are provided, null entry will be returned in the list. . device_support_level(basestring): deviceSupportLevel query parameter. - offset(int): offset query parameter. offset >= 1 [X gives results from Xth device onwards] . - limit(int): limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] + offset(basestring, int): offset query parameter. offset >= 1 [X gives results from Xth device onwards] . + limit(basestring, int): limit query parameter. 1 <= limit <= 500 [max. no. of devices to be returned in the result] . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -1359,8 +1359,8 @@ def get_device_list(self, check_type(module_operationstatecode, (basestring, list, set, tuple)) check_type(id, basestring) check_type(device_support_level, 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'), @@ -1860,8 +1860,8 @@ def get_device_values_that_match_fully_or_partially_an_attribute(self, role(basestring): role query parameter. role_source(basestring): roleSource query parameter. associated_wlc_ip(basestring): associatedWlcIp query parameter. - 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 @@ -1897,8 +1897,8 @@ def get_device_values_that_match_fully_or_partially_an_attribute(self, check_type(role, basestring) check_type(role_source, basestring) check_type(associated_wlc_ip, 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'), @@ -2477,8 +2477,8 @@ def inventory_insight_device_link_mismatch(self, Args: site_id(basestring): siteId path parameter. - offset(basestring): offset query parameter. Row Number. Default value is 1 . - limit(basestring): limit query parameter. Default value is 500 . + offset(basestring, int): offset query parameter. Row Number. Default value is 1 . + limit(basestring, int): limit query parameter. Default value is 500 . category(basestring): category query parameter. Links mismatch category. Value can be speed-duplex or vlan. . sort_by(basestring): sortBy query parameter. Sort By . @@ -2498,8 +2498,8 @@ def inventory_insight_device_link_mismatch(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, basestring) - check_type(limit, basestring) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(category, basestring, may_be_none=False) check_type(sort_by, basestring) @@ -2560,8 +2560,8 @@ def get_devices_with_snmpv3_des(self, Args: site_id(basestring): siteId path parameter. - offset(basestring): offset query parameter. Row Number. Default value is 1 . - limit(basestring): limit query parameter. Default value is 500 . + offset(basestring, int): offset query parameter. Row Number. Default value is 1 . + limit(basestring, int): limit query parameter. Default value is 500 . sort_by(basestring): sortBy query parameter. Sort By . order(basestring): order query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request @@ -2579,8 +2579,8 @@ def get_devices_with_snmpv3_des(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, basestring) - check_type(limit, basestring) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) check_type(site_id, basestring, @@ -2693,8 +2693,8 @@ def get_modules(self, Args: device_id(basestring): deviceId query parameter. - limit(basestring): limit query parameter. - offset(basestring): offset query parameter. + limit(basestring, int): limit query parameter. + offset(basestring, int): offset query parameter. name_list(basestring, list, set, tuple): nameList query parameter. vendor_equipment_type_list(basestring, list, set, tuple): vendorEquipmentTypeList query parameter. part_number_list(basestring, list, set, tuple): partNumberList query parameter. @@ -2716,8 +2716,8 @@ def get_modules(self, check_type(headers, dict) check_type(device_id, basestring, may_be_none=False) - check_type(limit, basestring) - check_type(offset, basestring) + check_type(limit, (basestring, int)) + check_type(offset, (basestring, int)) check_type(name_list, (basestring, list, set, tuple)) check_type(vendor_equipment_type_list, (basestring, list, set, tuple)) check_type(part_number_list, (basestring, list, set, tuple)) diff --git a/dnacentersdk/api/v2_3_3_0/discovery.py b/dnacentersdk/api/v2_3_3_0/discovery.py index 532d9f8e..e4f7faf0 100644 --- a/dnacentersdk/api/v2_3_3_0/discovery.py +++ b/dnacentersdk/api/v2_3_3_0/discovery.py @@ -571,8 +571,8 @@ def get_discovery_jobs_by_ip(self, """Returns the list of discovery jobs for the given IP . Args: - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(basestring, int): offset query parameter. + limit(basestring, int): limit query parameter. ip_address(basestring): ipAddress query parameter. name(basestring): name query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request @@ -590,8 +590,8 @@ def get_discovery_jobs_by_ip(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(ip_address, basestring, may_be_none=False) check_type(name, basestring) @@ -755,8 +755,8 @@ def get_list_of_discoveries_by_discovery_id(self, Args: id(basestring): id path parameter. Discovery ID . - offset(int): offset query parameter. - limit(int): limit query parameter. + offset(basestring, int): offset query parameter. + limit(basestring, int): limit query parameter. ip_address(basestring): ipAddress query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -773,8 +773,8 @@ def get_list_of_discoveries_by_discovery_id(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(ip_address, basestring) check_type(id, basestring, may_be_none=False) diff --git a/dnacentersdk/api/v2_3_3_0/event_management.py b/dnacentersdk/api/v2_3_3_0/event_management.py index d0f1e3ed..e9000ac0 100644 --- a/dnacentersdk/api/v2_3_3_0/event_management.py +++ b/dnacentersdk/api/v2_3_3_0/event_management.py @@ -115,8 +115,8 @@ def get_auditlog_parent_records(self, . description(basestring): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(basestring, int): offset query parameter. Position of a particular Audit Log record in the data. . + limit(basestring, int): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -156,8 +156,8 @@ def get_auditlog_parent_records(self, check_type(device_id, basestring) check_type(is_system_events, bool) check_type(description, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, basestring) @@ -442,8 +442,8 @@ def get_auditlog_records(self, . description(basestring): description query parameter. String full/partial search (Provided input string is case insensitively matched for records). . - offset(int): offset query parameter. Position of a particular Audit Log record in the data. . - limit(int): limit query parameter. Number of Audit Log records to be returned per page. . + offset(basestring, int): offset query parameter. Position of a particular Audit Log record in the data. . + limit(basestring, int): limit query parameter. Number of Audit Log records to be returned per page. . start_time(int): startTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory) . end_time(int): endTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when @@ -484,8 +484,8 @@ def get_auditlog_records(self, check_type(device_id, basestring) check_type(is_system_events, bool) check_type(description, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(start_time, int) check_type(end_time, int) check_type(sort_by, basestring) @@ -832,8 +832,8 @@ def get_notifications(self, domain(basestring): domain query parameter. sub_domain(basestring): subDomain query parameter. Sub Domain . source(basestring): source query parameter. - offset(int): offset query parameter. Start Offset . - limit(int): limit query parameter. # of records . + offset(basestring, int): offset query parameter. Start Offset . + limit(basestring, int): limit query parameter. # of records . sort_by(basestring): sortBy query parameter. Sort By column . order(basestring): order query parameter. Ascending/Descending order [asc/desc] . tags(basestring): tags query parameter. @@ -864,8 +864,8 @@ def get_notifications(self, check_type(domain, basestring) check_type(sub_domain, basestring) check_type(source, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) check_type(tags, basestring) @@ -1040,9 +1040,9 @@ def get_event_subscriptions(self, Args: event_ids(basestring): eventIds query parameter. List of subscriptions related to the respective eventIds . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(basestring, int): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(basestring, int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(basestring): sortBy query parameter. SortBy field name . order(basestring): order query parameter. @@ -1063,8 +1063,8 @@ def get_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) if headers is not None: @@ -1302,9 +1302,9 @@ def get_email_subscription_details(self, Args: name(basestring): name query parameter. Name of the specific configuration . instance_id(basestring): instanceId query parameter. Instance Id of the specific configuration . - offset(int): offset query parameter. The number of Email Subscription detail's to offset in the + offset(basestring, int): offset query parameter. The number of Email Subscription detail's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Email Subscription detail's to limit in the resultset + limit(basestring, int): limit query parameter. The number of Email Subscription detail's to limit in the resultset whose default value 10 . sort_by(basestring): sortBy query parameter. SortBy field name . order(basestring): order query parameter. @@ -1326,8 +1326,8 @@ def get_email_subscription_details(self, check_type(headers, dict) check_type(name, basestring) check_type(instance_id, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) if headers is not None: @@ -1385,9 +1385,9 @@ def get_rest_webhook_subscription_details(self, Args: name(basestring): name query parameter. Name of the specific configuration . instance_id(basestring): instanceId query parameter. Instance Id of the specific configuration . - offset(int): offset query parameter. The number of Rest/Webhook Subscription detail's to offset in the + offset(basestring, int): offset query parameter. The number of Rest/Webhook Subscription detail's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Rest/Webhook Subscription detail's to limit in the + limit(basestring, int): limit query parameter. The number of Rest/Webhook Subscription detail's to limit in the resultset whose default value 10 . sort_by(basestring): sortBy query parameter. SortBy field name . order(basestring): order query parameter. @@ -1409,8 +1409,8 @@ def get_rest_webhook_subscription_details(self, check_type(headers, dict) check_type(name, basestring) check_type(instance_id, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) if headers is not None: @@ -1468,9 +1468,9 @@ def get_syslog_subscription_details(self, Args: name(basestring): name query parameter. Name of the specific configuration . instance_id(basestring): instanceId query parameter. Instance Id of the specific configuration . - offset(int): offset query parameter. The number of Syslog Subscription detail's to offset in the + offset(basestring, int): offset query parameter. The number of Syslog Subscription detail's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Syslog Subscription detail's to limit in the resultset + limit(basestring, int): limit query parameter. The number of Syslog Subscription detail's to limit in the resultset whose default value 10 . sort_by(basestring): sortBy query parameter. SortBy field name . order(basestring): order query parameter. @@ -1492,8 +1492,8 @@ def get_syslog_subscription_details(self, check_type(headers, dict) check_type(name, basestring) check_type(instance_id, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) if headers is not None: @@ -1741,9 +1741,9 @@ def get_email_event_subscriptions(self, Args: event_ids(basestring): eventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(basestring, int): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(basestring, int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(basestring): sortBy query parameter. SortBy field name . order(basestring): order query parameter. @@ -1772,8 +1772,8 @@ def get_email_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) check_type(domain, basestring) @@ -1914,9 +1914,9 @@ def get_rest_webhook_event_subscriptions(self, Args: event_ids(basestring): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(basestring, int): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(basestring, int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(basestring): sortBy query parameter. SortBy field name . order(basestring): order query parameter. @@ -1944,8 +1944,8 @@ def get_rest_webhook_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) check_type(domain, basestring) @@ -2212,9 +2212,9 @@ def get_syslog_event_subscriptions(self, Args: event_ids(basestring): eventIds query parameter. List of subscriptions related to the respective eventIds (Comma separated event ids) . - offset(int): offset query parameter. The number of Subscriptions's to offset in the resultset whose + offset(basestring, int): offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default + limit(basestring, int): limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10 . sort_by(basestring): sortBy query parameter. SortBy field name . order(basestring): order query parameter. @@ -2242,8 +2242,8 @@ def get_syslog_event_subscriptions(self, """ check_type(headers, dict) check_type(event_ids, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) check_type(domain, basestring) @@ -2686,9 +2686,9 @@ def get_events(self, Args: event_id(basestring): eventId query parameter. The registered EventId should be provided . tags(basestring): tags query parameter. The registered Tags should be provided . - offset(int): offset query parameter. The number of Registries to offset in the resultset whose default + offset(basestring, int): offset query parameter. The number of Registries to offset in the resultset whose default value 0 . - limit(int): limit query parameter. The number of Registries to limit in the resultset whose default + limit(basestring, int): limit query parameter. The number of Registries to limit in the resultset whose default value 10 . sort_by(basestring): sortBy query parameter. SortBy field name . order(basestring): order query parameter. @@ -2711,8 +2711,8 @@ def get_events(self, check_type(event_id, basestring) check_type(tags, basestring, may_be_none=False) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) if headers is not None: @@ -2832,8 +2832,8 @@ def get_eventartifacts(self, Args: event_ids(basestring): eventIds query parameter. List of eventIds . tags(basestring): tags query parameter. Tags defined . - offset(int): offset query parameter. Record start offset . - limit(int): limit query parameter. # of records to return in result set . + offset(basestring, int): offset query parameter. Record start offset . + limit(basestring, int): limit query parameter. # of records to return in result set . sort_by(basestring): sortBy query parameter. Sort by field . order(basestring): order query parameter. sorting order (asc/desc) . search(basestring): search query parameter. findd matches in name, description, eventId, type, category @@ -2856,8 +2856,8 @@ def get_eventartifacts(self, check_type(headers, dict) check_type(event_ids, basestring) check_type(tags, basestring) - check_type(offset, int) - check_type(limit, int) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) check_type(search, basestring) diff --git a/dnacentersdk/api/v2_3_3_0/health_and_performance.py b/dnacentersdk/api/v2_3_3_0/health_and_performance.py index e6fd0c5e..4ce14645 100644 --- a/dnacentersdk/api/v2_3_3_0/health_and_performance.py +++ b/dnacentersdk/api/v2_3_3_0/health_and_performance.py @@ -83,8 +83,8 @@ def system_health(self, subdomain(basestring): subdomain query parameter. Fetch system events with this subdomain. Possible values of subdomain are listed here : /dna/platform/app/consumer-portal/developer- toolkit/events . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(basestring, int): limit query parameter. + offset(basestring, int): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -103,8 +103,8 @@ def system_health(self, check_type(summary, bool) check_type(domain, basestring) check_type(subdomain, basestring) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (basestring, int)) + check_type(offset, (basestring, int)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_3_0/lan_automation.py b/dnacentersdk/api/v2_3_3_0/lan_automation.py index 0d63c80c..6420fa11 100644 --- a/dnacentersdk/api/v2_3_3_0/lan_automation.py +++ b/dnacentersdk/api/v2_3_3_0/lan_automation.py @@ -190,9 +190,9 @@ def lan_automation_log(self, """Invoke this API to get the LAN Automation session logs. . Args: - offset(basestring): offset query parameter. Starting index of the LAN Automation session. Minimum value + offset(basestring, int): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . - limit(basestring): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value + limit(basestring, int): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -209,8 +209,8 @@ def lan_automation_log(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - 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'), @@ -307,9 +307,9 @@ def lan_automation_status(self, """Invoke this API to get the LAN Automation session status. . Args: - offset(basestring): offset query parameter. Starting index of the LAN Automation session. Minimum value + offset(basestring, int): offset query parameter. Starting index of the LAN Automation session. Minimum value is 1. . - limit(basestring): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value + limit(basestring, int): limit query parameter. Number of LAN Automation sessions to be retrieved. Limit value can range between 1 to 10. . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -326,8 +326,8 @@ def lan_automation_status(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - 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'), diff --git a/dnacentersdk/api/v2_3_3_0/licenses.py b/dnacentersdk/api/v2_3_3_0/licenses.py index d262ede1..b05fb913 100644 --- a/dnacentersdk/api/v2_3_3_0/licenses.py +++ b/dnacentersdk/api/v2_3_3_0/licenses.py @@ -163,7 +163,7 @@ def device_license_summary(self, sort_by(basestring): sort_by query parameter. Sort result by field . dna_level(basestring): dna_level query parameter. Device Cisco DNA license level . device_type(basestring): device_type query parameter. Type of device . - limit(int): limit query parameter. + limit(basestring, int): limit query parameter. registration_status(basestring): registration_status query parameter. Smart license registration status of device . virtual_account_name(basestring): virtual_account_name query parameter. Name of virtual account . diff --git a/dnacentersdk/api/v2_3_3_0/network_settings.py b/dnacentersdk/api/v2_3_3_0/network_settings.py index 85b66b07..9362eae0 100644 --- a/dnacentersdk/api/v2_3_3_0/network_settings.py +++ b/dnacentersdk/api/v2_3_3_0/network_settings.py @@ -423,8 +423,8 @@ def get_global_pool(self, """API to get global pool. . Args: - offset(basestring): offset query parameter. offset/starting row . - limit(basestring): limit query parameter. No of Global Pools to be retrieved . + offset(basestring, int): offset query parameter. offset/starting row . + limit(basestring, int): limit query parameter. No of Global Pools to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -440,8 +440,8 @@ def get_global_pool(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - 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'), @@ -892,8 +892,8 @@ def get_reserve_ip_subpool(self, Args: site_id(basestring): siteId query parameter. site id to get the reserve ip associated with the site . - offset(basestring): offset query parameter. offset/starting row . - limit(basestring): limit query parameter. No of Global Pools to be retrieved . + offset(basestring, int): offset query parameter. offset/starting row . + limit(basestring, int): limit query parameter. No of Global Pools to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -910,8 +910,8 @@ def get_reserve_ip_subpool(self, """ check_type(headers, dict) check_type(site_id, 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'), diff --git a/dnacentersdk/api/v2_3_3_0/path_trace.py b/dnacentersdk/api/v2_3_3_0/path_trace.py index 4f2c9d2e..0742cd01 100644 --- a/dnacentersdk/api/v2_3_3_0/path_trace.py +++ b/dnacentersdk/api/v2_3_3_0/path_trace.py @@ -98,8 +98,8 @@ def retrives_all_previous_pathtraces_summary(self, status(basestring): status query parameter. task_id(basestring): taskId query parameter. Task ID . last_update_time(basestring): lastUpdateTime query parameter. Last update time . - limit(basestring): limit query parameter. Number of resources returned . - offset(basestring): offset query parameter. Start index of resources returned (1-based) . + limit(basestring, int): limit query parameter. Number of resources returned . + offset(basestring, int): offset query parameter. Start index of resources returned (1-based) . order(basestring): order query parameter. Order by this field . sort_by(basestring): sortBy query parameter. Sort by this field . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -128,8 +128,8 @@ def retrives_all_previous_pathtraces_summary(self, check_type(status, basestring) check_type(task_id, basestring) check_type(last_update_time, basestring) - check_type(limit, basestring) - check_type(offset, basestring) + check_type(limit, (basestring, int)) + check_type(offset, (basestring, int)) check_type(order, basestring) check_type(sort_by, basestring) if headers is not None: diff --git a/dnacentersdk/api/v2_3_3_0/site_design.py b/dnacentersdk/api/v2_3_3_0/site_design.py index d4f18085..9c94d780 100644 --- a/dnacentersdk/api/v2_3_3_0/site_design.py +++ b/dnacentersdk/api/v2_3_3_0/site_design.py @@ -575,8 +575,8 @@ def get_nfv_profile(self, Args: id(basestring): id path parameter. ID of network profile to retrieve. . - offset(basestring): offset query parameter. offset/starting row . - limit(basestring): limit query parameter. Number of profile to be retrieved . + offset(basestring, int): offset query parameter. offset/starting row . + limit(basestring, int): limit query parameter. Number of profile to be retrieved . name(basestring): name query parameter. Name of network profile to be retrieved . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -593,8 +593,8 @@ def get_nfv_profile(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, basestring) - check_type(limit, basestring) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(name, basestring) check_type(id, basestring, may_be_none=False) diff --git a/dnacentersdk/api/v2_3_3_0/sites.py b/dnacentersdk/api/v2_3_3_0/sites.py index 011dcc80..2560c1ba 100644 --- a/dnacentersdk/api/v2_3_3_0/sites.py +++ b/dnacentersdk/api/v2_3_3_0/sites.py @@ -162,8 +162,8 @@ def get_membership(self, Args: site_id(basestring): siteId path parameter. Site id to retrieve device associated with the site. . - offset(basestring): offset query parameter. offset/starting row . - limit(basestring): limit query parameter. Number of sites to be retrieved . + offset(basestring, int): offset query parameter. offset/starting row . + limit(basestring, int): limit query parameter. Number of sites to be retrieved . device_family(basestring): deviceFamily query parameter. Device family name . serial_number(basestring): serialNumber query parameter. Device serial number . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -181,8 +181,8 @@ def get_membership(self, ApiError: If the DNA Center cloud returns an error. """ check_type(headers, dict) - check_type(offset, basestring) - check_type(limit, basestring) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(device_family, basestring) check_type(serial_number, basestring) check_type(site_id, basestring, @@ -323,8 +323,8 @@ def get_site(self, name(basestring): name query parameter. siteNameHierarchy (ex: global/groupName) . site_id(basestring): siteId query parameter. Site id to which site details to retrieve. . type(basestring): type query parameter. type (ex: area, building, floor) . - offset(basestring): offset query parameter. offset/starting row. The default value is 1 . - limit(basestring): limit query parameter. Number of sites to be retrieved. The default value is 500 . + offset(basestring, int): offset query parameter. offset/starting row. The default value is 1 . + limit(basestring, int): limit query parameter. Number of sites to be retrieved. The default value is 500 . headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -343,8 +343,8 @@ def get_site(self, check_type(name, basestring) check_type(site_id, basestring) check_type(type, 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'), @@ -398,9 +398,9 @@ def get_site_health(self, data is required . site_type(basestring): siteType query parameter. Type of the site to return. AREA or BUILDING. Default to AREA . - offset(int): offset query parameter. The offset value, starting from 1, of the first returned site + offset(basestring, int): offset query parameter. The offset value, starting from 1, of the first returned site entry. Default is 1. . - limit(int): limit query parameter. The max number of sites in the returned data set. Default is 25, and + limit(basestring, int): limit query parameter. The max number of sites in the returned data set. Default is 25, and max at 50 . headers(dict): Dictionary of HTTP Headers to send with the Request . @@ -419,8 +419,8 @@ def get_site_health(self, check_type(headers, dict) check_type(timestamp, basestring) check_type(site_type, 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'), diff --git a/dnacentersdk/api/v2_3_3_0/software_image_management_swim.py b/dnacentersdk/api/v2_3_3_0/software_image_management_swim.py index 521aaf58..bededdb7 100644 --- a/dnacentersdk/api/v2_3_3_0/software_image_management_swim.py +++ b/dnacentersdk/api/v2_3_3_0/software_image_management_swim.py @@ -252,8 +252,8 @@ def get_software_image_details(self, image_size_lesser_than(int): imageSizeLesserThan query parameter. size in bytes . sort_by(basestring): sortBy query parameter. sort results by this field . sort_order(basestring): sortOrder query parameter. sort order 'asc' or 'des'. Default is asc . - limit(int): limit query parameter. - offset(int): offset query parameter. + limit(basestring, int): limit query parameter. + offset(basestring, int): offset query parameter. headers(dict): Dictionary of HTTP Headers to send with the Request . **request_parameters: Additional request parameters (provides @@ -285,8 +285,8 @@ def get_software_image_details(self, check_type(image_size_lesser_than, int) check_type(sort_by, basestring) check_type(sort_order, basestring) - check_type(limit, int) - check_type(offset, int) + check_type(limit, (basestring, int)) + check_type(offset, (basestring, int)) if headers is not None: if 'X-Auth-Token' in headers: check_type(headers.get('X-Auth-Token'), diff --git a/dnacentersdk/api/v2_3_3_0/tag.py b/dnacentersdk/api/v2_3_3_0/tag.py index 372a417f..ade453c7 100644 --- a/dnacentersdk/api/v2_3_3_0/tag.py +++ b/dnacentersdk/api/v2_3_3_0/tag.py @@ -180,8 +180,8 @@ def get_tag(self, additional_info_name_space(basestring): additionalInfo.nameSpace query parameter. additional_info_attributes(basestring): additionalInfo.attributes query parameter. level(basestring): level query parameter. - offset(basestring): offset query parameter. - limit(basestring): limit query parameter. + offset(basestring, int): offset query parameter. + limit(basestring, int): limit query parameter. size(basestring): size query parameter. size in kilobytes(KB) . field(basestring): field query parameter. Available field names are :'name,id,parentId,type,additionalInfo.nameSpace,additionalInfo.attributes' . @@ -208,8 +208,8 @@ def get_tag(self, check_type(additional_info_name_space, basestring) check_type(additional_info_attributes, basestring) check_type(level, basestring) - check_type(offset, basestring) - check_type(limit, basestring) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(size, basestring) check_type(field, basestring) check_type(sort_by, basestring) @@ -690,9 +690,9 @@ def get_tag_members_by_id(self, id(basestring): id path parameter. Tag ID . member_type(basestring): memberType query parameter. Entity type of the member. Possible values can be retrieved by using /tag/member/type API . - offset(basestring): offset query parameter. Used for pagination. It indicates the starting row number + offset(basestring, int): offset query parameter. Used for pagination. It indicates the starting row number out of available member records . - limit(basestring): limit query parameter. Used to Number of maximum members to return in the result . + limit(basestring, int): limit query parameter. Used to Number of maximum members to return in the result . member_association_type(basestring): memberAssociationType query parameter. Indicates how the member is associated with the tag. Possible values and description. 1) DYNAMIC : The member is associated to the tag through rules. 2) STATIC – The member is associated to the tag @@ -716,8 +716,8 @@ def get_tag_members_by_id(self, check_type(headers, dict) check_type(member_type, basestring, may_be_none=False) - check_type(offset, basestring) - check_type(limit, basestring) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(member_association_type, basestring) check_type(level, basestring) check_type(id, basestring, diff --git a/dnacentersdk/api/v2_3_3_0/task.py b/dnacentersdk/api/v2_3_3_0/task.py index ca07ee81..d5e6e905 100644 --- a/dnacentersdk/api/v2_3_3_0/task.py +++ b/dnacentersdk/api/v2_3_3_0/task.py @@ -156,8 +156,8 @@ def get_tasks(self, failure_reason(basestring): failureReason query parameter. Fetch tasks that contains this failure reason . parent_id(basestring): parentId query parameter. Fetch tasks that have this parent Id . - offset(basestring): offset query parameter. - limit(basestring): limit query parameter. + offset(basestring, int): offset query parameter. + limit(basestring, int): limit query parameter. sort_by(basestring): sortBy query parameter. Sort results by this field . order(basestring): order query parameter. Sort order asc or dsc . headers(dict): Dictionary of HTTP Headers to send with the Request @@ -185,8 +185,8 @@ def get_tasks(self, check_type(is_error, basestring) check_type(failure_reason, basestring) check_type(parent_id, basestring) - check_type(offset, basestring) - check_type(limit, basestring) + check_type(offset, (basestring, int)) + check_type(limit, (basestring, int)) check_type(sort_by, basestring) check_type(order, basestring) if headers is not None: @@ -360,8 +360,8 @@ def get_task_by_operationid(self, Args: operation_id(basestring): operationId path parameter. - offset(int): offset path parameter. Index, minimum value is 0 . - limit(int): limit path parameter. The maximum value of {limit} supported is 500. Base 1 + offset(basestring, int): offset path parameter. Index, minimum value is 0 . + limit(basestring, int): limit path parameter. The maximum value of {limit} supported is 500. Base 1 indexing for {limit}, minimum value is 1 . headers(dict): Dictionary of HTTP Headers to send with the Request . diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index dc9574c3..fc090a5f 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -8,12 +8,49 @@ Changelog `__, and this project adheres to `Semantic Versioning `__. -`Unreleased `__ +`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 + +.. _section-1: + `2.5.5 `__ - 2022-11-17 --------------------------------------------------------------------------------------------------------- +.. _fixed-1: + Fixed ~~~~~ @@ -24,11 +61,13 @@ Fixed - Added Dict_of_str function call in custom_caller headers -.. _section-1: +.. _section-2: `2.5.4 `__ - 2022-08-11 --------------------------------------------------------------------------------------------------------- +.. _added-1: + Added ~~~~~ @@ -36,12 +75,12 @@ Added - ``add_ssid_to_ip_pool_mapping`` -.. _section-2: +.. _section-3: `2.5.3 `__ - 2022-08-09 --------------------------------------------------------------------------------------------------------- -.. _fixed-1: +.. _fixed-2: Fixed ~~~~~ @@ -52,12 +91,12 @@ Fixed ``connectedToInternet`` on ``sda.adds_border_device`` comes from ``boolean`` to ``string``. -.. _section-3: +.. _section-4: `2.5.2 `__ - 2022-07-29 --------------------------------------------------------------------------------------------------------- -.. _fixed-2: +.. _fixed-3: Fixed ~~~~~ @@ -89,12 +128,12 @@ Fixed - network - servers -.. _section-4: +.. _section-5: `2.5.1 `__ - 2022-07-12 --------------------------------------------------------------------------------------------------------- -.. _fixed-3: +.. _fixed-4: Fixed ~~~~~ @@ -103,12 +142,12 @@ Fixed - IpAddressSpace -.. _section-5: +.. _section-6: `2.5.0 `__ - 2022-06-20 ---------------------------------------------------------------------------------------------------------- -.. _added-1: +.. _added-2: Added ~~~~~ @@ -116,12 +155,12 @@ Added - Add support of DNA Center versions (‘2.3.3.0’) - Adds modules for v2_3_3_0 -.. _section-6: +.. _section-7: `2.4.11 `__ - 2022-06-15 ------------------------------------------------------------------------------------------------------------ -.. _fixed-4: +.. _fixed-5: Fixed ~~~~~ @@ -132,12 +171,12 @@ Fixed - verify - debug -.. _section-7: +.. _section-8: `2.4.10 `__ - 2022-05-12 ----------------------------------------------------------------------------------------------------------- -.. _added-2: +.. _added-3: Added ~~~~~ @@ -148,12 +187,12 @@ Added - site_name_hierarchy -.. _section-8: +.. _section-9: `2.4.9 `__ - 2022-04-20 --------------------------------------------------------------------------------------------------------- -.. _added-3: +.. _added-4: Added ~~~~~ @@ -168,12 +207,12 @@ Added - subnetMask - vlanId -.. _section-9: +.. _section-10: `2.4.8 `__ - 2022-03-23 --------------------------------------------------------------------------------------------------------- -.. _added-4: +.. _added-5: Added ~~~~~ @@ -212,12 +251,12 @@ Changed - dnacentersdk.api.v2_2_3_3.file.File.download_a_file_by_fileid - dnacentersdk.api.v2_2_3_3.reports.Reports.download_report_content -.. _section-10: +.. _section-11: `2.4.7 `__ - 2022-03-22 --------------------------------------------------------------------------------------------------------- -.. _added-5: +.. _added-6: Added ~~~~~ @@ -225,7 +264,7 @@ Added - Add ``rfProfile`` parameter for request body struct of ``claim_a_device_to_a_site``. -.. _section-11: +.. _section-12: `2.4.6 `__ - 2022-03-14 --------------------------------------------------------------------------------------------------------- @@ -256,7 +295,7 @@ Changed - sda.adds_border_device -.. _section-12: +.. _section-13: `2.4.5 `__ - 2022-02-01 --------------------------------------------------------------------------------------------------------- @@ -282,7 +321,7 @@ Changed - devices.sync_devices -.. _section-13: +.. _section-14: `2.4.4 `__ - 2022-01-31 --------------------------------------------------------------------------------------------------------- @@ -310,7 +349,7 @@ Changed - site_design.update_floormap - application_policy.create_application -.. _fixed-5: +.. _fixed-6: Fixed ~~~~~ @@ -318,7 +357,7 @@ Fixed - Removed an extra parameter in the call of ``VERIFY_STRING_ENVIRONMENT_VARIABLE`` -.. _added-6: +.. _added-7: Added ~~~~~ @@ -326,12 +365,12 @@ Added - Adds parameters ``hostname``, ``imageInfo`` and ``configInfo`` to device_onboarding_pnp.pnp_device_claim_to_site -.. _section-14: +.. _section-15: `2.4.3 `__ - 2022-01-19 --------------------------------------------------------------------------------------------------------- -.. _fixed-6: +.. _fixed-7: Fixed ~~~~~ @@ -349,12 +388,12 @@ Changed DNACenterAPI - Adds tests for env variables before/after DNACenterAPI import -.. _section-15: +.. _section-16: `2.4.2 `__ - 2021-12-14 --------------------------------------------------------------------------------------------------------- -.. _fixed-7: +.. _fixed-8: Fixed ~~~~~ @@ -364,7 +403,7 @@ Fixed - Update json schemas for models/validators and tests/models/models/validators -.. _section-16: +.. _section-17: `2.4.1 `__ - 2021-12-01 --------------------------------------------------------------------------------------------------------- @@ -376,12 +415,12 @@ Changed - Update to match checksum -.. _section-17: +.. _section-18: `2.4.0 `__ - 2021-12-01 --------------------------------------------------------------------------------------------------------- -.. _added-7: +.. _added-8: Added ~~~~~ @@ -407,7 +446,7 @@ Changed - Update missing dnac 2.2.3.3 files -.. _section-18: +.. _section-19: `2.3.3 `__ - 2021-11-24 --------------------------------------------------------------------------------------------------------- @@ -439,7 +478,7 @@ Changed - Add ``isGuestVirtualNetwork`` parameter to ``update_virtual_network_with_scalable_groups`` function -.. _section-19: +.. _section-20: `2.3.2 `__ - 2021-09-14 --------------------------------------------------------------------------------------------------------- @@ -451,12 +490,12 @@ Changed - Disable verify=False warnings of urllib3 -.. _section-20: +.. _section-21: `2.3.1 `__ - 2021-08-10 --------------------------------------------------------------------------------------------------------- -.. _fixed-8: +.. _fixed-9: Fixed ~~~~~ @@ -464,12 +503,12 @@ Fixed - Fix devices param definition & schemas [``aba32f3``] - Remove unnecesary path_params [``25c4e99``] -.. _section-21: +.. _section-22: `2.3.0 `__ - 2021-08-09 --------------------------------------------------------------------------------------------------------- -.. _added-8: +.. _added-9: Added ~~~~~ @@ -489,7 +528,7 @@ Changed - Updates restsession.py to handle downloads using Content-Disposition header rather than custom fileName header -.. _section-22: +.. _section-23: `2.2.5 `__ - 2021-08-05 --------------------------------------------------------------------------------------------------------- @@ -508,12 +547,12 @@ Changed - Removes minus char from docstrings. - Adds check_type conditions for ‘X-Auth-Token’ for v2_2_1 operations. -.. _section-23: +.. _section-24: `2.2.4 `__ - 2021-06-08 --------------------------------------------------------------------------------------------------------- -.. _fixed-9: +.. _fixed-10: Fixed ~~~~~ @@ -521,7 +560,7 @@ Fixed - Fixes download_a_file_by_fileid and import_local_software_image for v2_2_1 -.. _section-24: +.. _section-25: `2.2.3 `__ - 2021-06-08 --------------------------------------------------------------------------------------------------------- @@ -544,12 +583,12 @@ Changed - Patch adds one function that was missing from previous release - Patch adds models/validators for v2_2_1 with new ids -.. _section-25: +.. _section-26: `2.2.2 `__ - 2021-05-10 --------------------------------------------------------------------------------------------------------- -.. _added-9: +.. _added-10: Added ~~~~~ @@ -563,12 +602,12 @@ Changed - Updates requirements files -.. _section-26: +.. _section-27: `2.0.2 `__ - 2020-11-01 --------------------------------------------------------------------------------------------------------- -.. _added-10: +.. _added-11: Added ~~~~~ @@ -592,12 +631,12 @@ Removed - Removed requirements.lock -.. _section-27: +.. _section-28: `2.0.0 `__ - 2020-07-17 --------------------------------------------------------------------------------------------------------- -.. _added-11: +.. _added-12: Added ~~~~~ @@ -615,7 +654,7 @@ Changed - Changed setup from versioneer to setuptools_scm - Changed version management to include patch (major, minor, patch) -.. _fixed-10: +.. _fixed-11: Fixed ~~~~~ @@ -632,19 +671,19 @@ Removed - Removed Webex Teams Space Community reference from README - Removed Token refresh when changing base_url -.. _section-28: +.. _section-29: `1.3.0 `__ - 2019-08-19 ---------------------------------------------------------------------------------------------------------- -.. _added-12: +.. _added-13: Added ~~~~~ - Add support for multiple versions of DNA Center (‘1.2.10’, ‘1.3.0’) -.. _fixed-11: +.. _fixed-12: Fixed ~~~~~ @@ -653,12 +692,12 @@ Fixed - Fix error in setter in ``api/__init__.py`` - Fix errors for readthedocs -.. _section-29: +.. _section-30: `1.2.10 `__ - 2019-07-18 --------------------------------------------------------------------------------------------------- -.. _added-13: +.. _added-14: Added ~~~~~ diff --git a/pyproject.toml b/pyproject.toml index f41af88e..b4ebb726 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "dnacentersdk" -version = "2.5.5" +version = "2.5.6" description = "Cisco DNA Center Platform SDK" authors = ["Jose Bogarin Solano ", "William Astorga ", "Francisco Muñoz ", "Francisco Muñoz ", "Bryan Vargas "] license = "MIT"