diff --git a/internal/provider/resources/resource_agent.go b/internal/provider/resources/resource_agent.go index 098c200..c499b5d 100644 --- a/internal/provider/resources/resource_agent.go +++ b/internal/provider/resources/resource_agent.go @@ -268,7 +268,7 @@ func (r *agentResource) Delete( request := r.client.ConfigurationAPI.AgentDelete(ctx, state.ID.ValueString()) - _, response, err := util.RetryForTooManyRequests(request.Execute) + response, err := util.RetryForTooManyRequestsNoReturn(request.Execute) errorPresent, errorDetail := util.RaiseForStatus(response, err) if errorPresent { if response != nil && response.StatusCode == http.StatusNotFound { diff --git a/internal/provider/resources/resource_agent_group_assignment.go b/internal/provider/resources/resource_agent_group_assignment.go index 0bb2f00..73c0457 100644 --- a/internal/provider/resources/resource_agent_group_assignment.go +++ b/internal/provider/resources/resource_agent_group_assignment.go @@ -227,7 +227,7 @@ func (r *agentGroupAssignmentResource) Delete( request := r.client.ConfigurationAPI. AgentGroupAssignmentDelete(ctx, state.ID.ValueString()) - _, response, err := util.RetryForTooManyRequests(request.Execute) + response, err := util.RetryForTooManyRequestsNoReturn(request.Execute) errorPresent, errorDetail := util.RaiseForStatus(response, err) if errorPresent { if response != nil && response.StatusCode == http.StatusNotFound { diff --git a/internal/provider/resources/resource_group.go b/internal/provider/resources/resource_group.go index 816ed88..c21db71 100644 --- a/internal/provider/resources/resource_group.go +++ b/internal/provider/resources/resource_group.go @@ -246,7 +246,7 @@ func (r *groupResource) Delete( request := r.client.ConfigurationAPI.GroupDelete(ctx, state.ID.ValueString()) - _, response, err := util.RetryForTooManyRequests(request.Execute) + response, err := util.RetryForTooManyRequestsNoReturn(request.Execute) errorPresent, errorDetail := util.RaiseForStatus(response, err) if errorPresent { if response != nil && response.StatusCode == http.StatusNotFound { diff --git a/internal/provider/resources/resource_network_group_assignment.go b/internal/provider/resources/resource_network_group_assignment.go index 2502f50..890a087 100644 --- a/internal/provider/resources/resource_network_group_assignment.go +++ b/internal/provider/resources/resource_network_group_assignment.go @@ -233,7 +233,7 @@ func (r *networkGroupAssignmentResource) Delete( request := r.client.ConfigurationAPI. NetworkGroupAssignmentDelete(ctx, state.ID.ValueString()) - _, response, err := util.RetryForTooManyRequests(request.Execute) + response, err := util.RetryForTooManyRequestsNoReturn(request.Execute) errorPresent, errorDetail := util.RaiseForStatus(response, err) if errorPresent { if response != nil && response.StatusCode == http.StatusNotFound { diff --git a/internal/provider/resources/resource_sensor_group_assignment.go b/internal/provider/resources/resource_sensor_group_assignment.go index cf30c83..ba59722 100644 --- a/internal/provider/resources/resource_sensor_group_assignment.go +++ b/internal/provider/resources/resource_sensor_group_assignment.go @@ -228,7 +228,7 @@ func (r *sensorGroupAssignmentResource) Delete( request := r.client.ConfigurationAPI. SensorGroupAssignmentDelete(ctx, state.ID.ValueString()) - _, response, err := util.RetryForTooManyRequests(request.Execute) + response, err := util.RetryForTooManyRequestsNoReturn(request.Execute) errorPresent, errorDetail := util.RaiseForStatus(response, err) if errorPresent { if response != nil && response.StatusCode == http.StatusNotFound { diff --git a/internal/provider/resources/resource_service_group_assignment.go b/internal/provider/resources/resource_service_group_assignment.go index ddb16b9..e37bc48 100644 --- a/internal/provider/resources/resource_service_group_assignment.go +++ b/internal/provider/resources/resource_service_group_assignment.go @@ -233,7 +233,7 @@ func (r *serviceTestGroupAssignmentResource) Delete( request := r.client.ConfigurationAPI. ServiceTestGroupAssignmentDelete(ctx, state.ID.ValueString()) - _, response, err := util.RetryForTooManyRequests(request.Execute) + response, err := util.RetryForTooManyRequestsNoReturn(request.Execute) errorPresent, errorDetail := util.RaiseForStatus(response, err) if errorPresent { if response != nil && response.StatusCode == http.StatusNotFound { diff --git a/internal/provider/util/retry.go b/internal/provider/util/retry.go index 293ca0a..7ff9332 100644 --- a/internal/provider/util/retry.go +++ b/internal/provider/util/retry.go @@ -15,6 +15,24 @@ import ( func RetryForTooManyRequests[T any]( f func() (T, *http.Response, error), +) (T, *http.Response, error) { + return retryForTooManyRequests(f) +} + +func RetryForTooManyRequestsNoReturn( + f func() (*http.Response, error), +) (*http.Response, error) { + _, httpResponse, err := retryForTooManyRequests(func() (struct{}, *http.Response, error) { + httpResponse, err := f() + + return struct{}{}, httpResponse, err + }) + + return httpResponse, err +} + +func retryForTooManyRequests[T any]( + f func() (T, *http.Response, error), ) (T, *http.Response, error) { var result T var err error diff --git a/pkg/config-api-client/README.md b/pkg/config-api-client/README.md index 7f8b0b9..1fd0a0c 100644 --- a/pkg/config-api-client/README.md +++ b/pkg/config-api-client/README.md @@ -5,7 +5,7 @@ This document outlines the API contracts for HPE Aruba Networking UXI. ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: 5.21.0 +- API version: 5.22.0 - Package version: 1.0.0 - Generator version: 7.9.0-SNAPSHOT - Build package: org.openapitools.codegen.languages.GoClientCodegen @@ -79,14 +79,14 @@ All URIs are relative to *https://api.capenetworks.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*ConfigurationAPI* | [**AgentDelete**](docs/ConfigurationAPI.md#agentdelete) | **Delete** /networking-uxi/v1alpha1/agents/{agent_uid} | Agent Delete -*ConfigurationAPI* | [**AgentGroupAssignmentDelete**](docs/ConfigurationAPI.md#agentgroupassignmentdelete) | **Delete** /networking-uxi/v1alpha1/agent-group-assignments/{uid} | Agent Group Assignment Delete +*ConfigurationAPI* | [**AgentDelete**](docs/ConfigurationAPI.md#agentdelete) | **Delete** /networking-uxi/v1alpha1/agents/{id} | Agent Delete +*ConfigurationAPI* | [**AgentGroupAssignmentDelete**](docs/ConfigurationAPI.md#agentgroupassignmentdelete) | **Delete** /networking-uxi/v1alpha1/agent-group-assignments/{id} | Agent Group Assignment Delete *ConfigurationAPI* | [**AgentGroupAssignmentPost**](docs/ConfigurationAPI.md#agentgroupassignmentpost) | **Post** /networking-uxi/v1alpha1/agent-group-assignments | Agent Group Assignment Post *ConfigurationAPI* | [**AgentGroupAssignmentsGet**](docs/ConfigurationAPI.md#agentgroupassignmentsget) | **Get** /networking-uxi/v1alpha1/agent-group-assignments | Agent Group Assignments Get -*ConfigurationAPI* | [**AgentPatch**](docs/ConfigurationAPI.md#agentpatch) | **Patch** /networking-uxi/v1alpha1/agents/{agent_uid} | Agent Patch +*ConfigurationAPI* | [**AgentPatch**](docs/ConfigurationAPI.md#agentpatch) | **Patch** /networking-uxi/v1alpha1/agents/{id} | Agent Patch *ConfigurationAPI* | [**AgentsGet**](docs/ConfigurationAPI.md#agentsget) | **Get** /networking-uxi/v1alpha1/agents | Agents Get -*ConfigurationAPI* | [**GroupDelete**](docs/ConfigurationAPI.md#groupdelete) | **Delete** /networking-uxi/v1alpha1/groups/{group_uid} | Group Delete -*ConfigurationAPI* | [**GroupPatch**](docs/ConfigurationAPI.md#grouppatch) | **Patch** /networking-uxi/v1alpha1/groups/{group_uid} | Group Patch +*ConfigurationAPI* | [**GroupDelete**](docs/ConfigurationAPI.md#groupdelete) | **Delete** /networking-uxi/v1alpha1/groups/{id} | Group Delete +*ConfigurationAPI* | [**GroupPatch**](docs/ConfigurationAPI.md#grouppatch) | **Patch** /networking-uxi/v1alpha1/groups/{id} | Group Patch *ConfigurationAPI* | [**GroupPost**](docs/ConfigurationAPI.md#grouppost) | **Post** /networking-uxi/v1alpha1/groups | Group Post *ConfigurationAPI* | [**GroupsGet**](docs/ConfigurationAPI.md#groupsget) | **Get** /networking-uxi/v1alpha1/groups | Groups Get *ConfigurationAPI* | [**NetworkGroupAssignmentDelete**](docs/ConfigurationAPI.md#networkgroupassignmentdelete) | **Delete** /networking-uxi/v1alpha1/network-group-assignments/{id} | Network Group Assignment Delete @@ -95,7 +95,7 @@ Class | Method | HTTP request | Description *ConfigurationAPI* | [**SensorGroupAssignmentDelete**](docs/ConfigurationAPI.md#sensorgroupassignmentdelete) | **Delete** /networking-uxi/v1alpha1/sensor-group-assignments/{id} | Sensor Group Assignment Delete *ConfigurationAPI* | [**SensorGroupAssignmentPost**](docs/ConfigurationAPI.md#sensorgroupassignmentpost) | **Post** /networking-uxi/v1alpha1/sensor-group-assignments | Sensor Group Assignment Post *ConfigurationAPI* | [**SensorGroupAssignmentsGet**](docs/ConfigurationAPI.md#sensorgroupassignmentsget) | **Get** /networking-uxi/v1alpha1/sensor-group-assignments | Sensor Group Assignments Get -*ConfigurationAPI* | [**SensorPatch**](docs/ConfigurationAPI.md#sensorpatch) | **Patch** /networking-uxi/v1alpha1/sensors/{sensor_uid} | Sensor Patch +*ConfigurationAPI* | [**SensorPatch**](docs/ConfigurationAPI.md#sensorpatch) | **Patch** /networking-uxi/v1alpha1/sensors/{id} | Sensor Patch *ConfigurationAPI* | [**SensorsGet**](docs/ConfigurationAPI.md#sensorsget) | **Get** /networking-uxi/v1alpha1/sensors | Sensors Get *ConfigurationAPI* | [**ServiceTestGroupAssignmentDelete**](docs/ConfigurationAPI.md#servicetestgroupassignmentdelete) | **Delete** /networking-uxi/v1alpha1/service-test-group-assignments/{id} | Service Test Group Assignment Delete *ConfigurationAPI* | [**ServiceTestGroupAssignmentPost**](docs/ConfigurationAPI.md#servicetestgroupassignmentpost) | **Post** /networking-uxi/v1alpha1/service-test-group-assignments | Service Test Group Assignment Post diff --git a/pkg/config-api-client/api/.openapi.source.yaml b/pkg/config-api-client/api/.openapi.source.yaml index 7811e07..d703a1b 100644 --- a/pkg/config-api-client/api/.openapi.source.yaml +++ b/pkg/config-api-client/api/.openapi.source.yaml @@ -1,3 +1,4 @@ + openapi: 3.0.3 info: title: HPE Aruba Networking UXI Configuration @@ -6,40 +7,164 @@ info: name: HPE Aruba Networking UXI Support url: https://help.capenetworks.com/en/ email: support@capenetworks.com - version: 5.21.0 + version: 5.22.0 servers: - url: https://api.capenetworks.com paths: - /networking-uxi/v1alpha1/agents/{agent_uid}: + /networking-uxi/v1alpha1/agents/{id}: delete: operationId: agent_delete summary: Agent Delete - description: Delete an existing agent. + description: Delete the specified agent parameters: - - name: agent_uid + - name: id in: path + description: The unique identifier of the agent required: true schema: + description: The unique identifier of the agent type: string - title: Agent Uid + title: Agent ID responses: - '200': + '204': description: Successful Response + '400': + description: Bad Request content: application/json: - schema: {} - '204': - description: No Content - 4XX: - description: Client Error + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + examples: + Not Found: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + summary: Not Found + description: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: Unprocessable Entity content: application/json: + examples: + Hardware sensor deletion forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_HARDWARE_SENSOR_DELETION_FORBIDDEN + httpStatusCode: 422 + message: >- + Cant delete sensor - hardware sensor deletion is + forbidden. + summary: Hardware sensor deletion forbidden + description: Cant delete sensor - hardware sensor deletion is forbidden. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -52,20 +177,35 @@ paths: patch: operationId: agent_patch summary: Agent Patch - description: Update an existing agent. + description: Patch the specified agent parameters: - - name: agent_uid + - name: id in: path + description: The unique identifier of the agent required: true schema: + description: The unique identifier of the agent type: string - title: Agent Uid + title: Agent ID requestBody: required: true content: application/merge-patch+json: schema: $ref: '#/components/schemas/AgentPatchRequest' + examples: + Update agent details: + summary: Update agent details + description: Update the details of the specified agent + value: + name: Updated Agent Name + notes: Updated notes + pcapMode: 'off' + Update agent name: + summary: Update agent name + description: Update the name of the specified agent + value: + name: Updated Agent Name responses: '200': description: Successful Response @@ -73,16 +213,140 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentPatchResponse' - 4XX: - description: Client Error + examples: + Updated agent: + value: + id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + serial: '1234567890' + name: Agent Name + modelNumber: UX-F5C + wifiMacAddress: '00:11:22:33:44:55' + ethernetMacAddress: '00:11:22:33:44:56' + notes: Notes + pcapMode: 'off' + type: networking-uxi/agent + summary: Updated agent + description: Agent successfully updated. + '400': + description: Bad Request content: application/json: + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + examples: + Not Found: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + summary: Not Found + description: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -93,36 +357,143 @@ paths: - v1alpha1 - agents x-stability-level: alpha - /networking-uxi/v1alpha1/agent-group-assignments/{uid}: + /networking-uxi/v1alpha1/agent-group-assignments/{id}: delete: operationId: agent_group_assignment_delete summary: Agent Group Assignment Delete - description: Delete an agent group assignment. + description: Delete the specified agent group assignment parameters: - - name: uid + - name: id in: path + description: The unique identifier of the assignment required: true schema: + description: The unique identifier of the assignment type: string - title: Uid + title: Assignment ID responses: - '200': + '204': description: Successful Response + '400': + description: Bad Request content: application/json: - schema: {} - '204': - description: No Content - 4XX: - description: Client Error + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '403': + description: Forbidden content: application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + examples: + Not Found: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + summary: Not Found + description: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -137,13 +508,20 @@ paths: post: operationId: agent_group_assignment_post summary: Agent Group Assignment Post - description: Create agent group assignment + description: Create an agent group assignment requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AgentGroupAssignmentPostRequest' + examples: + Create an agent group assignment: + summary: Create an agent group assignment + description: Create an agent group assignment + value: + groupId: e0f97a387c31 + agentId: 0f4c2917-9886-41bf-8ea6-faaea9fddbf0 responses: '200': description: Successful Response @@ -151,16 +529,180 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentGroupAssignmentPostResponse' - 4XX: - description: Client Error + examples: + Agent group assignment created: + value: + id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + agent: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/agent-group-assignment + summary: Agent group assignment created + description: Agent group assignment successfully created. + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '403': + description: Forbidden content: application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Conflict + content: + application/json: + examples: + Assignment already exists: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_CONFLICT + httpStatusCode: 409 + message: Resource already exists. + summary: Assignment already exists + description: Resource already exists. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: Unprocessable Entity + content: + application/json: + examples: + Agent does not exist: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_AGENT_DOES_NOT_EXIST + httpStatusCode: 422 + message: >- + Unable to assign agent to group - the specified agent does + not exist. + summary: Agent does not exist + description: >- + Unable to assign agent to group - the specified agent does + not exist. + Assignment to root group error: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_ASSIGN_AGENT_TO_ROOT_GROUP + httpStatusCode: 422 + message: >- + Unable to assign agent to group - the specified group is a + root group. + summary: Assignment to root group error + description: >- + Unable to assign agent to group - the specified group is a + root group. + Group does not exist: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: >- + Unable to assign agent to group - the specified group does + not exist. + summary: Group does not exist + description: >- + Unable to assign agent to group - the specified group does + not exist. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -178,24 +720,28 @@ paths: parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -208,16 +754,113 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentGroupAssignmentsGetResponse' - 4XX: - description: Client Error + examples: + List of agent group assignments: + value: + items: + - id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + agent: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/agent-group-assignment + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of agent group assignments + description: List of agent group assignment retrieval. + '400': + description: Bad Request + content: + application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '403': + description: Forbidden content: application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -236,24 +879,28 @@ paths: parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -266,16 +913,116 @@ paths: application/json: schema: $ref: '#/components/schemas/AgentsGetResponse' - 4XX: - description: Client Error + examples: + List of agents: + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + serial: '1234567890' + name: Agent Name + modelNumber: UX-F5C + wifiMacAddress: '00:11:22:33:44:55' + ethernetMacAddress: '00:11:22:33:44:56' + notes: Notes + pcapMode: 'off' + type: networking-uxi/agent + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of agents + description: List of agents retrieval. + '400': + description: Bad Request + content: + application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type content: application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -286,36 +1033,160 @@ paths: - v1alpha1 - agents x-stability-level: alpha - /networking-uxi/v1alpha1/groups/{group_uid}: + /networking-uxi/v1alpha1/groups/{id}: delete: operationId: group_delete summary: Group Delete - description: Delete an existing group. + description: >- + Delete an existing group. Deleting a group will also delete all child + groups and resource assignments to any deleted group. parameters: - - name: group_uid + - name: id in: path + description: The unique identifier of the group. required: true schema: + description: The unique identifier of the group. type: string - title: Group Uid + title: Group ID responses: - '200': + '204': description: Successful Response + '400': + description: Bad Request content: application/json: - schema: {} - '204': - description: No Content - 4XX: - description: Client Error + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '403': + description: Forbidden content: application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + examples: + Not Found: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + summary: Not Found + description: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: Unprocessable Entity + content: + application/json: + examples: + Cannot delete root group: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_DELETE_ROOT_GROUP + httpStatusCode: 422 + message: Cannot delete group - the root group cannot be deleted. + summary: Cannot delete root group + description: Cannot delete group - the root group cannot be deleted. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -329,20 +1200,28 @@ paths: patch: operationId: group_patch summary: Group Patch - description: Update an existing group. + description: Update the properties of a group. parameters: - - name: group_uid + - name: id in: path + description: The unique identifier of the group required: true schema: + description: The unique identifier of the group type: string - title: Group Uid + title: Group ID requestBody: required: true content: application/merge-patch+json: schema: $ref: '#/components/schemas/GroupPatchRequest' + examples: + Update group name: + summary: Update group name + description: Update the name of the specified group + value: + name: Updated Group Name responses: '200': description: Successful Response @@ -350,16 +1229,164 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupPatchResponse' - 4XX: - description: Client Error + examples: + Updated group: + value: + id: dsfldjsah389 + name: Group Name + path: 4gergsdgdf4tr.dsfldjsah389 + parent: + id: 4gergsdgdf4tr + type: networking-uxi/group + summary: Updated group + description: Group successfully updated. + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + examples: + Not Found: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + summary: Not Found + description: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type content: application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '422': + description: Unprocessable Entity content: application/json: + examples: + Duplicate sibling group name: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_DUPLICATE_SIBLING_GROUP_NAME + httpStatusCode: 422 + message: >- + Unable to update group - a sibling group already has the + specified name. + summary: Duplicate sibling group name + description: >- + Unable to update group - a sibling group already has the + specified name. + Cannot update the root group: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_UPDATE_ROOT_GROUP + httpStatusCode: 422 + message: Unable to update group - the root group cannot be updated. + summary: Cannot update the root group + description: Unable to update group - the root group cannot be updated. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -374,13 +1401,28 @@ paths: post: operationId: group_post summary: Group Post - description: Create a new group with the group identified in `parentId` as its parent + description: >- + Create a new group with the specified name as a child group of the + specified parent group. When `parentId` is omitted, the new group is + created as a child of the root group. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GroupPostRequest' + examples: + Create a new group (specify parent ID): + summary: Create a new group (specify parent ID) + description: Create a new group as a child of the specified parent group + value: + parentId: e0f97a387c31 + name: Example Group + Create a new group (parent ID not specified): + summary: Create a new group (parent ID not specified) + description: Create a new group as a top level configurable group + value: + name: Example Group responses: '200': description: Successful Response @@ -388,16 +1430,189 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupPostResponse' - 4XX: - description: Client Error + examples: + Group created: + value: + id: dsfldjsah389 + name: Group Name + path: 4gergsdgdf4tr.dsfldjsah389 + parent: + id: 4gergsdgdf4tr + type: networking-uxi/group + summary: Group created + description: Group successfully created. + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed content: application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '415': + description: Unsupported Media Type content: application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: Unprocessable Entity + content: + application/json: + examples: + Parent group does not exist: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_PARENT_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: >- + Unable to create group - the specified parent group does + not exist. + summary: Parent group does not exist + description: >- + Unable to create group - the specified parent group does not + exist. + Duplicate sibling group name: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_DUPLICATE_SIBLING_GROUP_NAME + httpStatusCode: 422 + message: >- + Unable to create group - a sibling group already has the + specified name. + summary: Duplicate sibling group name + description: >- + Unable to create group - a sibling group already has the + specified name. + Maximum group depth exceeded: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MAXIMUM_GROUP_DEPTH_EXCEEDED + httpStatusCode: 422 + message: >- + Unable to create group - the maximum group depth has been + exceeded. + summary: Maximum group depth exceeded + description: >- + Unable to create group - the maximum group depth has been + exceeded. + Parent has too many children: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_PARENT_HAS_TOO_MANY_CHILDREN + httpStatusCode: 422 + message: >- + Unable to create group - the maximum number of children + for the specified parent has been exceeded. + summary: Parent has too many children + description: >- + Unable to create group - the maximum number of children for + the specified parent has been exceeded. + Maximum group count exceeded: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MAXIMUM_GROUP_COUNT_EXCEEDED + httpStatusCode: 422 + message: >- + Unable to create group - the maximum group count has been + exceeded. + summary: Maximum group count exceeded + description: >- + Unable to create group - the maximum group count has been + exceeded. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -411,28 +1626,32 @@ paths: get: operationId: groups_get summary: Groups Get - description: Lists groups matching provided criteria + description: Get a list of groups parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -445,16 +1664,113 @@ paths: application/json: schema: $ref: '#/components/schemas/GroupsGetResponse' - 4XX: - description: Client Error + examples: + List of groups: + value: + items: + - id: dsfldjsah389 + name: Group Name + parent: + id: 4gergsdgdf4tr + path: 4gergsdgdf4tr.dsfldjsah389 + type: networking-uxi/group + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of groups + description: List of groups successfully retrieval. + '400': + description: Bad Request content: application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -469,32 +1785,170 @@ paths: delete: operationId: network_group_assignment_delete summary: Network Group Assignment Delete - description: Delete a network group assignment + description: Delete the specified network group assignment parameters: - name: id in: path + description: The unique identifier of the network group assignment required: true schema: + description: The unique identifier of the network group assignment type: string - title: Id + title: Assignment ID responses: - '200': + '204': description: Successful Response + '400': + description: Bad Request content: application/json: - schema: {} - '204': - description: No Content - 4XX: - description: Client Error + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '403': + description: Forbidden content: application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + examples: + Not Found: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + summary: Not Found + description: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: Unprocessable Entity + content: + application/json: + examples: + Unassign orphans sensor error: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_DELETE_ORPHANS_SENSOR + httpStatusCode: 422 + message: >- + Unable to delete assignment - the assignment will leave a + sensor unconfigured. + summary: Unassign orphans sensor error + description: >- + Unable to delete assignment - the assignment will leave a + sensor unconfigured. + Inherited assignment deletion error: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_DELETE_INHERITED_ASSIGNMENT + httpStatusCode: 422 + message: >- + Unable to delete assignment - an inherited assignment + cannot be deleted. + summary: Inherited assignment deletion error + description: >- + Unable to delete assignment - an inherited assignment cannot + be deleted. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -509,13 +1963,20 @@ paths: post: operationId: network_group_assignment_post summary: Network Group Assignment Post - description: Create a network group assignment + description: Create a network group assignment. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/NetworkGroupAssignmentPostRequest' + examples: + Create a network group assignment: + summary: Create a network group assignment + description: Create a network group assignment. + value: + groupId: dsfldjsah389 + networkId: ssid-4gergsdgdf4tr responses: '200': description: Successful Response @@ -523,16 +1984,180 @@ paths: application/json: schema: $ref: '#/components/schemas/NetworkGroupAssignmentPostResponse' - 4XX: - description: Client Error + examples: + Create a network group assignment: + value: + id: 90e79136-8c10-4732-9e2a-c928f39c03b8 + group: + id: dsfldjsah389 + network: + id: ssid-4gergsdgdf4tr + type: networking-uxi/network-group-assignment + summary: Create a network group assignment + description: Network group assignment successfully created. + '400': + description: Bad Request content: application/json: + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Conflict + content: + application/json: + examples: + Assignment already exists: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_CONFLICT + httpStatusCode: 409 + message: Resource already exists. + summary: Assignment already exists + description: Resource already exists. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: Unprocessable Entity + content: + application/json: + examples: + Network does not exist: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_NETWORK_DOES_NOT_EXIST + httpStatusCode: 422 + message: >- + Unable to assign network to group - the specified network + does not exist. + summary: Network does not exist + description: >- + Unable to assign network to group - the specified network + does not exist. + Group does not exist: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: >- + Unable to assign network to group - the specified group + does not exist. + summary: Group does not exist + description: >- + Unable to assign network to group - the specified group does + not exist. + Assignment to root group error: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_ASSIGN_NETWORK_TO_ROOT_GROUP + httpStatusCode: 422 + message: >- + Unable to assign network to group - the specified group is + a root group. + summary: Assignment to root group error + description: >- + Unable to assign network to group - the specified group is a + root group. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -546,28 +2171,32 @@ paths: get: operationId: network_group_assignments_get summary: Network Group Assignments Get - description: Get a list of network group assignments + description: Get a list of network group assignments. parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -580,16 +2209,113 @@ paths: application/json: schema: $ref: '#/components/schemas/NetworkGroupAssignmentsGetResponse' - 4XX: - description: Client Error + examples: + List of network group assignments: + value: + items: + - id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + network: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/network-group-assignment + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of network group assignments + description: Network group assignment list retrieval. + '400': + description: Bad Request content: application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -604,32 +2330,139 @@ paths: delete: operationId: sensor_group_assignment_delete summary: Sensor Group Assignment Delete - description: Delete a sensor group assignment + description: Delete the specified sensor group assignment parameters: - name: id in: path + description: The unique identifier of the sensor group assignment required: true schema: + description: The unique identifier of the sensor group assignment type: string - title: Id + title: Assignment ID responses: - '200': + '204': description: Successful Response + '400': + description: Bad Request content: application/json: - schema: {} - '204': - description: No Content - 4XX: - description: Client Error + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden content: application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '404': + description: Not Found content: application/json: + examples: + Not Found: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + summary: Not Found + description: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -644,13 +2477,20 @@ paths: post: operationId: sensor_group_assignment_post summary: Sensor Group Assignment Post - description: Create sensor group assignment + description: Create a sensor group assignment. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SensorGroupAssignmentPostRequest' + examples: + Create a sensor group assignment: + summary: Create a sensor group assignment + description: Create a sensor group assignment. + value: + groupId: dsfldjsah389 + sensorId: sensor-4gergsdgdf4tr responses: '200': description: Successful Response @@ -658,16 +2498,180 @@ paths: application/json: schema: $ref: '#/components/schemas/SensorGroupAssignmentPostResponse' - 4XX: - description: Client Error + examples: + Sensor group assignment created: + value: + id: 90e79136-8c10-4732-9e2a-c928f39c03b8 + group: + id: dsfldjsah389 + sensor: + id: sensor-4gergsdgdf4tr + type: networking-uxi/sensor-group-assignment + summary: Sensor group assignment created + description: Sensor group assignment successfully created. + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Conflict + content: + application/json: + examples: + Assignment already exists: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_CONFLICT + httpStatusCode: 409 + message: Resource already exists. + summary: Assignment already exists + description: Resource already exists. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: Unprocessable Entity content: application/json: + examples: + Sensor does not exist: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_SENSOR_DOES_NOT_EXIST + httpStatusCode: 422 + message: >- + Unable to assign sensor to group - the specified sensor + does not exist. + summary: Sensor does not exist + description: >- + Unable to assign sensor to group - the specified sensor does + not exist. + Group does not exist: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: >- + Unable to assign sensor to group - the specified group + does not exist. + summary: Group does not exist + description: >- + Unable to assign sensor to group - the specified group does + not exist. + Assignment to root group error: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_ASSIGN_SENSOR_TO_ROOT_GROUP + httpStatusCode: 422 + message: >- + Unable to assign sensor to group - the specified group is + a root group. + summary: Assignment to root group error + description: >- + Unable to assign sensor to group - the specified group is a + root group. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -681,28 +2685,32 @@ paths: get: operationId: sensor_group_assignments_get summary: Sensor Group Assignments Get - description: Get a list of sensor group assignments + description: Get a list of sensor group assignments. parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -715,16 +2723,113 @@ paths: application/json: schema: $ref: '#/components/schemas/SensorGroupAssignmentsGetResponse' - 4XX: - description: Client Error + examples: + List of sensor group assignments: + value: + items: + - id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + sensor: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/sensor-group-assignment + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of sensor group assignments + description: Sensor group assignment list retrieval. + '400': + description: Bad Request + content: + application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type content: application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -735,24 +2840,40 @@ paths: - v1alpha1 - sensor-group-assignments x-stability-level: alpha - /networking-uxi/v1alpha1/sensors/{sensor_uid}: + /networking-uxi/v1alpha1/sensors/{id}: patch: operationId: sensor_patch summary: Sensor Patch - description: Update an existing sensor. + description: Update the properties of a sensor. parameters: - - name: sensor_uid + - name: id in: path + description: The unique identifier of the sensor required: true schema: + description: The unique identifier of the sensor type: string - title: Sensor Uid + title: Sensor ID requestBody: required: true content: application/merge-patch+json: schema: $ref: '#/components/schemas/SensorPatchRequest' + examples: + Update sensor details: + summary: Update sensor details + description: Update the details of the specified sensor + value: + name: Updated Agent Name + pcapMode: 'off' + notes: Updated notes + addressNote: Updated address note + Update sensor name: + summary: Update sensor name + description: Update the name of the specified sensor + value: + name: Updated Sensor Name responses: '200': description: Successful Response @@ -760,16 +2881,143 @@ paths: application/json: schema: $ref: '#/components/schemas/SensorPatchResponse' - 4XX: - description: Client Error + examples: + Updated sensor: + value: + id: dsfldjsah389 + serial: '123456789' + name: Sensor Name + modelNumber: UX-F5C + wifiMacAddress: '00:11:22:33:44:55' + ethernetMacAddress: 66:77:88:99:AA:BB + addressNote: Office + longitude: 12.345678 + latitude: 98.765432 + notes: Some notes + pcapMode: 'off' + type: networking-uxi/sensor + summary: Updated sensor + description: Sensor successfully updated. + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + examples: + Not Found: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + summary: Not Found + description: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type content: application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -784,28 +3032,32 @@ paths: get: operationId: sensors_get summary: Sensors Get - description: Get a list of sensors + description: List of sensors parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -818,16 +3070,119 @@ paths: application/json: schema: $ref: '#/components/schemas/SensorsGetResponse' - 4XX: - description: Client Error + examples: + List of sensors: + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + serial: '1234567890' + name: Sensor Name + modelNumber: UX-F5C + wifiMacAddress: '00:11:22:33:44:55' + ethernetMacAddress: '00:11:22:33:44:56' + addressNote: Address Note + longitude: 12.345678 + latitude: 98.765432 + notes: Notes + pcapMode: 'off' + type: networking-uxi/sensor + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of sensors + description: List of sensors retrieval. + '400': + description: Bad Request + content: + application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type content: application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -842,32 +3197,158 @@ paths: delete: operationId: service_test_group_assignment_delete summary: Service Test Group Assignment Delete - description: Delete a service test group assignment + description: Delete the specified service test group assignment parameters: - name: id in: path + description: The unique identifier of the service test group assignment required: true schema: + description: The unique identifier of the service test group assignment type: string - title: Id + title: Assignment ID responses: - '200': + '204': description: Successful Response + '400': + description: Bad Request content: application/json: - schema: {} - '204': - description: No Content - 4XX: - description: Client Error + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Not Found + content: + application/json: + examples: + Not Found: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + summary: Not Found + description: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: Unprocessable Entity content: application/json: + examples: + Inherited assignment deletion error: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_DELETE_INHERITED_ASSIGNMENT + httpStatusCode: 422 + message: >- + Unable to delete assignment - an inherited assignment + cannot be deleted. + summary: Inherited assignment deletion error + description: >- + Unable to delete assignment - an inherited assignment cannot + be deleted. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -882,13 +3363,20 @@ paths: post: operationId: service_test_group_assignment_post summary: Service Test Group Assignment Post - description: Create a service-test group assignment + description: Create a service-test group assignment. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ServiceTestGroupAssignmentPostRequest' + examples: + Create a service test group assignment: + summary: Create a service test group assignment + description: Create a service test group assignment. + value: + groupId: dsfldjsah389 + serviceTestId: dcccdabe-434b-40af-aac1-cf4c205dd5cc responses: '200': description: Successful Response @@ -896,16 +3384,206 @@ paths: application/json: schema: $ref: '#/components/schemas/ServiceTestGroupAssignmentPostResponse' - 4XX: - description: Client Error + examples: + Service test group assignment created: + value: + id: 90e79136-8c10-4732-9e2a-c928f39c03b8 + group: + id: dsfldjsah389 + serviceTest: + id: dcccdabe-434b-40af-aac1-cf4c205dd5cc + type: networking-uxi/service-test-group-assignment + summary: Service test group assignment created + description: Service test group assignment successfully created. + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: >- + The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: >- + The request could not be processed due to a + validation error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + summary: Bad Request + description: >- + The request could not be processed due to a validation + error. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Conflict + content: + application/json: + examples: + Assignment already exists: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_CONFLICT + httpStatusCode: 409 + message: Resource already exists. + summary: Assignment already exists + description: Resource already exists. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '422': + description: Unprocessable Entity content: application/json: + examples: + Assignment to root group error: + value: + debugId: '1234567890' + errorCode: >- + HPE_GL_NETWORKING_UXI_CANNOT_ASSIGN_SERVICE_TEST_TO_ROOT_GROUP + httpStatusCode: 422 + message: >- + Unable to assign service test to group - the specified + group is a root group. + summary: Assignment to root group error + description: >- + Unable to assign service test to group - the specified group + is a root group. + Group does not exist: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: >- + Unable to assign service test to group - the specified + group does not exist. + summary: Group does not exist + description: >- + Unable to assign service test to group - the specified group + does not exist. + Service test does not exist: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_SERVICE_TEST_DOES_NOT_EXIST + httpStatusCode: 422 + message: >- + Unable to assign service test to group - the specified + service test does not exist. + summary: Service test does not exist + description: >- + Unable to assign service test to group - the specified + service test does not exist. + Service test group assignment already exists: + value: + debugId: '1234567890' + errorCode: >- + HPE_GL_NETWORKING_UXI_SERVICE_TEST_GROUP_ASSIGNMENT_ALREADY_EXISTS + httpStatusCode: 422 + message: >- + Unable to assign service test to group - the service test + group assignment already exists. + summary: Service test group assignment already exists + description: >- + Unable to assign service test to group - the service test + group assignment already exists. + Service test has network exclusions: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_SERVICE_TEST_HAS_NETWORK_EXCLUSIONS + httpStatusCode: 422 + message: >- + Unable to assign service test to group - the specified + service test has network exclusions. + summary: Service test has network exclusions + description: >- + Unable to assign service test to group - the specified + service test has network exclusions. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -919,28 +3597,32 @@ paths: get: operationId: service_test_group_assignments_get summary: Service Test Group Assignments Get - description: Get a list of service test group assignments + description: Get a list of service test group assignments. parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -953,16 +3635,113 @@ paths: application/json: schema: $ref: '#/components/schemas/ServiceTestGroupAssignmentsGetResponse' - 4XX: - description: Client Error + examples: + List of service test group assignments: + value: + items: + - id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + serviceTest: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/service-test-group-assignment + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of service test group assignments + description: Service test group assignment list retrieval. + '400': + description: Bad Request + content: + application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized content: application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '403': + description: Forbidden content: application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type + content: + application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -981,24 +3760,28 @@ paths: parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -1011,16 +3794,114 @@ paths: application/json: schema: $ref: '#/components/schemas/ServiceTestsGetResponse' - 4XX: - description: Client Error + examples: + List of service tests: + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + category: Category + name: Service Test Name + target: Target + template: Template + isEnabled: true + type: networking-uxi/service-test + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of service tests + description: List of service tests retrieval. + '400': + description: Bad Request + content: + application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type content: application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -1039,24 +3920,28 @@ paths: parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -1069,16 +3954,119 @@ paths: application/json: schema: $ref: '#/components/schemas/WiredNetworksGetResponse' - 4XX: - description: Client Error + examples: + List of wired networks: + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + name: Wired Network Name + ipVersion: ipv4 + createdAt: '2023-10-01T12:34:56Z' + updatedAt: '2023-10-01T12:34:56Z' + security: WPA2 + dnsLookupDomain: example.com + disableEdns: false + useDns64: true + externalConnectivity: true + vLanId: 100 + type: networking-uxi/wired-network + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of wired networks + description: List of wired networks retrieval. + '400': + description: Bad Request + content: + application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type content: application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -1097,24 +4085,28 @@ paths: parameters: - name: id in: query + description: The ID of the resource. required: false schema: - anyOf: - - type: string + description: The ID of the resource. + type: string nullable: true - title: Id + title: ID - name: next in: query + description: The next cursor for pagination. required: false schema: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next - name: limit in: query + description: The maximum number of items returned in the response. required: false schema: + description: The maximum number of items returned in the response. type: integer default: 50 maximum: 100 @@ -1127,16 +4119,121 @@ paths: application/json: schema: $ref: '#/components/schemas/WirelessNetworksGetResponse' - 4XX: - description: Client Error + examples: + List of wireless networks: + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + name: Wireless Network Name + ssid: SSID + security: WPA2 + ipVersion: ipv4 + createdAt: '2023-01-01T00:00:00Z' + updatedAt: '2023-01-02T00:00:00Z' + hidden: false + bandLocking: 2.4GHz + dnsLookupDomain: example.com + disableEdns: false + useDns64: false + externalConnectivity: true + type: networking-uxi/wireless-network + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== + summary: List of wireless networks + description: List of wireless networks retrieval. + '400': + description: Bad Request + content: + application/json: + examples: + Malformed cursor: + value: + debugId: '1234567890' + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + summary: Malformed cursor + description: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: >- + You are not authorized to perform this action - the token + is missing, expired, revoked, malformed, or invalid for + other reasons + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Forbidden + content: + application/json: + examples: + Forbidden: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: >- + The user has insufficient permissions to complete the + request. + summary: Forbidden + description: >- + The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + '405': + description: Method Not Allowed + content: + application/json: + examples: + Method Not Allowed: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + summary: Method Not Allowed + description: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + '415': + description: Unsupported Media Type content: application/json: + examples: + Unsupported Media Type: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + summary: Unsupported Media Type + description: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - 5XX: - description: Server Error + '500': + description: Internal Server Error content: application/json: + examples: + Internal Server Error: + value: + debugId: '1234567890' + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + description: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' security: @@ -1153,8 +4250,9 @@ components: type: object properties: id: + description: The unique identifier of the agent type: string - title: Id + title: Agent ID required: - id title: AgentGroupAssignmentPostAgent @@ -1162,8 +4260,9 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: Group ID required: - id title: AgentGroupAssignmentPostGroup @@ -1171,11 +4270,13 @@ components: type: object properties: groupId: + description: The unique identifier of the group type: string - title: Groupid + title: Group ID agentId: + description: The unique identifier of the agent type: string - title: Agentid + title: Agent ID required: - groupId - agentId @@ -1184,13 +4285,15 @@ components: type: object properties: id: + description: The unique identifier of the agent group assignment type: string - title: Id + title: ID group: $ref: '#/components/schemas/AgentGroupAssignmentPostGroup' agent: $ref: '#/components/schemas/AgentGroupAssignmentPostAgent' type: + description: The type of the resource. type: string enum: - networking-uxi/agent-group-assignment @@ -1205,8 +4308,9 @@ components: type: object properties: id: + description: The unique identifier of the agent type: string - title: Id + title: Agent ID required: - id title: AgentGroupAssignmentsGetAgent @@ -1214,8 +4318,9 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: Group ID required: - id title: AgentGroupAssignmentsGetGroup @@ -1223,13 +4328,15 @@ components: type: object properties: id: + description: The unique identifier of the agent group assignment type: string - title: Id + title: ID group: $ref: '#/components/schemas/AgentGroupAssignmentsGetGroup' agent: $ref: '#/components/schemas/AgentGroupAssignmentsGetAgent' type: + description: The type of the resource. type: string enum: - networking-uxi/agent-group-assignment @@ -1244,16 +4351,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/AgentGroupAssignmentsGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -1266,11 +4375,13 @@ components: type: object properties: name: + description: The name of the agent type: string maxLength: 100 minLength: 1 title: Name notes: + description: The notes of the agent type: string title: Notes pcapMode: @@ -1280,39 +4391,46 @@ components: type: object properties: id: + description: The unique identifier of the agent type: string - title: Id + title: ID serial: + description: The serial number of the agent type: string title: Serial name: + description: The name of the agent type: string title: Name modelNumber: - anyOf: - - type: string + description: The model number of the agent + type: string nullable: true - title: Modelnumber + title: Model Number wifiMacAddress: - anyOf: - - type: string + description: The WiFi MAC address of the agent + type: string nullable: true - title: Wifimacaddress + title: WiFi MAC Address ethernetMacAddress: - anyOf: - - type: string + description: The Ethernet MAC address of the agent + type: string nullable: true - title: Ethernetmacaddress + title: Ethernet MAC Address notes: - anyOf: - - type: string + description: The notes of the agent + type: string nullable: true title: Notes pcapMode: + description: The pcap mode of the agent + type: string anyOf: - $ref: '#/components/schemas/AgentPcapMode' nullable: true + title: PcapMode type: + description: The type of the resource. type: string enum: - networking-uxi/agent @@ -1339,39 +4457,46 @@ components: type: object properties: id: + description: The unique identifier of the agent type: string - title: Id + title: ID serial: + description: The serial number of the agent type: string title: Serial name: + description: The name of the agent type: string title: Name modelNumber: - anyOf: - - type: string + description: The model number of the agent + type: string nullable: true - title: Modelnumber + title: Model Number wifiMacAddress: - anyOf: - - type: string + description: The WiFi MAC address of the agent + type: string nullable: true - title: Wifimacaddress + title: WiFi MAC Address ethernetMacAddress: - anyOf: - - type: string + description: The Ethernet MAC address of the agent + type: string nullable: true - title: Ethernetmacaddress + title: Ethernet MAC Address notes: - anyOf: - - type: string + description: The notes of the agent + type: string nullable: true title: Notes pcapMode: + description: The pcap mode of the agent + type: string anyOf: - $ref: '#/components/schemas/AgentPcapMode' nullable: true + title: PcapMode type: + description: The type of the resource. type: string enum: - networking-uxi/agent @@ -1391,16 +4516,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/AgentsGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -1439,10 +4566,9 @@ components: type: string title: Message errorDetails: - anyOf: - - items: - $ref: '#/components/schemas/ErrorDetail' - type: array + type: array + items: + $ref: '#/components/schemas/ErrorDetail' nullable: true title: Errordetails required: @@ -1455,8 +4581,9 @@ components: type: object properties: id: + description: The unique identifier of the parent group type: string - title: Id + title: ID required: - id title: GroupPatchParent @@ -1464,6 +4591,7 @@ components: type: object properties: name: + description: The updated group name type: string maxLength: 250 minLength: 1 @@ -1473,17 +4601,21 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: ID name: + description: The name of the group type: string title: Name path: + description: The path of the group type: string title: Path parent: $ref: '#/components/schemas/GroupPatchParent' type: + description: The type of the resource. type: string enum: - networking-uxi/group @@ -1499,8 +4631,9 @@ components: type: object properties: id: + description: The unique identifier of the parent group type: string - title: Id + title: ID required: - id title: GroupPostParent @@ -1508,11 +4641,12 @@ components: type: object properties: parentId: - anyOf: - - type: string + description: The unique identifier of the parent group + type: string nullable: true - title: Parentid + title: Parent Group ID name: + description: The name of the group type: string maxLength: 250 minLength: 1 @@ -1524,17 +4658,21 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: ID name: + description: The name of the group type: string title: Name path: + description: The path of the group type: string title: Path parent: $ref: '#/components/schemas/GroupPostParent' type: + description: The type of the resource. type: string enum: - networking-uxi/group @@ -1550,19 +4688,26 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: ID name: + description: The name of the group type: string title: Name parent: + description: The parent group + type: object anyOf: - $ref: '#/components/schemas/GroupsGetParent' nullable: true + title: Parent path: + description: The path of the group type: string title: Path type: + description: The type of the resource. type: string enum: - networking-uxi/group @@ -1578,8 +4723,9 @@ components: type: object properties: id: + description: The unique identifier of the parent group type: string - title: Id + title: Parent ID required: - id title: GroupsGetParent @@ -1587,16 +4733,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/GroupsGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -1637,8 +4785,9 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: Group ID required: - id title: NetworkGroupAssignmentPostGroup @@ -1646,8 +4795,9 @@ components: type: object properties: id: + description: The unique identifier of the network type: string - title: Id + title: Network ID required: - id title: NetworkGroupAssignmentPostNetwork @@ -1655,11 +4805,13 @@ components: type: object properties: groupId: + description: The unique identifier of the group type: string - title: Groupid + title: Group ID networkId: + description: The unique identifier of the network type: string - title: Networkid + title: Network ID required: - groupId - networkId @@ -1668,14 +4820,15 @@ components: type: object properties: id: + description: The unique identifier of the network group assignment type: string - format: uuid - title: Id + title: ID group: $ref: '#/components/schemas/NetworkGroupAssignmentPostGroup' network: $ref: '#/components/schemas/NetworkGroupAssignmentPostNetwork' type: + description: The type of the resource. type: string enum: - networking-uxi/network-group-assignment @@ -1690,8 +4843,9 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: Group ID required: - id title: NetworkGroupAssignmentsGetGroup @@ -1699,13 +4853,15 @@ components: type: object properties: id: + description: The unique identifier of the network group assignment type: string - title: Id + title: ID group: $ref: '#/components/schemas/NetworkGroupAssignmentsGetGroup' network: $ref: '#/components/schemas/NetworkGroupAssignmentsGetNetwork' type: + description: The type of the resource. type: string enum: - networking-uxi/network-group-assignment @@ -1720,8 +4876,9 @@ components: type: object properties: id: + description: The unique identifier of the network type: string - title: Id + title: Network ID required: - id title: NetworkGroupAssignmentsGetNetwork @@ -1729,16 +4886,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/NetworkGroupAssignmentsGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -1750,8 +4909,9 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: Group ID required: - id title: SensorGroupAssignmentPostGroup @@ -1759,11 +4919,13 @@ components: type: object properties: groupId: + description: The unique identifier of the group type: string - title: Groupid + title: Group ID sensorId: + description: The unique identifier of the sensor type: string - title: Sensorid + title: Sensor ID required: - groupId - sensorId @@ -1772,13 +4934,15 @@ components: type: object properties: id: + description: The unique identifier of the sensor group assignment type: string - title: Id + title: ID group: $ref: '#/components/schemas/SensorGroupAssignmentPostGroup' sensor: $ref: '#/components/schemas/SensorGroupAssignmentPostSensor' type: + description: The type of the resource. type: string enum: - networking-uxi/sensor-group-assignment @@ -1793,8 +4957,9 @@ components: type: object properties: id: + description: The unique identifier of the sensor type: string - title: Id + title: Sensor ID required: - id title: SensorGroupAssignmentPostSensor @@ -1802,8 +4967,9 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: Group ID required: - id title: SensorGroupAssignmentsGetGroup @@ -1811,13 +4977,15 @@ components: type: object properties: id: + description: The unique identifier of the sensor group assignment type: string - title: Id + title: ID group: $ref: '#/components/schemas/SensorGroupAssignmentsGetGroup' sensor: $ref: '#/components/schemas/SensorGroupAssignmentsGetSensor' type: + description: The type of the resource. type: string enum: - networking-uxi/sensor-group-assignment @@ -1832,16 +5000,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/SensorGroupAssignmentsGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -1853,8 +5023,9 @@ components: type: object properties: id: + description: The unique identifier of the sensor type: string - title: Id + title: Sensor ID required: - id title: SensorGroupAssignmentsGetSensor @@ -1863,14 +5034,17 @@ components: type: object properties: name: + description: The updated sensor name type: string maxLength: 100 minLength: 1 title: Name addressNote: + description: The updated address note for the sensor type: string - title: Addressnote + title: Address Note notes: + description: Additional notes for the sensor type: string title: Notes pcapMode: @@ -1880,52 +5054,60 @@ components: type: object properties: id: + description: The unique identifier of the sensor type: string - title: Id + title: ID serial: + description: The serial number of the sensor type: string title: Serial name: + description: The name of the sensor type: string title: Name modelNumber: + description: The model number of the sensor type: string - title: Modelnumber + title: Model Number wifiMacAddress: - anyOf: - - type: string + description: The WiFi MAC address of the sensor + type: string nullable: true - title: Wifimacaddress + title: WiFi MAC Address ethernetMacAddress: - anyOf: - - type: string + description: The Ethernet MAC address of the sensor + type: string nullable: true - title: Ethernetmacaddress + title: Ethernet MAC Address addressNote: - anyOf: - - type: string + description: The address note of the sensor + type: string nullable: true - title: Addressnote + title: Address Note longitude: - anyOf: - - type: number + description: The longitude of the sensor + type: number nullable: true title: Longitude latitude: - anyOf: - - type: number + description: The latitude of the sensor + type: number nullable: true title: Latitude notes: - anyOf: - - type: string + description: Additional notes for the sensor + type: string nullable: true title: Notes pcapMode: + description: The pcap mode of the sensor + type: string anyOf: - $ref: '#/components/schemas/SensorPcapMode' nullable: true + title: PcapMode type: + description: The type of the resource. type: string enum: - networking-uxi/sensor @@ -1955,52 +5137,60 @@ components: type: object properties: id: + description: The unique identifier of the sensor type: string - title: Id + title: ID serial: + description: The serial number of the sensor type: string title: Serial name: + description: The name of the sensor type: string title: Name modelNumber: + description: The model number of the sensor type: string - title: Modelnumber + title: Model Number wifiMacAddress: - anyOf: - - type: string + description: The WiFi MAC address of the sensor + type: string nullable: true - title: Wifimacaddress + title: WiFi MAC Address ethernetMacAddress: - anyOf: - - type: string + description: The Ethernet MAC address of the sensor + type: string nullable: true - title: Ethernetmacaddress + title: Ethernet MAC Address addressNote: - anyOf: - - type: string + description: The address note of the sensor + type: string nullable: true - title: Addressnote + title: Address Note longitude: - anyOf: - - type: number + description: The longitude of the sensor + type: number nullable: true title: Longitude latitude: - anyOf: - - type: number + description: The latitude of the sensor + type: number nullable: true title: Latitude notes: - anyOf: - - type: string + description: The notes of the sensor + type: string nullable: true title: Notes pcapMode: + description: The pcap mode of the sensor + type: string anyOf: - $ref: '#/components/schemas/SensorPcapMode' nullable: true + title: PcapMode type: + description: The type of the resource. type: string enum: - networking-uxi/sensor @@ -2023,16 +5213,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/SensorsGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -2044,8 +5236,9 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: Group ID required: - id title: ServiceTestGroupAssignmentPostGroup @@ -2053,11 +5246,13 @@ components: type: object properties: groupId: + description: The unique identifier of the group type: string - title: Groupid + title: Group ID serviceTestId: + description: The unique identifier of the service test type: string - title: Servicetestid + title: Service Test ID required: - groupId - serviceTestId @@ -2066,14 +5261,16 @@ components: type: object properties: id: + description: The unique identifier of the service test group assignment type: string format: uuid - title: Id + title: ID group: $ref: '#/components/schemas/ServiceTestGroupAssignmentPostGroup' serviceTest: $ref: '#/components/schemas/ServiceTestGroupAssignmentPostServiceTest' type: + description: The type of the resource. type: string enum: - networking-uxi/service-test-group-assignment @@ -2088,8 +5285,9 @@ components: type: object properties: id: + description: The unique identifier of the service test type: string - title: Id + title: Service Test ID required: - id title: ServiceTestGroupAssignmentPostServiceTest @@ -2097,8 +5295,9 @@ components: type: object properties: id: + description: The unique identifier of the group type: string - title: Id + title: Group ID required: - id title: ServiceTestGroupAssignmentsGetGroup @@ -2106,13 +5305,15 @@ components: type: object properties: id: + description: The unique identifier of the service test group assignment type: string - title: Id + title: ID group: $ref: '#/components/schemas/ServiceTestGroupAssignmentsGetGroup' serviceTest: $ref: '#/components/schemas/ServiceTestGroupAssignmentsGetServiceTest' type: + description: The type of the resource. type: string enum: - networking-uxi/service-test-group-assignment @@ -2127,16 +5328,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/ServiceTestGroupAssignmentsGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -2148,8 +5351,9 @@ components: type: object properties: id: + description: The unique identifier of the service test type: string - title: Id + title: Service Test ID required: - id title: ServiceTestGroupAssignmentsGetServiceTest @@ -2157,26 +5361,32 @@ components: type: object properties: id: + description: The unique identifier of the service test type: string - title: Id + title: ID category: + description: The category of the service test type: string title: Category name: + description: The name of the service test type: string title: Name target: - anyOf: - - type: string + description: The target of the service test + type: string nullable: true title: Target template: + description: The template of the service test type: string title: Template isEnabled: + description: Indicates if the service test is enabled type: boolean - title: Isenabled + title: Is Enabled type: + description: The type of the resource. type: string enum: - networking-uxi/service-test @@ -2194,16 +5404,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/ServiceTestsGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -2215,46 +5427,54 @@ components: type: object properties: id: + description: The unique identifier of the wired network type: string - title: Id + title: ID name: + description: The name of the wired network type: string title: Name ipVersion: $ref: '#/components/schemas/IpVersion' createdAt: + description: The creation timestamp of the wired network type: string format: date-time - title: Createdat + title: Created At updatedAt: + description: The last update timestamp of the wired network type: string format: date-time - title: Updatedat + title: Updated At security: - anyOf: - - type: string + description: The security settings of the wired network + type: string nullable: true title: Security dnsLookupDomain: - anyOf: - - type: string + description: The DNS lookup domain of the wired network + type: string nullable: true - title: Dnslookupdomain + title: DNS Lookup Domain disableEdns: + description: Whether EDNS is disabled for the wired network type: boolean - title: Disableedns + title: Disable EDNS useDns64: + description: Whether DNS64 is used for the wired network type: boolean - title: Usedns64 + title: Use DNS64 externalConnectivity: + description: Whether the wired network has external connectivity type: boolean - title: Externalconnectivity + title: External Connectivity vLanId: - anyOf: - - type: integer + description: The VLAN ID of the wired network + type: integer nullable: true - title: Vlanid + title: VLAN ID type: + description: The type of the resource. type: string enum: - networking-uxi/wired-network @@ -2277,16 +5497,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/WiredNetworksGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -2298,50 +5520,61 @@ components: type: object properties: id: + description: The unique identifier of the wireless network type: string - title: Id + title: ID name: + description: The name of the wireless network type: string title: Name ssid: + description: The SSID of the wireless network type: string - title: Ssid + title: SSID security: - anyOf: - - type: string + description: The security type of the wireless network + type: string nullable: true title: Security ipVersion: $ref: '#/components/schemas/IpVersion' createdAt: + description: The creation timestamp of the wireless network type: string format: date-time - title: Createdat + title: Created At updatedAt: + description: The last update timestamp of the wireless network type: string format: date-time - title: Updatedat + title: Updated At hidden: + description: Whether the wireless network is hidden type: boolean title: Hidden bandLocking: + description: The band locking setting of the wireless network type: string - title: Bandlocking + title: Band Locking dnsLookupDomain: - anyOf: - - type: string + description: The DNS lookup domain of the wireless network + type: string nullable: true - title: Dnslookupdomain + title: DNS Lookup Domain disableEdns: + description: Whether EDNS is disabled for the wireless network type: boolean - title: Disableedns + title: Disable EDNS useDns64: + description: Whether DNS64 is used for the wireless network type: boolean - title: Usedns64 + title: Use DNS64 externalConnectivity: + description: Whether the wireless network has external connectivity type: boolean - title: Externalconnectivity + title: External Connectivity type: + description: The type of the resource. type: string enum: - networking-uxi/wireless-network @@ -2366,16 +5599,18 @@ components: type: object properties: items: + description: The list of resources. type: array items: $ref: '#/components/schemas/WirelessNetworksGetItem' title: Items count: + description: The number of resources returned in the response. type: integer title: Count next: - anyOf: - - type: string + description: The next cursor for pagination. + type: string nullable: true title: Next required: @@ -2395,7 +5630,6 @@ tags: - name: agents - name: agent-group-assignments - name: groups - - name: health - name: network-group-assignments - name: sensors - name: sensor-group-assignments diff --git a/pkg/config-api-client/api/openapi.yaml b/pkg/config-api-client/api/openapi.yaml index b18aef0..8271e0d 100644 --- a/pkg/config-api-client/api/openapi.yaml +++ b/pkg/config-api-client/api/openapi.yaml @@ -6,7 +6,7 @@ info: url: https://help.capenetworks.com/en/ description: This document outlines the API contracts for HPE Aruba Networking UXI. title: HPE Aruba Networking UXI Configuration - version: 5.21.0 + version: 5.22.0 servers: - url: https://api.capenetworks.com tags: @@ -17,7 +17,6 @@ tags: - name: agents - name: agent-group-assignments - name: groups -- name: health - name: network-group-assignments - name: sensors - name: sensor-group-assignments @@ -26,59 +25,190 @@ tags: - name: wired-networks - name: wireless-networks paths: - /networking-uxi/v1alpha1/agents/{agent_uid}: + /networking-uxi/v1alpha1/agents/{id}: delete: - description: Delete an existing agent. + description: Delete the specified agent operationId: agent_delete parameters: - - explode: false + - description: The unique identifier of the agent + explode: false in: path - name: agent_uid + name: id required: true schema: - title: Agent Uid + description: The unique identifier of the agent + title: Agent ID type: string style: simple responses: - "200": + "204": + description: Successful Response + "400": content: application/json: - schema: {} - description: Successful Response - "204": - description: No Content - "4XX": + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "404": content: application/json: + examples: + Not Found: + description: Resource not found. + summary: Not Found + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Not Found + "405": content: application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "422": + content: + application/json: + examples: + Hardware sensor deletion forbidden: + description: Cant delete sensor - hardware sensor deletion is forbidden. + summary: Hardware sensor deletion forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_HARDWARE_SENSOR_DELETION_FORBIDDEN + httpStatusCode: 422 + message: Cant delete sensor - hardware sensor deletion is forbidden. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unprocessable Entity + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Agent Delete tags: - configuration patch: - description: Update an existing agent. + description: Patch the specified agent operationId: agent_patch parameters: - - explode: false + - description: The unique identifier of the agent + explode: false in: path - name: agent_uid + name: id required: true schema: - title: Agent Uid + description: The unique identifier of the agent + title: Agent ID type: string style: simple requestBody: content: application/merge-patch+json: + examples: + Update agent details: + description: Update the details of the specified agent + summary: Update agent details + value: + name: Updated Agent Name + notes: Updated notes + pcapMode: "off" + Update agent name: + description: Update the name of the specified agent + summary: Update agent name + value: + name: Updated Agent Name schema: $ref: '#/components/schemas/AgentPatchRequest' required: true @@ -86,60 +216,279 @@ paths: "200": content: application/json: + examples: + Updated agent: + description: Agent successfully updated. + summary: Updated agent + value: + id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + serial: "1234567890" + name: Agent Name + modelNumber: UX-F5C + wifiMacAddress: 00:11:22:33:44:55 + ethernetMacAddress: 00:11:22:33:44:56 + notes: Notes + pcapMode: "off" + type: networking-uxi/agent schema: $ref: '#/components/schemas/AgentPatchResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "404": + content: + application/json: + examples: + Not Found: + description: Resource not found. + summary: Not Found + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Not Found + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": content: application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unsupported Media Type + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Agent Patch tags: - configuration x-stability-level: alpha - /networking-uxi/v1alpha1/agent-group-assignments/{uid}: + /networking-uxi/v1alpha1/agent-group-assignments/{id}: delete: - description: Delete an agent group assignment. + description: Delete the specified agent group assignment operationId: agent_group_assignment_delete parameters: - - explode: false + - description: The unique identifier of the assignment + explode: false in: path - name: uid + name: id required: true schema: - title: Uid + description: The unique identifier of the assignment + title: Assignment ID type: string style: simple responses: - "200": + "204": + description: Successful Response + "400": content: application/json: - schema: {} - description: Successful Response - "204": - description: No Content - "4XX": + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": content: application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Forbidden + "404": content: application/json: + examples: + Not Found: + description: Resource not found. + summary: Not Found + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Not Found + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Agent Group Assignment Delete @@ -151,28 +500,36 @@ paths: description: Get a list of agent group assignments operationId: agent_group_assignments_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -182,21 +539,115 @@ paths: "200": content: application/json: + examples: + List of agent group assignments: + description: List of agent group assignment retrieval. + summary: List of agent group assignments + value: + items: + - id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + agent: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/agent-group-assignment + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/AgentGroupAssignmentsGetResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": content: application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unsupported Media Type + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Agent Group Assignments Get @@ -204,11 +655,18 @@ paths: - configuration x-stability-level: alpha post: - description: Create agent group assignment + description: Create an agent group assignment operationId: agent_group_assignment_post requestBody: content: application/json: + examples: + Create an agent group assignment: + description: Create an agent group assignment + summary: Create an agent group assignment + value: + groupId: e0f97a387c31 + agentId: 0f4c2917-9886-41bf-8ea6-faaea9fddbf0 schema: $ref: '#/components/schemas/AgentGroupAssignmentPostRequest' required: true @@ -216,21 +674,173 @@ paths: "200": content: application/json: + examples: + Agent group assignment created: + description: Agent group assignment successfully created. + summary: Agent group assignment created + value: + id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + agent: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/agent-group-assignment schema: $ref: '#/components/schemas/AgentGroupAssignmentPostResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": content: application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unauthorized + "403": content: application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Forbidden + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "409": + content: + application/json: + examples: + Assignment already exists: + description: Resource already exists. + summary: Assignment already exists + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_CONFLICT + httpStatusCode: 409 + message: Resource already exists. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Conflict + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "422": + content: + application/json: + examples: + Agent does not exist: + description: Unable to assign agent to group - the specified agent + does not exist. + summary: Agent does not exist + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_AGENT_DOES_NOT_EXIST + httpStatusCode: 422 + message: Unable to assign agent to group - the specified agent + does not exist. + Assignment to root group error: + description: Unable to assign agent to group - the specified group + is a root group. + summary: Assignment to root group error + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_ASSIGN_AGENT_TO_ROOT_GROUP + httpStatusCode: 422 + message: Unable to assign agent to group - the specified group + is a root group. + Group does not exist: + description: Unable to assign agent to group - the specified group + does not exist. + summary: Group does not exist + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: Unable to assign agent to group - the specified group + does not exist. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unprocessable Entity + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Agent Group Assignment Post @@ -242,28 +852,36 @@ paths: description: Get a list of agents operationId: agents_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -273,60 +891,274 @@ paths: "200": content: application/json: + examples: + List of agents: + description: List of agents retrieval. + summary: List of agents + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + serial: "1234567890" + name: Agent Name + modelNumber: UX-F5C + wifiMacAddress: 00:11:22:33:44:55 + ethernetMacAddress: 00:11:22:33:44:56 + notes: Notes + pcapMode: "off" + type: networking-uxi/agent + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/AgentsGetResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": content: application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unsupported Media Type + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Agents Get tags: - configuration x-stability-level: alpha - /networking-uxi/v1alpha1/groups/{group_uid}: + /networking-uxi/v1alpha1/groups/{id}: delete: - description: Delete an existing group. + description: Delete an existing group. Deleting a group will also delete all + child groups and resource assignments to any deleted group. operationId: group_delete parameters: - - explode: false + - description: The unique identifier of the group. + explode: false in: path - name: group_uid + name: id required: true schema: - title: Group Uid + description: The unique identifier of the group. + title: Group ID type: string style: simple responses: - "200": + "204": + description: Successful Response + "400": content: application/json: - schema: {} - description: Successful Response - "204": - description: No Content - "4XX": + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "404": + content: + application/json: + examples: + Not Found: + description: Resource not found. + summary: Not Found + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Not Found + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "422": content: application/json: + examples: + Cannot delete root group: + description: Cannot delete group - the root group cannot be deleted. + summary: Cannot delete root group + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_DELETE_ROOT_GROUP + httpStatusCode: 422 + message: Cannot delete group - the root group cannot be deleted. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unprocessable Entity + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Group Delete @@ -334,20 +1166,28 @@ paths: - configuration x-stability-level: alpha patch: - description: Update an existing group. + description: Update the properties of a group. operationId: group_patch parameters: - - explode: false + - description: The unique identifier of the group + explode: false in: path - name: group_uid + name: id required: true schema: - title: Group Uid + description: The unique identifier of the group + title: Group ID type: string style: simple requestBody: content: application/merge-patch+json: + examples: + Update group name: + description: Update the name of the specified group + summary: Update group name + value: + name: Updated Group Name schema: $ref: '#/components/schemas/GroupPatchRequest' required: true @@ -355,21 +1195,161 @@ paths: "200": content: application/json: + examples: + Updated group: + description: Group successfully updated. + summary: Updated group + value: + id: dsfldjsah389 + name: Group Name + path: 4gergsdgdf4tr.dsfldjsah389 + parent: + id: 4gergsdgdf4tr + type: networking-uxi/group schema: $ref: '#/components/schemas/GroupPatchResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "404": + content: + application/json: + examples: + Not Found: + description: Resource not found. + summary: Not Found + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Not Found + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "422": content: application/json: + examples: + Duplicate sibling group name: + description: Unable to update group - a sibling group already has + the specified name. + summary: Duplicate sibling group name + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_DUPLICATE_SIBLING_GROUP_NAME + httpStatusCode: 422 + message: Unable to update group - a sibling group already has + the specified name. + Cannot update the root group: + description: Unable to update group - the root group cannot be updated. + summary: Cannot update the root group + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_UPDATE_ROOT_GROUP + httpStatusCode: 422 + message: Unable to update group - the root group cannot be updated. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unprocessable Entity + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Group Patch @@ -378,31 +1358,39 @@ paths: x-stability-level: alpha /networking-uxi/v1alpha1/groups: get: - description: Lists groups matching provided criteria + description: Get a list of groups operationId: groups_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -412,21 +1400,115 @@ paths: "200": content: application/json: + examples: + List of groups: + description: List of groups successfully retrieval. + summary: List of groups + value: + items: + - id: dsfldjsah389 + name: Group Name + parent: + id: 4gergsdgdf4tr + path: 4gergsdgdf4tr.dsfldjsah389 + type: networking-uxi/group + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/GroupsGetResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": content: application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Forbidden + "405": content: application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Groups Get @@ -434,12 +1516,26 @@ paths: - configuration x-stability-level: alpha post: - description: Create a new group with the group identified in `parentId` as its - parent + description: "Create a new group with the specified name as a child group of\ + \ the specified parent group. When `parentId` is omitted, the new group is\ + \ created as a child of the root group." operationId: group_post requestBody: content: application/json: + examples: + Create a new group (specify parent ID): + description: Create a new group as a child of the specified parent + group + summary: Create a new group (specify parent ID) + value: + parentId: e0f97a387c31 + name: Example Group + Create a new group (parent ID not specified): + description: Create a new group as a top level configurable group + summary: Create a new group (parent ID not specified) + value: + name: Example Group schema: $ref: '#/components/schemas/GroupPostRequest' required: true @@ -447,21 +1543,178 @@ paths: "200": content: application/json: + examples: + Group created: + description: Group successfully created. + summary: Group created + value: + id: dsfldjsah389 + name: Group Name + path: 4gergsdgdf4tr.dsfldjsah389 + parent: + id: 4gergsdgdf4tr + type: networking-uxi/group schema: $ref: '#/components/schemas/GroupPostResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "422": content: application/json: + examples: + Parent group does not exist: + description: Unable to create group - the specified parent group + does not exist. + summary: Parent group does not exist + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_PARENT_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: Unable to create group - the specified parent group does + not exist. + Duplicate sibling group name: + description: Unable to create group - a sibling group already has + the specified name. + summary: Duplicate sibling group name + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_DUPLICATE_SIBLING_GROUP_NAME + httpStatusCode: 422 + message: Unable to create group - a sibling group already has + the specified name. + Maximum group depth exceeded: + description: Unable to create group - the maximum group depth has + been exceeded. + summary: Maximum group depth exceeded + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MAXIMUM_GROUP_DEPTH_EXCEEDED + httpStatusCode: 422 + message: Unable to create group - the maximum group depth has + been exceeded. + Parent has too many children: + description: Unable to create group - the maximum number of children + for the specified parent has been exceeded. + summary: Parent has too many children + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_PARENT_HAS_TOO_MANY_CHILDREN + httpStatusCode: 422 + message: Unable to create group - the maximum number of children + for the specified parent has been exceeded. + Maximum group count exceeded: + description: Unable to create group - the maximum group count has + been exceeded. + summary: Maximum group count exceeded + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MAXIMUM_GROUP_COUNT_EXCEEDED + httpStatusCode: 422 + message: Unable to create group - the maximum group count has + been exceeded. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unprocessable Entity + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Group Post @@ -470,37 +1723,165 @@ paths: x-stability-level: alpha /networking-uxi/v1alpha1/network-group-assignments/{id}: delete: - description: Delete a network group assignment + description: Delete the specified network group assignment operationId: network_group_assignment_delete parameters: - - explode: false + - description: The unique identifier of the network group assignment + explode: false in: path name: id required: true schema: - title: Id + description: The unique identifier of the network group assignment + title: Assignment ID type: string style: simple responses: - "200": + "204": + description: Successful Response + "400": content: application/json: - schema: {} - description: Successful Response - "204": - description: No Content - "4XX": + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "404": + content: + application/json: + examples: + Not Found: + description: Resource not found. + summary: Not Found + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Not Found + "405": content: application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Method Not Allowed + "415": content: application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Unsupported Media Type + "422": + content: + application/json: + examples: + Unassign orphans sensor error: + description: Unable to delete assignment - the assignment will leave + a sensor unconfigured. + summary: Unassign orphans sensor error + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_DELETE_ORPHANS_SENSOR + httpStatusCode: 422 + message: Unable to delete assignment - the assignment will leave + a sensor unconfigured. + Inherited assignment deletion error: + description: Unable to delete assignment - an inherited assignment + cannot be deleted. + summary: Inherited assignment deletion error + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_DELETE_INHERITED_ASSIGNMENT + httpStatusCode: 422 + message: Unable to delete assignment - an inherited assignment + cannot be deleted. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unprocessable Entity + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Network Group Assignment Delete @@ -509,31 +1890,39 @@ paths: x-stability-level: alpha /networking-uxi/v1alpha1/network-group-assignments: get: - description: Get a list of network group assignments + description: Get a list of network group assignments. operationId: network_group_assignments_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -543,21 +1932,115 @@ paths: "200": content: application/json: + examples: + List of network group assignments: + description: Network group assignment list retrieval. + summary: List of network group assignments + value: + items: + - id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + network: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/network-group-assignment + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/NetworkGroupAssignmentsGetResponse' description: Successful Response - "4XX": + "400": content: application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Bad Request + "401": content: application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Network Group Assignments Get @@ -565,11 +2048,18 @@ paths: - configuration x-stability-level: alpha post: - description: Create a network group assignment + description: Create a network group assignment. operationId: network_group_assignment_post requestBody: content: application/json: + examples: + Create a network group assignment: + description: Create a network group assignment. + summary: Create a network group assignment + value: + groupId: dsfldjsah389 + networkId: ssid-4gergsdgdf4tr schema: $ref: '#/components/schemas/NetworkGroupAssignmentPostRequest' required: true @@ -577,21 +2067,173 @@ paths: "200": content: application/json: + examples: + Create a network group assignment: + description: Network group assignment successfully created. + summary: Create a network group assignment + value: + id: 90e79136-8c10-4732-9e2a-c928f39c03b8 + group: + id: dsfldjsah389 + network: + id: ssid-4gergsdgdf4tr + type: networking-uxi/network-group-assignment schema: $ref: '#/components/schemas/NetworkGroupAssignmentPostResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "409": + content: + application/json: + examples: + Assignment already exists: + description: Resource already exists. + summary: Assignment already exists + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_CONFLICT + httpStatusCode: 409 + message: Resource already exists. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Conflict + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "422": content: application/json: + examples: + Network does not exist: + description: Unable to assign network to group - the specified network + does not exist. + summary: Network does not exist + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_NETWORK_DOES_NOT_EXIST + httpStatusCode: 422 + message: Unable to assign network to group - the specified network + does not exist. + Group does not exist: + description: Unable to assign network to group - the specified group + does not exist. + summary: Group does not exist + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: Unable to assign network to group - the specified group + does not exist. + Assignment to root group error: + description: Unable to assign network to group - the specified group + is a root group. + summary: Assignment to root group error + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_ASSIGN_NETWORK_TO_ROOT_GROUP + httpStatusCode: 422 + message: Unable to assign network to group - the specified group + is a root group. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unprocessable Entity + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Network Group Assignment Post @@ -600,37 +2242,138 @@ paths: x-stability-level: alpha /networking-uxi/v1alpha1/sensor-group-assignments/{id}: delete: - description: Delete a sensor group assignment + description: Delete the specified sensor group assignment operationId: sensor_group_assignment_delete parameters: - - explode: false + - description: The unique identifier of the sensor group assignment + explode: false in: path name: id required: true schema: - title: Id + description: The unique identifier of the sensor group assignment + title: Assignment ID type: string style: simple responses: - "200": + "204": + description: Successful Response + "400": content: application/json: - schema: {} - description: Successful Response - "204": - description: No Content - "4XX": + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "404": + content: + application/json: + examples: + Not Found: + description: Resource not found. + summary: Not Found + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Not Found + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": content: application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unsupported Media Type + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Sensor Group Assignment Delete @@ -639,31 +2382,39 @@ paths: x-stability-level: alpha /networking-uxi/v1alpha1/sensor-group-assignments: get: - description: Get a list of sensor group assignments + description: Get a list of sensor group assignments. operationId: sensor_group_assignments_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -673,21 +2424,115 @@ paths: "200": content: application/json: + examples: + List of sensor group assignments: + description: Sensor group assignment list retrieval. + summary: List of sensor group assignments + value: + items: + - id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + sensor: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/sensor-group-assignment + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/SensorGroupAssignmentsGetResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": content: application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Forbidden + "405": content: application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Sensor Group Assignments Get @@ -695,11 +2540,18 @@ paths: - configuration x-stability-level: alpha post: - description: Create sensor group assignment + description: Create a sensor group assignment. operationId: sensor_group_assignment_post requestBody: content: application/json: + examples: + Create a sensor group assignment: + description: Create a sensor group assignment. + summary: Create a sensor group assignment + value: + groupId: dsfldjsah389 + sensorId: sensor-4gergsdgdf4tr schema: $ref: '#/components/schemas/SensorGroupAssignmentPostRequest' required: true @@ -707,43 +2559,211 @@ paths: "200": content: application/json: + examples: + Sensor group assignment created: + description: Sensor group assignment successfully created. + summary: Sensor group assignment created + value: + id: 90e79136-8c10-4732-9e2a-c928f39c03b8 + group: + id: dsfldjsah389 + sensor: + id: sensor-4gergsdgdf4tr + type: networking-uxi/sensor-group-assignment schema: $ref: '#/components/schemas/SensorGroupAssignmentPostResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "409": + content: + application/json: + examples: + Assignment already exists: + description: Resource already exists. + summary: Assignment already exists + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_CONFLICT + httpStatusCode: 409 + message: Resource already exists. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Conflict + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "422": content: application/json: + examples: + Sensor does not exist: + description: Unable to assign sensor to group - the specified sensor + does not exist. + summary: Sensor does not exist + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_SENSOR_DOES_NOT_EXIST + httpStatusCode: 422 + message: Unable to assign sensor to group - the specified sensor + does not exist. + Group does not exist: + description: Unable to assign sensor to group - the specified group + does not exist. + summary: Group does not exist + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: Unable to assign sensor to group - the specified group + does not exist. + Assignment to root group error: + description: Unable to assign sensor to group - the specified group + is a root group. + summary: Assignment to root group error + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_ASSIGN_SENSOR_TO_ROOT_GROUP + httpStatusCode: 422 + message: Unable to assign sensor to group - the specified group + is a root group. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unprocessable Entity + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Sensor Group Assignment Post tags: - configuration x-stability-level: alpha - /networking-uxi/v1alpha1/sensors/{sensor_uid}: + /networking-uxi/v1alpha1/sensors/{id}: patch: - description: Update an existing sensor. + description: Update the properties of a sensor. operationId: sensor_patch parameters: - - explode: false + - description: The unique identifier of the sensor + explode: false in: path - name: sensor_uid + name: id required: true schema: - title: Sensor Uid + description: The unique identifier of the sensor + title: Sensor ID type: string style: simple requestBody: content: application/merge-patch+json: + examples: + Update sensor details: + description: Update the details of the specified sensor + summary: Update sensor details + value: + name: Updated Agent Name + pcapMode: "off" + notes: Updated notes + addressNote: Updated address note + Update sensor name: + description: Update the name of the specified sensor + summary: Update sensor name + value: + name: Updated Sensor Name schema: $ref: '#/components/schemas/SensorPatchRequest' required: true @@ -751,21 +2771,142 @@ paths: "200": content: application/json: + examples: + Updated sensor: + description: Sensor successfully updated. + summary: Updated sensor + value: + id: dsfldjsah389 + serial: "123456789" + name: Sensor Name + modelNumber: UX-F5C + wifiMacAddress: 00:11:22:33:44:55 + ethernetMacAddress: 66:77:88:99:AA:BB + addressNote: Office + longitude: 12.345678 + latitude: 98.765432 + notes: Some notes + pcapMode: "off" + type: networking-uxi/sensor schema: $ref: '#/components/schemas/SensorPatchResponse' description: Successful Response - "4XX": + "400": content: application/json: + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Bad Request + "401": content: application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "404": + content: + application/json: + examples: + Not Found: + description: Resource not found. + summary: Not Found + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Not Found + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Sensor Patch @@ -774,31 +2915,39 @@ paths: x-stability-level: alpha /networking-uxi/v1alpha1/sensors: get: - description: Get a list of sensors + description: List of sensors operationId: sensors_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -808,21 +2957,121 @@ paths: "200": content: application/json: + examples: + List of sensors: + description: List of sensors retrieval. + summary: List of sensors + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + serial: "1234567890" + name: Sensor Name + modelNumber: UX-F5C + wifiMacAddress: 00:11:22:33:44:55 + ethernetMacAddress: 00:11:22:33:44:56 + addressNote: Address Note + longitude: 12.345678 + latitude: 98.765432 + notes: Notes + pcapMode: "off" + type: networking-uxi/sensor + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/SensorsGetResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "405": content: application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Method Not Allowed + "415": content: application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Sensors Get @@ -831,37 +3080,155 @@ paths: x-stability-level: alpha /networking-uxi/v1alpha1/service-test-group-assignments/{id}: delete: - description: Delete a service test group assignment + description: Delete the specified service test group assignment operationId: service_test_group_assignment_delete parameters: - - explode: false + - description: The unique identifier of the service test group assignment + explode: false in: path name: id required: true schema: - title: Id + description: The unique identifier of the service test group assignment + title: Assignment ID type: string style: simple responses: - "200": + "204": + description: Successful Response + "400": content: application/json: - schema: {} - description: Successful Response - "204": - description: No Content - "4XX": + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "404": + content: + application/json: + examples: + Not Found: + description: Resource not found. + summary: Not Found + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_NOT_FOUND + httpStatusCode: 404 + message: Resource not found. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Not Found + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "422": content: application/json: + examples: + Inherited assignment deletion error: + description: Unable to delete assignment - an inherited assignment + cannot be deleted. + summary: Inherited assignment deletion error + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_DELETE_INHERITED_ASSIGNMENT + httpStatusCode: 422 + message: Unable to delete assignment - an inherited assignment + cannot be deleted. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Unprocessable Entity + "500": content: application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Internal Server Error security: - HTTPBearer: [] summary: Service Test Group Assignment Delete @@ -870,31 +3237,39 @@ paths: x-stability-level: alpha /networking-uxi/v1alpha1/service-test-group-assignments: get: - description: Get a list of service test group assignments + description: Get a list of service test group assignments. operationId: service_test_group_assignments_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -904,21 +3279,115 @@ paths: "200": content: application/json: + examples: + List of service test group assignments: + description: Service test group assignment list retrieval. + summary: List of service test group assignments + value: + items: + - id: 8419059c-1f4d-4cea-adf1-bd09654edba1 + group: + id: 4gergsdgdf4tr + serviceTest: + id: bff985d7-ef1d-4d49-84d6-5e3ed345dda1 + type: networking-uxi/service-test-group-assignment + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/ServiceTestGroupAssignmentsGetResponse' description: Successful Response - "4XX": + "400": content: application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Bad Request + "401": content: application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Service Test Group Assignments Get @@ -926,11 +3395,18 @@ paths: - configuration x-stability-level: alpha post: - description: Create a service-test group assignment + description: Create a service-test group assignment. operationId: service_test_group_assignment_post requestBody: content: application/json: + examples: + Create a service test group assignment: + description: Create a service test group assignment. + summary: Create a service test group assignment + value: + groupId: dsfldjsah389 + serviceTestId: dcccdabe-434b-40af-aac1-cf4c205dd5cc schema: $ref: '#/components/schemas/ServiceTestGroupAssignmentPostRequest' required: true @@ -938,21 +3414,193 @@ paths: "200": content: application/json: + examples: + Service test group assignment created: + description: Service test group assignment successfully created. + summary: Service test group assignment created + value: + id: 90e79136-8c10-4732-9e2a-c928f39c03b8 + group: + id: dsfldjsah389 + serviceTest: + id: dcccdabe-434b-40af-aac1-cf4c205dd5cc + type: networking-uxi/service-test-group-assignment schema: $ref: '#/components/schemas/ServiceTestGroupAssignmentPostResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Bad Request: + description: The request could not be processed due to a validation + error. + summary: Bad Request + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_BAD_REQUEST + httpStatusCode: 400 + message: The request could not be processed due to a validation + error. + errorDetails: + - issues: + - description: The request could not be processed due to a validation + error. + subject: header + source: x-generic-header + type: hpe.greenlake.bad_request + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": + content: + application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Forbidden + "405": + content: + application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Method Not Allowed + "409": content: application/json: + examples: + Assignment already exists: + description: Resource already exists. + summary: Assignment already exists + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_CONFLICT + httpStatusCode: 409 + message: Resource already exists. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Conflict + "415": content: application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Unsupported Media Type + "422": + content: + application/json: + examples: + Assignment to root group error: + description: Unable to assign service test to group - the specified + group is a root group. + summary: Assignment to root group error + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_CANNOT_ASSIGN_SERVICE_TEST_TO_ROOT_GROUP + httpStatusCode: 422 + message: Unable to assign service test to group - the specified + group is a root group. + Group does not exist: + description: Unable to assign service test to group - the specified + group does not exist. + summary: Group does not exist + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_GROUP_DOES_NOT_EXIST + httpStatusCode: 422 + message: Unable to assign service test to group - the specified + group does not exist. + Service test does not exist: + description: Unable to assign service test to group - the specified + service test does not exist. + summary: Service test does not exist + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_SERVICE_TEST_DOES_NOT_EXIST + httpStatusCode: 422 + message: Unable to assign service test to group - the specified + service test does not exist. + Service test group assignment already exists: + description: Unable to assign service test to group - the service + test group assignment already exists. + summary: Service test group assignment already exists + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_SERVICE_TEST_GROUP_ASSIGNMENT_ALREADY_EXISTS + httpStatusCode: 422 + message: Unable to assign service test to group - the service + test group assignment already exists. + Service test has network exclusions: + description: Unable to assign service test to group - the specified + service test has network exclusions. + summary: Service test has network exclusions + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_SERVICE_TEST_HAS_NETWORK_EXCLUSIONS + httpStatusCode: 422 + message: Unable to assign service test to group - the specified + service test has network exclusions. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unprocessable Entity + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Service Test Group Assignment Post @@ -964,28 +3612,36 @@ paths: description: Lists service-tests matching provided criteria operationId: service_tests_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -995,21 +3651,116 @@ paths: "200": content: application/json: + examples: + List of service tests: + description: List of service tests retrieval. + summary: List of service tests + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + category: Category + name: Service Test Name + target: Target + template: Template + isEnabled: true + type: networking-uxi/service-test + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/ServiceTestsGetResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": content: application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Forbidden + "405": content: application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Service Tests Get @@ -1021,28 +3772,36 @@ paths: description: Get a list of wired networks operationId: wired_networks_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -1052,21 +3811,121 @@ paths: "200": content: application/json: + examples: + List of wired networks: + description: List of wired networks retrieval. + summary: List of wired networks + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + name: Wired Network Name + ipVersion: ipv4 + createdAt: 2023-10-01T12:34:56Z + updatedAt: 2023-10-01T12:34:56Z + security: WPA2 + dnsLookupDomain: example.com + disableEdns: false + useDns64: true + externalConnectivity: true + vLanId: 100 + type: networking-uxi/wired-network + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/WiredNetworksGetResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": content: application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Forbidden + "405": content: application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Wired Networks Get @@ -1078,28 +3937,36 @@ paths: description: Get a list of wireless networks operationId: wireless_networks_get parameters: - - explode: true + - description: The ID of the resource. + explode: true in: query name: id required: false schema: + description: The ID of the resource. nullable: true + title: ID type: string style: form - - explode: true + - description: The next cursor for pagination. + explode: true in: query name: next required: false schema: + description: The next cursor for pagination. nullable: true + title: Next type: string style: form - - explode: true + - description: The maximum number of items returned in the response. + explode: true in: query name: limit required: false schema: default: 50 + description: The maximum number of items returned in the response. maximum: 100 minimum: 0 title: Limit @@ -1109,21 +3976,123 @@ paths: "200": content: application/json: + examples: + List of wireless networks: + description: List of wireless networks retrieval. + summary: List of wireless networks + value: + items: + - id: b1b8bd47-951a-42e3-bbec-f68ee5cc94be + name: Wireless Network Name + ssid: SSID + security: WPA2 + ipVersion: ipv4 + createdAt: 2023-01-01T00:00:00Z + updatedAt: 2023-01-02T00:00:00Z + hidden: false + bandLocking: 2.4GHz + dnsLookupDomain: example.com + disableEdns: false + useDns64: false + externalConnectivity: true + type: networking-uxi/wireless-network + count: 1 + next: aGVsbG8gZnJvbSBhbGlzdGFpcg== schema: $ref: '#/components/schemas/WirelessNetworksGetResponse' description: Successful Response - "4XX": + "400": + content: + application/json: + examples: + Malformed cursor: + description: The provided cursor could not be decoded. + summary: Malformed cursor + value: + debugId: "1234567890" + errorCode: HPE_GL_NETWORKING_UXI_MALFORMED_CURSOR + httpStatusCode: 400 + message: The provided cursor could not be decoded. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad Request + "401": + content: + application/json: + examples: + Unauthorized: + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNAUTHORIZED + message: "You are not authorized to perform this action - the\ + \ token is missing, expired, revoked, malformed, or invalid\ + \ for other reasons" + httpStatusCode: 401 + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unauthorized + "403": content: application/json: + examples: + Forbidden: + description: The user has insufficient permissions to complete the + request. + summary: Forbidden + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_FORBIDDEN + httpStatusCode: 403 + message: The user has insufficient permissions to complete the + request. schema: $ref: '#/components/schemas/ErrorResponse' - description: Client Error - "5XX": + description: Forbidden + "405": content: application/json: + examples: + Method Not Allowed: + description: Method is not allowed. + summary: Method Not Allowed + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_METHOD_NOT_ALLOWED + httpStatusCode: 405 + message: Method is not allowed. schema: $ref: '#/components/schemas/ErrorResponse' - description: Server Error + description: Method Not Allowed + "415": + content: + application/json: + examples: + Unsupported Media Type: + description: Media type is unsupported. + summary: Unsupported Media Type + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_UNSUPPORTED_MEDIA_TYPE + httpStatusCode: 415 + message: Media type is unsupported. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Unsupported Media Type + "500": + content: + application/json: + examples: + Internal Server Error: + description: The request cannot be processed due to an unknown issue. + summary: Internal Server Error + value: + debugId: "1234567890" + errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR + httpStatusCode: 500 + message: The request cannot be processed due to an unknown issue. + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Internal Server Error security: - HTTPBearer: [] summary: Wireless Networks Get @@ -1137,7 +4106,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the agent + title: Agent ID type: string required: - id @@ -1148,7 +4118,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the group + title: Group ID type: string required: - id @@ -1160,10 +4131,12 @@ components: groupId: groupId properties: groupId: - title: Groupid + description: The unique identifier of the group + title: Group ID type: string agentId: - title: Agentid + description: The unique identifier of the agent + title: Agent ID type: string required: - agentId @@ -1180,13 +4153,15 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the agent group assignment + title: ID type: string group: $ref: '#/components/schemas/AgentGroupAssignmentPostGroup' agent: $ref: '#/components/schemas/AgentGroupAssignmentPostAgent' type: + description: The type of the resource. enum: - networking-uxi/agent-group-assignment title: Type @@ -1203,7 +4178,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the agent + title: Agent ID type: string required: - id @@ -1214,7 +4190,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the group + title: Group ID type: string required: - id @@ -1230,13 +4207,15 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the agent group assignment + title: ID type: string group: $ref: '#/components/schemas/AgentGroupAssignmentsGetGroup' agent: $ref: '#/components/schemas/AgentGroupAssignmentsGetAgent' type: + description: The type of the resource. enum: - networking-uxi/agent-group-assignment title: Type @@ -1267,15 +4246,19 @@ components: id: id properties: items: + description: The list of resources. items: $ref: '#/components/schemas/AgentGroupAssignmentsGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count @@ -1287,11 +4270,13 @@ components: description: Request body for patching an agent. properties: name: + description: The name of the agent maxLength: 100 minLength: 1 title: Name type: string notes: + description: The notes of the agent title: Notes type: string pcapMode: @@ -1311,29 +4296,41 @@ components: wifiMacAddress: wifiMacAddress properties: id: - title: Id + description: The unique identifier of the agent + title: ID type: string serial: + description: The serial number of the agent title: Serial type: string name: + description: The name of the agent title: Name type: string modelNumber: + description: The model number of the agent nullable: true + title: Model Number type: string wifiMacAddress: + description: The WiFi MAC address of the agent nullable: true + title: WiFi MAC Address type: string ethernetMacAddress: + description: The Ethernet MAC address of the agent nullable: true + title: Ethernet MAC Address type: string notes: + description: The notes of the agent nullable: true + title: Notes type: string pcapMode: $ref: '#/components/schemas/AgentPcapMode' type: + description: The type of the resource. enum: - networking-uxi/agent title: Type @@ -1370,29 +4367,41 @@ components: wifiMacAddress: wifiMacAddress properties: id: - title: Id + description: The unique identifier of the agent + title: ID type: string serial: + description: The serial number of the agent title: Serial type: string name: + description: The name of the agent title: Name type: string modelNumber: + description: The model number of the agent nullable: true + title: Model Number type: string wifiMacAddress: + description: The WiFi MAC address of the agent nullable: true + title: WiFi MAC Address type: string ethernetMacAddress: + description: The Ethernet MAC address of the agent nullable: true + title: Ethernet MAC Address type: string notes: + description: The notes of the agent nullable: true + title: Notes type: string pcapMode: $ref: '#/components/schemas/AgentPcapMode' type: + description: The type of the resource. enum: - networking-uxi/agent title: Type @@ -1434,15 +4443,19 @@ components: wifiMacAddress: wifiMacAddress properties: items: + description: The list of resources. items: $ref: '#/components/schemas/AgentsGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count @@ -1514,6 +4527,7 @@ components: items: $ref: '#/components/schemas/ErrorDetail' nullable: true + title: Errordetails type: array required: - debugId @@ -1527,7 +4541,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the parent group + title: ID type: string required: - id @@ -1536,6 +4551,7 @@ components: GroupPatchRequest: properties: name: + description: The updated group name maxLength: 250 minLength: 1 title: Name @@ -1552,17 +4568,21 @@ components: type: networking-uxi/group properties: id: - title: Id + description: The unique identifier of the group + title: ID type: string name: + description: The name of the group title: Name type: string path: + description: The path of the group title: Path type: string parent: $ref: '#/components/schemas/GroupPatchParent' type: + description: The type of the resource. enum: - networking-uxi/group title: Type @@ -1580,7 +4600,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the parent group + title: ID type: string required: - id @@ -1592,9 +4613,12 @@ components: parentId: parentId properties: parentId: + description: The unique identifier of the parent group nullable: true + title: Parent Group ID type: string name: + description: The name of the group maxLength: 250 minLength: 1 title: Name @@ -1613,17 +4637,21 @@ components: type: networking-uxi/group properties: id: - title: Id + description: The unique identifier of the group + title: ID type: string name: + description: The name of the group title: Name type: string path: + description: The path of the group title: Path type: string parent: $ref: '#/components/schemas/GroupPostParent' type: + description: The type of the resource. enum: - networking-uxi/group title: Type @@ -1646,17 +4674,21 @@ components: type: networking-uxi/group properties: id: - title: Id + description: The unique identifier of the group + title: ID type: string name: + description: The name of the group title: Name type: string parent: $ref: '#/components/schemas/GroupsGetParent' path: + description: The path of the group title: Path type: string type: + description: The type of the resource. enum: - networking-uxi/group title: Type @@ -1674,7 +4706,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the parent group + title: Parent ID type: string required: - id @@ -1699,15 +4732,19 @@ components: type: networking-uxi/group properties: items: + description: The list of resources. items: $ref: '#/components/schemas/GroupsGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count @@ -1753,7 +4790,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the group + title: Group ID type: string required: - id @@ -1764,7 +4802,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the network + title: Network ID type: string required: - id @@ -1776,10 +4815,12 @@ components: networkId: networkId properties: groupId: - title: Groupid + description: The unique identifier of the group + title: Group ID type: string networkId: - title: Networkid + description: The unique identifier of the network + title: Network ID type: string required: - groupId @@ -1788,7 +4829,7 @@ components: type: object NetworkGroupAssignmentPostResponse: example: - id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + id: id type: networking-uxi/network-group-assignment group: id: id @@ -1796,14 +4837,15 @@ components: id: id properties: id: - format: uuid - title: Id + description: The unique identifier of the network group assignment + title: ID type: string group: $ref: '#/components/schemas/NetworkGroupAssignmentPostGroup' network: $ref: '#/components/schemas/NetworkGroupAssignmentPostNetwork' type: + description: The type of the resource. enum: - networking-uxi/network-group-assignment title: Type @@ -1820,7 +4862,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the group + title: Group ID type: string required: - id @@ -1836,13 +4879,15 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the network group assignment + title: ID type: string group: $ref: '#/components/schemas/NetworkGroupAssignmentsGetGroup' network: $ref: '#/components/schemas/NetworkGroupAssignmentsGetNetwork' type: + description: The type of the resource. enum: - networking-uxi/network-group-assignment title: Type @@ -1859,7 +4904,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the network + title: Network ID type: string required: - id @@ -1884,15 +4930,19 @@ components: id: id properties: items: + description: The list of resources. items: $ref: '#/components/schemas/NetworkGroupAssignmentsGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count @@ -1905,7 +4955,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the group + title: Group ID type: string required: - id @@ -1917,10 +4968,12 @@ components: sensorId: sensorId properties: groupId: - title: Groupid + description: The unique identifier of the group + title: Group ID type: string sensorId: - title: Sensorid + description: The unique identifier of the sensor + title: Sensor ID type: string required: - groupId @@ -1937,13 +4990,15 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the sensor group assignment + title: ID type: string group: $ref: '#/components/schemas/SensorGroupAssignmentPostGroup' sensor: $ref: '#/components/schemas/SensorGroupAssignmentPostSensor' type: + description: The type of the resource. enum: - networking-uxi/sensor-group-assignment title: Type @@ -1960,7 +5015,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the sensor + title: Sensor ID type: string required: - id @@ -1971,7 +5027,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the group + title: Group ID type: string required: - id @@ -1987,13 +5044,15 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the sensor group assignment + title: ID type: string group: $ref: '#/components/schemas/SensorGroupAssignmentsGetGroup' sensor: $ref: '#/components/schemas/SensorGroupAssignmentsGetSensor' type: + description: The type of the resource. enum: - networking-uxi/sensor-group-assignment title: Type @@ -2024,15 +5083,19 @@ components: id: id properties: items: + description: The list of resources. items: $ref: '#/components/schemas/SensorGroupAssignmentsGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count @@ -2045,7 +5108,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the sensor + title: Sensor ID type: string required: - id @@ -2055,14 +5119,17 @@ components: description: Request body for patching a sensor. properties: name: + description: The updated sensor name maxLength: 100 minLength: 1 title: Name type: string addressNote: - title: Addressnote + description: The updated address note for the sensor + title: Address Note type: string notes: + description: Additional notes for the sensor title: Notes type: string pcapMode: @@ -2085,38 +5152,55 @@ components: longitude: 0.8008281904610115 properties: id: - title: Id + description: The unique identifier of the sensor + title: ID type: string serial: + description: The serial number of the sensor title: Serial type: string name: + description: The name of the sensor title: Name type: string modelNumber: - title: Modelnumber + description: The model number of the sensor + title: Model Number type: string wifiMacAddress: + description: The WiFi MAC address of the sensor nullable: true + title: WiFi MAC Address type: string ethernetMacAddress: + description: The Ethernet MAC address of the sensor nullable: true + title: Ethernet MAC Address type: string addressNote: + description: The address note of the sensor nullable: true + title: Address Note type: string longitude: + description: The longitude of the sensor nullable: true + title: Longitude type: number latitude: + description: The latitude of the sensor nullable: true + title: Latitude type: number notes: + description: Additional notes for the sensor nullable: true + title: Notes type: string pcapMode: $ref: '#/components/schemas/SensorPcapMode' type: + description: The type of the resource. enum: - networking-uxi/sensor title: Type @@ -2159,38 +5243,55 @@ components: longitude: 0.8008281904610115 properties: id: - title: Id + description: The unique identifier of the sensor + title: ID type: string serial: + description: The serial number of the sensor title: Serial type: string name: + description: The name of the sensor title: Name type: string modelNumber: - title: Modelnumber + description: The model number of the sensor + title: Model Number type: string wifiMacAddress: + description: The WiFi MAC address of the sensor nullable: true + title: WiFi MAC Address type: string ethernetMacAddress: + description: The Ethernet MAC address of the sensor nullable: true + title: Ethernet MAC Address type: string addressNote: + description: The address note of the sensor nullable: true + title: Address Note type: string longitude: + description: The longitude of the sensor nullable: true + title: Longitude type: number latitude: + description: The latitude of the sensor nullable: true + title: Latitude type: number notes: + description: The notes of the sensor nullable: true + title: Notes type: string pcapMode: $ref: '#/components/schemas/SensorPcapMode' type: + description: The type of the resource. enum: - networking-uxi/sensor title: Type @@ -2241,15 +5342,19 @@ components: longitude: 0.8008281904610115 properties: items: + description: The list of resources. items: $ref: '#/components/schemas/SensorsGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count @@ -2262,7 +5367,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the group + title: Group ID type: string required: - id @@ -2274,10 +5380,12 @@ components: serviceTestId: serviceTestId properties: groupId: - title: Groupid + description: The unique identifier of the group + title: Group ID type: string serviceTestId: - title: Servicetestid + description: The unique identifier of the service test + title: Service Test ID type: string required: - groupId @@ -2294,14 +5402,16 @@ components: id: id properties: id: + description: The unique identifier of the service test group assignment format: uuid - title: Id + title: ID type: string group: $ref: '#/components/schemas/ServiceTestGroupAssignmentPostGroup' serviceTest: $ref: '#/components/schemas/ServiceTestGroupAssignmentPostServiceTest' type: + description: The type of the resource. enum: - networking-uxi/service-test-group-assignment title: Type @@ -2318,7 +5428,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the service test + title: Service Test ID type: string required: - id @@ -2329,7 +5440,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the group + title: Group ID type: string required: - id @@ -2345,13 +5457,15 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the service test group assignment + title: ID type: string group: $ref: '#/components/schemas/ServiceTestGroupAssignmentsGetGroup' serviceTest: $ref: '#/components/schemas/ServiceTestGroupAssignmentsGetServiceTest' type: + description: The type of the resource. enum: - networking-uxi/service-test-group-assignment title: Type @@ -2382,15 +5496,19 @@ components: id: id properties: items: + description: The list of resources. items: $ref: '#/components/schemas/ServiceTestGroupAssignmentsGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count @@ -2403,7 +5521,8 @@ components: id: id properties: id: - title: Id + description: The unique identifier of the service test + title: Service Test ID type: string required: - id @@ -2420,24 +5539,32 @@ components: target: target properties: id: - title: Id + description: The unique identifier of the service test + title: ID type: string category: + description: The category of the service test title: Category type: string name: + description: The name of the service test title: Name type: string target: + description: The target of the service test nullable: true + title: Target type: string template: + description: The template of the service test title: Template type: string isEnabled: - title: Isenabled + description: Indicates if the service test is enabled + title: Is Enabled type: boolean type: + description: The type of the resource. enum: - networking-uxi/service-test title: Type @@ -2473,15 +5600,19 @@ components: target: target properties: items: + description: The list of resources. items: $ref: '#/components/schemas/ServiceTestsGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count @@ -2505,40 +5636,54 @@ components: disableEdns: true properties: id: - title: Id + description: The unique identifier of the wired network + title: ID type: string name: + description: The name of the wired network title: Name type: string ipVersion: $ref: '#/components/schemas/IpVersion' createdAt: + description: The creation timestamp of the wired network format: date-time - title: Createdat + title: Created At type: string updatedAt: + description: The last update timestamp of the wired network format: date-time - title: Updatedat + title: Updated At type: string security: + description: The security settings of the wired network nullable: true + title: Security type: string dnsLookupDomain: + description: The DNS lookup domain of the wired network nullable: true + title: DNS Lookup Domain type: string disableEdns: - title: Disableedns + description: Whether EDNS is disabled for the wired network + title: Disable EDNS type: boolean useDns64: - title: Usedns64 + description: Whether DNS64 is used for the wired network + title: Use DNS64 type: boolean externalConnectivity: - title: Externalconnectivity + description: Whether the wired network has external connectivity + title: External Connectivity type: boolean vLanId: + description: The VLAN ID of the wired network nullable: true + title: VLAN ID type: integer type: + description: The type of the resource. enum: - networking-uxi/wired-network title: Type @@ -2589,15 +5734,19 @@ components: disableEdns: true properties: items: + description: The list of resources. items: $ref: '#/components/schemas/WiredNetworksGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count @@ -2623,46 +5772,61 @@ components: updatedAt: 2000-01-23T04:56:07.000+00:00 properties: id: - title: Id + description: The unique identifier of the wireless network + title: ID type: string name: + description: The name of the wireless network title: Name type: string ssid: - title: Ssid + description: The SSID of the wireless network + title: SSID type: string security: + description: The security type of the wireless network nullable: true + title: Security type: string ipVersion: $ref: '#/components/schemas/IpVersion' createdAt: + description: The creation timestamp of the wireless network format: date-time - title: Createdat + title: Created At type: string updatedAt: + description: The last update timestamp of the wireless network format: date-time - title: Updatedat + title: Updated At type: string hidden: + description: Whether the wireless network is hidden title: Hidden type: boolean bandLocking: - title: Bandlocking + description: The band locking setting of the wireless network + title: Band Locking type: string dnsLookupDomain: + description: The DNS lookup domain of the wireless network nullable: true + title: DNS Lookup Domain type: string disableEdns: - title: Disableedns + description: Whether EDNS is disabled for the wireless network + title: Disable EDNS type: boolean useDns64: - title: Usedns64 + description: Whether DNS64 is used for the wireless network + title: Use DNS64 type: boolean externalConnectivity: - title: Externalconnectivity + description: Whether the wireless network has external connectivity + title: External Connectivity type: boolean type: + description: The type of the resource. enum: - networking-uxi/wireless-network title: Type @@ -2719,15 +5883,19 @@ components: updatedAt: 2000-01-23T04:56:07.000+00:00 properties: items: + description: The list of resources. items: $ref: '#/components/schemas/WirelessNetworksGetItem' title: Items type: array count: + description: The number of resources returned in the response. title: Count type: integer next: + description: The next cursor for pagination. nullable: true + title: Next type: string required: - count diff --git a/pkg/config-api-client/api_configuration.go b/pkg/config-api-client/api_configuration.go index 533279d..75f47cf 100644 --- a/pkg/config-api-client/api_configuration.go +++ b/pkg/config-api-client/api_configuration.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -30,44 +30,41 @@ type ConfigurationAPIService service type ApiAgentDeleteRequest struct { ctx context.Context ApiService *ConfigurationAPIService - agentUid string + id string } -func (r ApiAgentDeleteRequest) Execute() (interface{}, *http.Response, error) { +func (r ApiAgentDeleteRequest) Execute() (*http.Response, error) { return r.ApiService.AgentDeleteExecute(r) } /* AgentDelete Agent Delete -Delete an existing agent. +# Delete the specified agent @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param agentUid + @param id The unique identifier of the agent @return ApiAgentDeleteRequest */ func (a *ConfigurationAPIService) AgentDelete( ctx context.Context, - agentUid string, + id string, ) ApiAgentDeleteRequest { return ApiAgentDeleteRequest{ ApiService: a, ctx: ctx, - agentUid: agentUid, + id: id, } } // Execute executes the request -// -// @return interface{} func (a *ConfigurationAPIService) AgentDeleteExecute( r ApiAgentDeleteRequest, -) (interface{}, *http.Response, error) { +) (*http.Response, error) { var ( - localVarHTTPMethod = http.MethodDelete - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue interface{} + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile ) localBasePath, err := a.client.cfg.ServerURLWithContext( @@ -75,14 +72,14 @@ func (a *ConfigurationAPIService) AgentDeleteExecute( "ConfigurationAPIService.AgentDelete", ) if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + return nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/networking-uxi/v1alpha1/agents/{agent_uid}" + localVarPath := localBasePath + "/networking-uxi/v1alpha1/agents/{id}" localVarPath = strings.Replace( localVarPath, - "{"+"agent_uid"+"}", - url.PathEscape(parameterValueToString(r.agentUid, "agentUid")), + "{"+"id"+"}", + url.PathEscape(parameterValueToString(r.id, "id")), -1, ) @@ -118,19 +115,19 @@ func (a *ConfigurationAPIService) AgentDeleteExecute( formFiles, ) if err != nil { - return localVarReturnValue, nil, err + return nil, err } localVarHTTPResponse, err := a.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) if err != nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -138,87 +135,137 @@ func (a *ConfigurationAPIService) AgentDeleteExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 401 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode( - &localVarReturnValue, - localVarBody, - localVarHTTPResponse.Header.Get("Content-Type"), - ) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 422 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, nil + return localVarHTTPResponse, nil } type ApiAgentGroupAssignmentDeleteRequest struct { ctx context.Context ApiService *ConfigurationAPIService - uid string + id string } -func (r ApiAgentGroupAssignmentDeleteRequest) Execute() (interface{}, *http.Response, error) { +func (r ApiAgentGroupAssignmentDeleteRequest) Execute() (*http.Response, error) { return r.ApiService.AgentGroupAssignmentDeleteExecute(r) } /* AgentGroupAssignmentDelete Agent Group Assignment Delete -Delete an agent group assignment. +# Delete the specified agent group assignment @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param uid + @param id The unique identifier of the assignment @return ApiAgentGroupAssignmentDeleteRequest */ func (a *ConfigurationAPIService) AgentGroupAssignmentDelete( ctx context.Context, - uid string, + id string, ) ApiAgentGroupAssignmentDeleteRequest { return ApiAgentGroupAssignmentDeleteRequest{ ApiService: a, ctx: ctx, - uid: uid, + id: id, } } // Execute executes the request -// -// @return interface{} func (a *ConfigurationAPIService) AgentGroupAssignmentDeleteExecute( r ApiAgentGroupAssignmentDeleteRequest, -) (interface{}, *http.Response, error) { +) (*http.Response, error) { var ( - localVarHTTPMethod = http.MethodDelete - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue interface{} + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile ) localBasePath, err := a.client.cfg.ServerURLWithContext( @@ -226,14 +273,14 @@ func (a *ConfigurationAPIService) AgentGroupAssignmentDeleteExecute( "ConfigurationAPIService.AgentGroupAssignmentDelete", ) if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + return nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/networking-uxi/v1alpha1/agent-group-assignments/{uid}" + localVarPath := localBasePath + "/networking-uxi/v1alpha1/agent-group-assignments/{id}" localVarPath = strings.Replace( localVarPath, - "{"+"uid"+"}", - url.PathEscape(parameterValueToString(r.uid, "uid")), + "{"+"id"+"}", + url.PathEscape(parameterValueToString(r.id, "id")), -1, ) @@ -269,19 +316,19 @@ func (a *ConfigurationAPIService) AgentGroupAssignmentDeleteExecute( formFiles, ) if err != nil { - return localVarReturnValue, nil, err + return nil, err } localVarHTTPResponse, err := a.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) if err != nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -289,44 +336,86 @@ func (a *ConfigurationAPIService) AgentGroupAssignmentDeleteExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 401 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode( - &localVarReturnValue, - localVarBody, - localVarHTTPResponse.Header.Get("Content-Type"), - ) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, nil + return localVarHTTPResponse, nil } type ApiAgentGroupAssignmentPostRequest struct { @@ -349,7 +438,7 @@ func (r ApiAgentGroupAssignmentPostRequest) Execute() (*AgentGroupAssignmentPost /* AgentGroupAssignmentPost Agent Group Assignment Post -# Create agent group assignment +# Create an agent group assignment @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiAgentGroupAssignmentPostRequest @@ -445,7 +534,73 @@ func (a *ConfigurationAPIService) AgentGroupAssignmentPostExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 422 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -456,7 +611,7 @@ func (a *ConfigurationAPIService) AgentGroupAssignmentPostExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -493,16 +648,19 @@ type ApiAgentGroupAssignmentsGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiAgentGroupAssignmentsGetRequest) Id(id string) ApiAgentGroupAssignmentsGetRequest { r.id = &id return r } +// The next cursor for pagination. func (r ApiAgentGroupAssignmentsGetRequest) Next(next string) ApiAgentGroupAssignmentsGetRequest { r.next = &next return r } +// The maximum number of items returned in the response. func (r ApiAgentGroupAssignmentsGetRequest) Limit(limit int32) ApiAgentGroupAssignmentsGetRequest { r.limit = &limit return r @@ -616,7 +774,29 @@ func (a *ConfigurationAPIService) AgentGroupAssignmentsGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -627,7 +807,29 @@ func (a *ConfigurationAPIService) AgentGroupAssignmentsGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -659,7 +861,7 @@ func (a *ConfigurationAPIService) AgentGroupAssignmentsGetExecute( type ApiAgentPatchRequest struct { ctx context.Context ApiService *ConfigurationAPIService - agentUid string + id string agentPatchRequest *AgentPatchRequest } @@ -677,20 +879,17 @@ func (r ApiAgentPatchRequest) Execute() (*AgentPatchResponse, *http.Response, er /* AgentPatch Agent Patch -Update an existing agent. +# Patch the specified agent @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param agentUid + @param id The unique identifier of the agent @return ApiAgentPatchRequest */ -func (a *ConfigurationAPIService) AgentPatch( - ctx context.Context, - agentUid string, -) ApiAgentPatchRequest { +func (a *ConfigurationAPIService) AgentPatch(ctx context.Context, id string) ApiAgentPatchRequest { return ApiAgentPatchRequest{ ApiService: a, ctx: ctx, - agentUid: agentUid, + id: id, } } @@ -715,11 +914,11 @@ func (a *ConfigurationAPIService) AgentPatchExecute( return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/networking-uxi/v1alpha1/agents/{agent_uid}" + localVarPath := localBasePath + "/networking-uxi/v1alpha1/agents/{id}" localVarPath = strings.Replace( localVarPath, - "{"+"agent_uid"+"}", - url.PathEscape(parameterValueToString(r.agentUid, "agentUid")), + "{"+"id"+"}", + url.PathEscape(parameterValueToString(r.id, "id")), -1, ) @@ -782,7 +981,7 @@ func (a *ConfigurationAPIService) AgentPatchExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -793,7 +992,7 @@ func (a *ConfigurationAPIService) AgentPatchExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 401 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -802,13 +1001,68 @@ func (a *ConfigurationAPIService) AgentPatchExecute( } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode( - &localVarReturnValue, - localVarBody, + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode( + &localVarReturnValue, + localVarBody, localVarHTTPResponse.Header.Get("Content-Type"), ) if err != nil { @@ -830,16 +1084,19 @@ type ApiAgentsGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiAgentsGetRequest) Id(id string) ApiAgentsGetRequest { r.id = &id return r } +// The next cursor for pagination. func (r ApiAgentsGetRequest) Next(next string) ApiAgentsGetRequest { r.next = &next return r } +// The maximum number of items returned in the response. func (r ApiAgentsGetRequest) Limit(limit int32) ApiAgentsGetRequest { r.limit = &limit return r @@ -951,7 +1208,7 @@ func (a *ConfigurationAPIService) AgentsGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -962,7 +1219,51 @@ func (a *ConfigurationAPIService) AgentsGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -994,44 +1295,41 @@ func (a *ConfigurationAPIService) AgentsGetExecute( type ApiGroupDeleteRequest struct { ctx context.Context ApiService *ConfigurationAPIService - groupUid string + id string } -func (r ApiGroupDeleteRequest) Execute() (interface{}, *http.Response, error) { +func (r ApiGroupDeleteRequest) Execute() (*http.Response, error) { return r.ApiService.GroupDeleteExecute(r) } /* GroupDelete Group Delete -Delete an existing group. +Delete an existing group. Deleting a group will also delete all child groups and resource assignments to any deleted group. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param groupUid + @param id The unique identifier of the group. @return ApiGroupDeleteRequest */ func (a *ConfigurationAPIService) GroupDelete( ctx context.Context, - groupUid string, + id string, ) ApiGroupDeleteRequest { return ApiGroupDeleteRequest{ ApiService: a, ctx: ctx, - groupUid: groupUid, + id: id, } } // Execute executes the request -// -// @return interface{} func (a *ConfigurationAPIService) GroupDeleteExecute( r ApiGroupDeleteRequest, -) (interface{}, *http.Response, error) { +) (*http.Response, error) { var ( - localVarHTTPMethod = http.MethodDelete - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue interface{} + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile ) localBasePath, err := a.client.cfg.ServerURLWithContext( @@ -1039,14 +1337,14 @@ func (a *ConfigurationAPIService) GroupDeleteExecute( "ConfigurationAPIService.GroupDelete", ) if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + return nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/networking-uxi/v1alpha1/groups/{group_uid}" + localVarPath := localBasePath + "/networking-uxi/v1alpha1/groups/{id}" localVarPath = strings.Replace( localVarPath, - "{"+"group_uid"+"}", - url.PathEscape(parameterValueToString(r.groupUid, "groupUid")), + "{"+"id"+"}", + url.PathEscape(parameterValueToString(r.id, "id")), -1, ) @@ -1082,19 +1380,19 @@ func (a *ConfigurationAPIService) GroupDeleteExecute( formFiles, ) if err != nil { - return localVarReturnValue, nil, err + return nil, err } localVarHTTPResponse, err := a.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) if err != nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -1102,50 +1400,103 @@ func (a *ConfigurationAPIService) GroupDeleteExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 401 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode( - &localVarReturnValue, - localVarBody, - localVarHTTPResponse.Header.Get("Content-Type"), - ) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 422 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, nil + return localVarHTTPResponse, nil } type ApiGroupPatchRequest struct { ctx context.Context ApiService *ConfigurationAPIService - groupUid string + id string groupPatchRequest *GroupPatchRequest } @@ -1163,20 +1514,17 @@ func (r ApiGroupPatchRequest) Execute() (*GroupPatchResponse, *http.Response, er /* GroupPatch Group Patch -Update an existing group. +Update the properties of a group. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param groupUid + @param id The unique identifier of the group @return ApiGroupPatchRequest */ -func (a *ConfigurationAPIService) GroupPatch( - ctx context.Context, - groupUid string, -) ApiGroupPatchRequest { +func (a *ConfigurationAPIService) GroupPatch(ctx context.Context, id string) ApiGroupPatchRequest { return ApiGroupPatchRequest{ ApiService: a, ctx: ctx, - groupUid: groupUid, + id: id, } } @@ -1201,11 +1549,11 @@ func (a *ConfigurationAPIService) GroupPatchExecute( return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/networking-uxi/v1alpha1/groups/{group_uid}" + localVarPath := localBasePath + "/networking-uxi/v1alpha1/groups/{id}" localVarPath = strings.Replace( localVarPath, - "{"+"group_uid"+"}", - url.PathEscape(parameterValueToString(r.groupUid, "groupUid")), + "{"+"id"+"}", + url.PathEscape(parameterValueToString(r.id, "id")), -1, ) @@ -1268,7 +1616,51 @@ func (a *ConfigurationAPIService) GroupPatchExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -1279,7 +1671,29 @@ func (a *ConfigurationAPIService) GroupPatchExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 422 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -1328,7 +1742,7 @@ func (r ApiGroupPostRequest) Execute() (*GroupPostResponse, *http.Response, erro /* GroupPost Group Post -# Create a new group with the group identified in `parentId` as its parent +Create a new group with the specified name as a child group of the specified parent group. When `parentId` is omitted, the new group is created as a child of the root group. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiGroupPostRequest @@ -1422,7 +1836,62 @@ func (a *ConfigurationAPIService) GroupPostExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 422 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -1433,7 +1902,7 @@ func (a *ConfigurationAPIService) GroupPostExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -1470,16 +1939,19 @@ type ApiGroupsGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiGroupsGetRequest) Id(id string) ApiGroupsGetRequest { r.id = &id return r } +// The next cursor for pagination. func (r ApiGroupsGetRequest) Next(next string) ApiGroupsGetRequest { r.next = &next return r } +// The maximum number of items returned in the response. func (r ApiGroupsGetRequest) Limit(limit int32) ApiGroupsGetRequest { r.limit = &limit return r @@ -1492,7 +1964,7 @@ func (r ApiGroupsGetRequest) Execute() (*GroupsGetResponse, *http.Response, erro /* GroupsGet Groups Get -# Lists groups matching provided criteria +# Get a list of groups @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiGroupsGetRequest @@ -1591,7 +2063,51 @@ func (a *ConfigurationAPIService) GroupsGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -1602,7 +2118,7 @@ func (a *ConfigurationAPIService) GroupsGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -1637,17 +2153,17 @@ type ApiNetworkGroupAssignmentDeleteRequest struct { id string } -func (r ApiNetworkGroupAssignmentDeleteRequest) Execute() (interface{}, *http.Response, error) { +func (r ApiNetworkGroupAssignmentDeleteRequest) Execute() (*http.Response, error) { return r.ApiService.NetworkGroupAssignmentDeleteExecute(r) } /* NetworkGroupAssignmentDelete Network Group Assignment Delete -# Delete a network group assignment +# Delete the specified network group assignment @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param id + @param id The unique identifier of the network group assignment @return ApiNetworkGroupAssignmentDeleteRequest */ func (a *ConfigurationAPIService) NetworkGroupAssignmentDelete( @@ -1662,16 +2178,13 @@ func (a *ConfigurationAPIService) NetworkGroupAssignmentDelete( } // Execute executes the request -// -// @return interface{} func (a *ConfigurationAPIService) NetworkGroupAssignmentDeleteExecute( r ApiNetworkGroupAssignmentDeleteRequest, -) (interface{}, *http.Response, error) { +) (*http.Response, error) { var ( - localVarHTTPMethod = http.MethodDelete - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue interface{} + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile ) localBasePath, err := a.client.cfg.ServerURLWithContext( @@ -1679,7 +2192,7 @@ func (a *ConfigurationAPIService) NetworkGroupAssignmentDeleteExecute( "ConfigurationAPIService.NetworkGroupAssignmentDelete", ) if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + return nil, &GenericOpenAPIError{error: err.Error()} } localVarPath := localBasePath + "/networking-uxi/v1alpha1/network-group-assignments/{id}" @@ -1722,19 +2235,19 @@ func (a *ConfigurationAPIService) NetworkGroupAssignmentDeleteExecute( formFiles, ) if err != nil { - return localVarReturnValue, nil, err + return nil, err } localVarHTTPResponse, err := a.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) if err != nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -1742,44 +2255,97 @@ func (a *ConfigurationAPIService) NetworkGroupAssignmentDeleteExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 401 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode( - &localVarReturnValue, - localVarBody, - localVarHTTPResponse.Header.Get("Content-Type"), - ) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 422 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, nil + return localVarHTTPResponse, nil } type ApiNetworkGroupAssignmentPostRequest struct { @@ -1802,7 +2368,7 @@ func (r ApiNetworkGroupAssignmentPostRequest) Execute() (*NetworkGroupAssignment /* NetworkGroupAssignmentPost Network Group Assignment Post -# Create a network group assignment +Create a network group assignment. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiNetworkGroupAssignmentPostRequest @@ -1898,7 +2464,51 @@ func (a *ConfigurationAPIService) NetworkGroupAssignmentPostExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -1909,7 +2519,29 @@ func (a *ConfigurationAPIService) NetworkGroupAssignmentPostExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 422 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -1946,11 +2578,13 @@ type ApiNetworkGroupAssignmentsGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiNetworkGroupAssignmentsGetRequest) Id(id string) ApiNetworkGroupAssignmentsGetRequest { r.id = &id return r } +// The next cursor for pagination. func (r ApiNetworkGroupAssignmentsGetRequest) Next( next string, ) ApiNetworkGroupAssignmentsGetRequest { @@ -1958,6 +2592,7 @@ func (r ApiNetworkGroupAssignmentsGetRequest) Next( return r } +// The maximum number of items returned in the response. func (r ApiNetworkGroupAssignmentsGetRequest) Limit( limit int32, ) ApiNetworkGroupAssignmentsGetRequest { @@ -1972,7 +2607,7 @@ func (r ApiNetworkGroupAssignmentsGetRequest) Execute() (*NetworkGroupAssignment /* NetworkGroupAssignmentsGet Network Group Assignments Get -# Get a list of network group assignments +Get a list of network group assignments. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiNetworkGroupAssignmentsGetRequest @@ -2073,7 +2708,51 @@ func (a *ConfigurationAPIService) NetworkGroupAssignmentsGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2084,7 +2763,7 @@ func (a *ConfigurationAPIService) NetworkGroupAssignmentsGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2119,17 +2798,17 @@ type ApiSensorGroupAssignmentDeleteRequest struct { id string } -func (r ApiSensorGroupAssignmentDeleteRequest) Execute() (interface{}, *http.Response, error) { +func (r ApiSensorGroupAssignmentDeleteRequest) Execute() (*http.Response, error) { return r.ApiService.SensorGroupAssignmentDeleteExecute(r) } /* SensorGroupAssignmentDelete Sensor Group Assignment Delete -# Delete a sensor group assignment +# Delete the specified sensor group assignment @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param id + @param id The unique identifier of the sensor group assignment @return ApiSensorGroupAssignmentDeleteRequest */ func (a *ConfigurationAPIService) SensorGroupAssignmentDelete( @@ -2144,16 +2823,13 @@ func (a *ConfigurationAPIService) SensorGroupAssignmentDelete( } // Execute executes the request -// -// @return interface{} func (a *ConfigurationAPIService) SensorGroupAssignmentDeleteExecute( r ApiSensorGroupAssignmentDeleteRequest, -) (interface{}, *http.Response, error) { +) (*http.Response, error) { var ( - localVarHTTPMethod = http.MethodDelete - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue interface{} + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile ) localBasePath, err := a.client.cfg.ServerURLWithContext( @@ -2161,7 +2837,7 @@ func (a *ConfigurationAPIService) SensorGroupAssignmentDeleteExecute( "ConfigurationAPIService.SensorGroupAssignmentDelete", ) if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + return nil, &GenericOpenAPIError{error: err.Error()} } localVarPath := localBasePath + "/networking-uxi/v1alpha1/sensor-group-assignments/{id}" @@ -2204,19 +2880,19 @@ func (a *ConfigurationAPIService) SensorGroupAssignmentDeleteExecute( formFiles, ) if err != nil { - return localVarReturnValue, nil, err + return nil, err } localVarHTTPResponse, err := a.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) if err != nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -2224,44 +2900,86 @@ func (a *ConfigurationAPIService) SensorGroupAssignmentDeleteExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode( - &localVarReturnValue, - localVarBody, - localVarHTTPResponse.Header.Get("Content-Type"), - ) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v } - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, nil + return localVarHTTPResponse, nil } type ApiSensorGroupAssignmentPostRequest struct { @@ -2284,7 +3002,7 @@ func (r ApiSensorGroupAssignmentPostRequest) Execute() (*SensorGroupAssignmentPo /* SensorGroupAssignmentPost Sensor Group Assignment Post -# Create sensor group assignment +Create a sensor group assignment. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiSensorGroupAssignmentPostRequest @@ -2380,7 +3098,73 @@ func (a *ConfigurationAPIService) SensorGroupAssignmentPostExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 422 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2391,7 +3175,7 @@ func (a *ConfigurationAPIService) SensorGroupAssignmentPostExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2428,16 +3212,19 @@ type ApiSensorGroupAssignmentsGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiSensorGroupAssignmentsGetRequest) Id(id string) ApiSensorGroupAssignmentsGetRequest { r.id = &id return r } +// The next cursor for pagination. func (r ApiSensorGroupAssignmentsGetRequest) Next(next string) ApiSensorGroupAssignmentsGetRequest { r.next = &next return r } +// The maximum number of items returned in the response. func (r ApiSensorGroupAssignmentsGetRequest) Limit( limit int32, ) ApiSensorGroupAssignmentsGetRequest { @@ -2452,7 +3239,7 @@ func (r ApiSensorGroupAssignmentsGetRequest) Execute() (*SensorGroupAssignmentsG /* SensorGroupAssignmentsGet Sensor Group Assignments Get -# Get a list of sensor group assignments +Get a list of sensor group assignments. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiSensorGroupAssignmentsGetRequest @@ -2553,7 +3340,51 @@ func (a *ConfigurationAPIService) SensorGroupAssignmentsGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2564,7 +3395,7 @@ func (a *ConfigurationAPIService) SensorGroupAssignmentsGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2596,7 +3427,7 @@ func (a *ConfigurationAPIService) SensorGroupAssignmentsGetExecute( type ApiSensorPatchRequest struct { ctx context.Context ApiService *ConfigurationAPIService - sensorUid string + id string sensorPatchRequest *SensorPatchRequest } @@ -2614,20 +3445,20 @@ func (r ApiSensorPatchRequest) Execute() (*SensorPatchResponse, *http.Response, /* SensorPatch Sensor Patch -Update an existing sensor. +Update the properties of a sensor. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param sensorUid + @param id The unique identifier of the sensor @return ApiSensorPatchRequest */ func (a *ConfigurationAPIService) SensorPatch( ctx context.Context, - sensorUid string, + id string, ) ApiSensorPatchRequest { return ApiSensorPatchRequest{ ApiService: a, ctx: ctx, - sensorUid: sensorUid, + id: id, } } @@ -2652,11 +3483,11 @@ func (a *ConfigurationAPIService) SensorPatchExecute( return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/networking-uxi/v1alpha1/sensors/{sensor_uid}" + localVarPath := localBasePath + "/networking-uxi/v1alpha1/sensors/{id}" localVarPath = strings.Replace( localVarPath, - "{"+"sensor_uid"+"}", - url.PathEscape(parameterValueToString(r.sensorUid, "sensorUid")), + "{"+"id"+"}", + url.PathEscape(parameterValueToString(r.id, "id")), -1, ) @@ -2719,7 +3550,62 @@ func (a *ConfigurationAPIService) SensorPatchExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2730,7 +3616,7 @@ func (a *ConfigurationAPIService) SensorPatchExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2767,16 +3653,19 @@ type ApiSensorsGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiSensorsGetRequest) Id(id string) ApiSensorsGetRequest { r.id = &id return r } +// The next cursor for pagination. func (r ApiSensorsGetRequest) Next(next string) ApiSensorsGetRequest { r.next = &next return r } +// The maximum number of items returned in the response. func (r ApiSensorsGetRequest) Limit(limit int32) ApiSensorsGetRequest { r.limit = &limit return r @@ -2789,7 +3678,7 @@ func (r ApiSensorsGetRequest) Execute() (*SensorsGetResponse, *http.Response, er /* SensorsGet Sensors Get -# Get a list of sensors +# List of sensors @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiSensorsGetRequest @@ -2888,7 +3777,51 @@ func (a *ConfigurationAPIService) SensorsGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2899,7 +3832,7 @@ func (a *ConfigurationAPIService) SensorsGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -2934,17 +3867,17 @@ type ApiServiceTestGroupAssignmentDeleteRequest struct { id string } -func (r ApiServiceTestGroupAssignmentDeleteRequest) Execute() (interface{}, *http.Response, error) { +func (r ApiServiceTestGroupAssignmentDeleteRequest) Execute() (*http.Response, error) { return r.ApiService.ServiceTestGroupAssignmentDeleteExecute(r) } /* ServiceTestGroupAssignmentDelete Service Test Group Assignment Delete -# Delete a service test group assignment +# Delete the specified service test group assignment @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param id + @param id The unique identifier of the service test group assignment @return ApiServiceTestGroupAssignmentDeleteRequest */ func (a *ConfigurationAPIService) ServiceTestGroupAssignmentDelete( @@ -2959,16 +3892,13 @@ func (a *ConfigurationAPIService) ServiceTestGroupAssignmentDelete( } // Execute executes the request -// -// @return interface{} func (a *ConfigurationAPIService) ServiceTestGroupAssignmentDeleteExecute( r ApiServiceTestGroupAssignmentDeleteRequest, -) (interface{}, *http.Response, error) { +) (*http.Response, error) { var ( - localVarHTTPMethod = http.MethodDelete - localVarPostBody interface{} - formFiles []formFile - localVarReturnValue interface{} + localVarHTTPMethod = http.MethodDelete + localVarPostBody interface{} + formFiles []formFile ) localBasePath, err := a.client.cfg.ServerURLWithContext( @@ -2976,7 +3906,7 @@ func (a *ConfigurationAPIService) ServiceTestGroupAssignmentDeleteExecute( "ConfigurationAPIService.ServiceTestGroupAssignmentDelete", ) if err != nil { - return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()} + return nil, &GenericOpenAPIError{error: err.Error()} } localVarPath := localBasePath + "/networking-uxi/v1alpha1/service-test-group-assignments/{id}" @@ -3019,19 +3949,19 @@ func (a *ConfigurationAPIService) ServiceTestGroupAssignmentDeleteExecute( formFiles, ) if err != nil { - return localVarReturnValue, nil, err + return nil, err } localVarHTTPResponse, err := a.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } localVarBody, err := io.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody)) if err != nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -3039,44 +3969,97 @@ func (a *ConfigurationAPIService) ServiceTestGroupAssignmentDeleteExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = a.client.decode( - &localVarReturnValue, - localVarBody, - localVarHTTPResponse.Header.Get("Content-Type"), - ) - if err != nil { - newErr := &GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), + if localVarHTTPResponse.StatusCode == 422 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr + if localVarHTTPResponse.StatusCode == 500 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + } + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, nil + return localVarHTTPResponse, nil } type ApiServiceTestGroupAssignmentPostRequest struct { @@ -3099,7 +4082,7 @@ func (r ApiServiceTestGroupAssignmentPostRequest) Execute() (*ServiceTestGroupAs /* ServiceTestGroupAssignmentPost Service Test Group Assignment Post -# Create a service-test group assignment +Create a service-test group assignment. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiServiceTestGroupAssignmentPostRequest @@ -3195,7 +4178,73 @@ func (a *ConfigurationAPIService) ServiceTestGroupAssignmentPostExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 409 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 422 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -3206,7 +4255,7 @@ func (a *ConfigurationAPIService) ServiceTestGroupAssignmentPostExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -3243,6 +4292,7 @@ type ApiServiceTestGroupAssignmentsGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiServiceTestGroupAssignmentsGetRequest) Id( id string, ) ApiServiceTestGroupAssignmentsGetRequest { @@ -3250,6 +4300,7 @@ func (r ApiServiceTestGroupAssignmentsGetRequest) Id( return r } +// The next cursor for pagination. func (r ApiServiceTestGroupAssignmentsGetRequest) Next( next string, ) ApiServiceTestGroupAssignmentsGetRequest { @@ -3257,6 +4308,7 @@ func (r ApiServiceTestGroupAssignmentsGetRequest) Next( return r } +// The maximum number of items returned in the response. func (r ApiServiceTestGroupAssignmentsGetRequest) Limit( limit int32, ) ApiServiceTestGroupAssignmentsGetRequest { @@ -3271,7 +4323,7 @@ func (r ApiServiceTestGroupAssignmentsGetRequest) Execute() (*ServiceTestGroupAs /* ServiceTestGroupAssignmentsGet Service Test Group Assignments Get -# Get a list of service test group assignments +Get a list of service test group assignments. @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiServiceTestGroupAssignmentsGetRequest @@ -3372,7 +4424,51 @@ func (a *ConfigurationAPIService) ServiceTestGroupAssignmentsGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -3383,7 +4479,7 @@ func (a *ConfigurationAPIService) ServiceTestGroupAssignmentsGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -3420,16 +4516,19 @@ type ApiServiceTestsGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiServiceTestsGetRequest) Id(id string) ApiServiceTestsGetRequest { r.id = &id return r } +// The next cursor for pagination. func (r ApiServiceTestsGetRequest) Next(next string) ApiServiceTestsGetRequest { r.next = &next return r } +// The maximum number of items returned in the response. func (r ApiServiceTestsGetRequest) Limit(limit int32) ApiServiceTestsGetRequest { r.limit = &limit return r @@ -3541,7 +4640,51 @@ func (a *ConfigurationAPIService) ServiceTestsGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -3552,7 +4695,7 @@ func (a *ConfigurationAPIService) ServiceTestsGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -3589,16 +4732,19 @@ type ApiWiredNetworksGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiWiredNetworksGetRequest) Id(id string) ApiWiredNetworksGetRequest { r.id = &id return r } +// The next cursor for pagination. func (r ApiWiredNetworksGetRequest) Next(next string) ApiWiredNetworksGetRequest { r.next = &next return r } +// The maximum number of items returned in the response. func (r ApiWiredNetworksGetRequest) Limit(limit int32) ApiWiredNetworksGetRequest { r.limit = &limit return r @@ -3710,7 +4856,51 @@ func (a *ConfigurationAPIService) WiredNetworksGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -3721,7 +4911,7 @@ func (a *ConfigurationAPIService) WiredNetworksGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -3758,16 +4948,19 @@ type ApiWirelessNetworksGetRequest struct { limit *int32 } +// The ID of the resource. func (r ApiWirelessNetworksGetRequest) Id(id string) ApiWirelessNetworksGetRequest { r.id = &id return r } +// The next cursor for pagination. func (r ApiWirelessNetworksGetRequest) Next(next string) ApiWirelessNetworksGetRequest { r.next = &next return r } +// The maximum number of items returned in the response. func (r ApiWirelessNetworksGetRequest) Limit(limit int32) ApiWirelessNetworksGetRequest { r.limit = &limit return r @@ -3881,7 +5074,51 @@ func (a *ConfigurationAPIService) WirelessNetworksGetExecute( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode >= 400 && localVarHTTPResponse.StatusCode < 500 { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 403 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 405 { + var v ErrorResponse + err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v) + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 415 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { @@ -3892,7 +5129,7 @@ func (a *ConfigurationAPIService) WirelessNetworksGetExecute( newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } - if localVarHTTPResponse.StatusCode >= 500 { + if localVarHTTPResponse.StatusCode == 500 { var v ErrorResponse err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { diff --git a/pkg/config-api-client/client.go b/pkg/config-api-client/client.go index d20be05..6646c67 100644 --- a/pkg/config-api-client/client.go +++ b/pkg/config-api-client/client.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -45,7 +45,7 @@ var ( queryDescape = strings.NewReplacer("%5B", "[", "%5D", "]") ) -// APIClient manages communication with the HPE Aruba Networking UXI Configuration API v5.21.0 +// APIClient manages communication with the HPE Aruba Networking UXI Configuration API v5.22.0 // In most cases there should be only one, shared, APIClient. type APIClient struct { cfg *Configuration diff --git a/pkg/config-api-client/configuration.go b/pkg/config-api-client/configuration.go index be535b2..c144727 100644 --- a/pkg/config-api-client/configuration.go +++ b/pkg/config-api-client/configuration.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ diff --git a/pkg/config-api-client/docs/AgentGroupAssignmentPostAgent.md b/pkg/config-api-client/docs/AgentGroupAssignmentPostAgent.md index 07332ba..1ce4b90 100644 --- a/pkg/config-api-client/docs/AgentGroupAssignmentPostAgent.md +++ b/pkg/config-api-client/docs/AgentGroupAssignmentPostAgent.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the agent | ## Methods diff --git a/pkg/config-api-client/docs/AgentGroupAssignmentPostGroup.md b/pkg/config-api-client/docs/AgentGroupAssignmentPostGroup.md index 7aef341..223d98b 100644 --- a/pkg/config-api-client/docs/AgentGroupAssignmentPostGroup.md +++ b/pkg/config-api-client/docs/AgentGroupAssignmentPostGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the group | ## Methods diff --git a/pkg/config-api-client/docs/AgentGroupAssignmentPostRequest.md b/pkg/config-api-client/docs/AgentGroupAssignmentPostRequest.md index da6abef..ca13e68 100644 --- a/pkg/config-api-client/docs/AgentGroupAssignmentPostRequest.md +++ b/pkg/config-api-client/docs/AgentGroupAssignmentPostRequest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GroupId** | **string** | | -**AgentId** | **string** | | +**GroupId** | **string** | The unique identifier of the group | +**AgentId** | **string** | The unique identifier of the agent | ## Methods diff --git a/pkg/config-api-client/docs/AgentGroupAssignmentPostResponse.md b/pkg/config-api-client/docs/AgentGroupAssignmentPostResponse.md index 1e84e62..141d8db 100644 --- a/pkg/config-api-client/docs/AgentGroupAssignmentPostResponse.md +++ b/pkg/config-api-client/docs/AgentGroupAssignmentPostResponse.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the agent group assignment | **Group** | [**AgentGroupAssignmentPostGroup**](AgentGroupAssignmentPostGroup.md) | | **Agent** | [**AgentGroupAssignmentPostAgent**](AgentGroupAssignmentPostAgent.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/AgentGroupAssignmentsGetAgent.md b/pkg/config-api-client/docs/AgentGroupAssignmentsGetAgent.md index 2ae0010..7e74a91 100644 --- a/pkg/config-api-client/docs/AgentGroupAssignmentsGetAgent.md +++ b/pkg/config-api-client/docs/AgentGroupAssignmentsGetAgent.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the agent | ## Methods diff --git a/pkg/config-api-client/docs/AgentGroupAssignmentsGetGroup.md b/pkg/config-api-client/docs/AgentGroupAssignmentsGetGroup.md index e0176b4..bf7bdd9 100644 --- a/pkg/config-api-client/docs/AgentGroupAssignmentsGetGroup.md +++ b/pkg/config-api-client/docs/AgentGroupAssignmentsGetGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the group | ## Methods diff --git a/pkg/config-api-client/docs/AgentGroupAssignmentsGetItem.md b/pkg/config-api-client/docs/AgentGroupAssignmentsGetItem.md index 4c063da..a79ddb4 100644 --- a/pkg/config-api-client/docs/AgentGroupAssignmentsGetItem.md +++ b/pkg/config-api-client/docs/AgentGroupAssignmentsGetItem.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the agent group assignment | **Group** | [**AgentGroupAssignmentsGetGroup**](AgentGroupAssignmentsGetGroup.md) | | **Agent** | [**AgentGroupAssignmentsGetAgent**](AgentGroupAssignmentsGetAgent.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/AgentGroupAssignmentsGetResponse.md b/pkg/config-api-client/docs/AgentGroupAssignmentsGetResponse.md index 41b7d6f..b5fd14c 100644 --- a/pkg/config-api-client/docs/AgentGroupAssignmentsGetResponse.md +++ b/pkg/config-api-client/docs/AgentGroupAssignmentsGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]AgentGroupAssignmentsGetItem**](AgentGroupAssignmentsGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]AgentGroupAssignmentsGetItem**](AgentGroupAssignmentsGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/docs/AgentPatchRequest.md b/pkg/config-api-client/docs/AgentPatchRequest.md index f70285e..d01cbef 100644 --- a/pkg/config-api-client/docs/AgentPatchRequest.md +++ b/pkg/config-api-client/docs/AgentPatchRequest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | | [optional] -**Notes** | Pointer to **string** | | [optional] +**Name** | Pointer to **string** | The name of the agent | [optional] +**Notes** | Pointer to **string** | The notes of the agent | [optional] **PcapMode** | Pointer to [**AgentPcapMode**](AgentPcapMode.md) | | [optional] ## Methods diff --git a/pkg/config-api-client/docs/AgentPatchResponse.md b/pkg/config-api-client/docs/AgentPatchResponse.md index bb8860e..b01ec73 100644 --- a/pkg/config-api-client/docs/AgentPatchResponse.md +++ b/pkg/config-api-client/docs/AgentPatchResponse.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Serial** | **string** | | -**Name** | **string** | | -**ModelNumber** | **NullableString** | | -**WifiMacAddress** | **NullableString** | | -**EthernetMacAddress** | **NullableString** | | -**Notes** | **NullableString** | | +**Id** | **string** | The unique identifier of the agent | +**Serial** | **string** | The serial number of the agent | +**Name** | **string** | The name of the agent | +**ModelNumber** | **NullableString** | The model number of the agent | +**WifiMacAddress** | **NullableString** | The WiFi MAC address of the agent | +**EthernetMacAddress** | **NullableString** | The Ethernet MAC address of the agent | +**Notes** | **NullableString** | The notes of the agent | **PcapMode** | [**NullableAgentPcapMode**](AgentPcapMode.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/AgentsGetItem.md b/pkg/config-api-client/docs/AgentsGetItem.md index fbe3813..c105be9 100644 --- a/pkg/config-api-client/docs/AgentsGetItem.md +++ b/pkg/config-api-client/docs/AgentsGetItem.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Serial** | **string** | | -**Name** | **string** | | -**ModelNumber** | **NullableString** | | -**WifiMacAddress** | **NullableString** | | -**EthernetMacAddress** | **NullableString** | | -**Notes** | **NullableString** | | +**Id** | **string** | The unique identifier of the agent | +**Serial** | **string** | The serial number of the agent | +**Name** | **string** | The name of the agent | +**ModelNumber** | **NullableString** | The model number of the agent | +**WifiMacAddress** | **NullableString** | The WiFi MAC address of the agent | +**EthernetMacAddress** | **NullableString** | The Ethernet MAC address of the agent | +**Notes** | **NullableString** | The notes of the agent | **PcapMode** | [**NullableAgentPcapMode**](AgentPcapMode.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/AgentsGetResponse.md b/pkg/config-api-client/docs/AgentsGetResponse.md index 6cac551..f175720 100644 --- a/pkg/config-api-client/docs/AgentsGetResponse.md +++ b/pkg/config-api-client/docs/AgentsGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]AgentsGetItem**](AgentsGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]AgentsGetItem**](AgentsGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/docs/ConfigurationAPI.md b/pkg/config-api-client/docs/ConfigurationAPI.md index 1faeddb..20c7cbe 100644 --- a/pkg/config-api-client/docs/ConfigurationAPI.md +++ b/pkg/config-api-client/docs/ConfigurationAPI.md @@ -4,14 +4,14 @@ All URIs are relative to *https://api.capenetworks.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**AgentDelete**](ConfigurationAPI.md#AgentDelete) | **Delete** /networking-uxi/v1alpha1/agents/{agent_uid} | Agent Delete -[**AgentGroupAssignmentDelete**](ConfigurationAPI.md#AgentGroupAssignmentDelete) | **Delete** /networking-uxi/v1alpha1/agent-group-assignments/{uid} | Agent Group Assignment Delete +[**AgentDelete**](ConfigurationAPI.md#AgentDelete) | **Delete** /networking-uxi/v1alpha1/agents/{id} | Agent Delete +[**AgentGroupAssignmentDelete**](ConfigurationAPI.md#AgentGroupAssignmentDelete) | **Delete** /networking-uxi/v1alpha1/agent-group-assignments/{id} | Agent Group Assignment Delete [**AgentGroupAssignmentPost**](ConfigurationAPI.md#AgentGroupAssignmentPost) | **Post** /networking-uxi/v1alpha1/agent-group-assignments | Agent Group Assignment Post [**AgentGroupAssignmentsGet**](ConfigurationAPI.md#AgentGroupAssignmentsGet) | **Get** /networking-uxi/v1alpha1/agent-group-assignments | Agent Group Assignments Get -[**AgentPatch**](ConfigurationAPI.md#AgentPatch) | **Patch** /networking-uxi/v1alpha1/agents/{agent_uid} | Agent Patch +[**AgentPatch**](ConfigurationAPI.md#AgentPatch) | **Patch** /networking-uxi/v1alpha1/agents/{id} | Agent Patch [**AgentsGet**](ConfigurationAPI.md#AgentsGet) | **Get** /networking-uxi/v1alpha1/agents | Agents Get -[**GroupDelete**](ConfigurationAPI.md#GroupDelete) | **Delete** /networking-uxi/v1alpha1/groups/{group_uid} | Group Delete -[**GroupPatch**](ConfigurationAPI.md#GroupPatch) | **Patch** /networking-uxi/v1alpha1/groups/{group_uid} | Group Patch +[**GroupDelete**](ConfigurationAPI.md#GroupDelete) | **Delete** /networking-uxi/v1alpha1/groups/{id} | Group Delete +[**GroupPatch**](ConfigurationAPI.md#GroupPatch) | **Patch** /networking-uxi/v1alpha1/groups/{id} | Group Patch [**GroupPost**](ConfigurationAPI.md#GroupPost) | **Post** /networking-uxi/v1alpha1/groups | Group Post [**GroupsGet**](ConfigurationAPI.md#GroupsGet) | **Get** /networking-uxi/v1alpha1/groups | Groups Get [**NetworkGroupAssignmentDelete**](ConfigurationAPI.md#NetworkGroupAssignmentDelete) | **Delete** /networking-uxi/v1alpha1/network-group-assignments/{id} | Network Group Assignment Delete @@ -20,7 +20,7 @@ Method | HTTP request | Description [**SensorGroupAssignmentDelete**](ConfigurationAPI.md#SensorGroupAssignmentDelete) | **Delete** /networking-uxi/v1alpha1/sensor-group-assignments/{id} | Sensor Group Assignment Delete [**SensorGroupAssignmentPost**](ConfigurationAPI.md#SensorGroupAssignmentPost) | **Post** /networking-uxi/v1alpha1/sensor-group-assignments | Sensor Group Assignment Post [**SensorGroupAssignmentsGet**](ConfigurationAPI.md#SensorGroupAssignmentsGet) | **Get** /networking-uxi/v1alpha1/sensor-group-assignments | Sensor Group Assignments Get -[**SensorPatch**](ConfigurationAPI.md#SensorPatch) | **Patch** /networking-uxi/v1alpha1/sensors/{sensor_uid} | Sensor Patch +[**SensorPatch**](ConfigurationAPI.md#SensorPatch) | **Patch** /networking-uxi/v1alpha1/sensors/{id} | Sensor Patch [**SensorsGet**](ConfigurationAPI.md#SensorsGet) | **Get** /networking-uxi/v1alpha1/sensors | Sensors Get [**ServiceTestGroupAssignmentDelete**](ConfigurationAPI.md#ServiceTestGroupAssignmentDelete) | **Delete** /networking-uxi/v1alpha1/service-test-group-assignments/{id} | Service Test Group Assignment Delete [**ServiceTestGroupAssignmentPost**](ConfigurationAPI.md#ServiceTestGroupAssignmentPost) | **Post** /networking-uxi/v1alpha1/service-test-group-assignments | Service Test Group Assignment Post @@ -33,7 +33,7 @@ Method | HTTP request | Description ## AgentDelete -> interface{} AgentDelete(ctx, agentUid).Execute() +> AgentDelete(ctx, id).Execute() Agent Delete @@ -52,17 +52,15 @@ import ( ) func main() { - agentUid := "agentUid_example" // string | + id := "id_example" // string | The unique identifier of the agent configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationAPI.AgentDelete(context.Background(), agentUid).Execute() + r, err := apiClient.ConfigurationAPI.AgentDelete(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationAPI.AgentDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `AgentDelete`: interface{} - fmt.Fprintf(os.Stdout, "Response from `ConfigurationAPI.AgentDelete`: %v\n", resp) } ``` @@ -72,7 +70,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**agentUid** | **string** | | +**id** | **string** | The unique identifier of the agent | ### Other Parameters @@ -85,7 +83,7 @@ Name | Type | Description | Notes ### Return type -**interface{}** + (empty response body) ### Authorization @@ -103,7 +101,7 @@ Name | Type | Description | Notes ## AgentGroupAssignmentDelete -> interface{} AgentGroupAssignmentDelete(ctx, uid).Execute() +> AgentGroupAssignmentDelete(ctx, id).Execute() Agent Group Assignment Delete @@ -122,17 +120,15 @@ import ( ) func main() { - uid := "uid_example" // string | + id := "id_example" // string | The unique identifier of the assignment configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationAPI.AgentGroupAssignmentDelete(context.Background(), uid).Execute() + r, err := apiClient.ConfigurationAPI.AgentGroupAssignmentDelete(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationAPI.AgentGroupAssignmentDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `AgentGroupAssignmentDelete`: interface{} - fmt.Fprintf(os.Stdout, "Response from `ConfigurationAPI.AgentGroupAssignmentDelete`: %v\n", resp) } ``` @@ -142,7 +138,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**uid** | **string** | | +**id** | **string** | The unique identifier of the assignment | ### Other Parameters @@ -155,7 +151,7 @@ Name | Type | Description | Notes ### Return type -**interface{}** + (empty response body) ### Authorization @@ -258,9 +254,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -285,9 +281,9 @@ Other parameters are passed through a pointer to a apiAgentGroupAssignmentsGetRe Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type @@ -309,7 +305,7 @@ Name | Type | Description | Notes ## AgentPatch -> AgentPatchResponse AgentPatch(ctx, agentUid).AgentPatchRequest(agentPatchRequest).Execute() +> AgentPatchResponse AgentPatch(ctx, id).AgentPatchRequest(agentPatchRequest).Execute() Agent Patch @@ -328,12 +324,12 @@ import ( ) func main() { - agentUid := "agentUid_example" // string | + id := "id_example" // string | The unique identifier of the agent agentPatchRequest := *openapiclient.NewAgentPatchRequest() // AgentPatchRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationAPI.AgentPatch(context.Background(), agentUid).AgentPatchRequest(agentPatchRequest).Execute() + resp, r, err := apiClient.ConfigurationAPI.AgentPatch(context.Background(), id).AgentPatchRequest(agentPatchRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationAPI.AgentPatch``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -349,7 +345,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**agentUid** | **string** | | +**id** | **string** | The unique identifier of the agent | ### Other Parameters @@ -400,9 +396,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -427,9 +423,9 @@ Other parameters are passed through a pointer to a apiAgentsGetRequest struct vi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type @@ -451,7 +447,7 @@ Name | Type | Description | Notes ## GroupDelete -> interface{} GroupDelete(ctx, groupUid).Execute() +> GroupDelete(ctx, id).Execute() Group Delete @@ -470,17 +466,15 @@ import ( ) func main() { - groupUid := "groupUid_example" // string | + id := "id_example" // string | The unique identifier of the group. configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationAPI.GroupDelete(context.Background(), groupUid).Execute() + r, err := apiClient.ConfigurationAPI.GroupDelete(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationAPI.GroupDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `GroupDelete`: interface{} - fmt.Fprintf(os.Stdout, "Response from `ConfigurationAPI.GroupDelete`: %v\n", resp) } ``` @@ -490,7 +484,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**groupUid** | **string** | | +**id** | **string** | The unique identifier of the group. | ### Other Parameters @@ -503,7 +497,7 @@ Name | Type | Description | Notes ### Return type -**interface{}** + (empty response body) ### Authorization @@ -521,7 +515,7 @@ Name | Type | Description | Notes ## GroupPatch -> GroupPatchResponse GroupPatch(ctx, groupUid).GroupPatchRequest(groupPatchRequest).Execute() +> GroupPatchResponse GroupPatch(ctx, id).GroupPatchRequest(groupPatchRequest).Execute() Group Patch @@ -540,12 +534,12 @@ import ( ) func main() { - groupUid := "groupUid_example" // string | + id := "id_example" // string | The unique identifier of the group groupPatchRequest := *openapiclient.NewGroupPatchRequest() // GroupPatchRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationAPI.GroupPatch(context.Background(), groupUid).GroupPatchRequest(groupPatchRequest).Execute() + resp, r, err := apiClient.ConfigurationAPI.GroupPatch(context.Background(), id).GroupPatchRequest(groupPatchRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationAPI.GroupPatch``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -561,7 +555,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**groupUid** | **string** | | +**id** | **string** | The unique identifier of the group | ### Other Parameters @@ -678,9 +672,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -705,9 +699,9 @@ Other parameters are passed through a pointer to a apiGroupsGetRequest struct vi Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type @@ -729,7 +723,7 @@ Name | Type | Description | Notes ## NetworkGroupAssignmentDelete -> interface{} NetworkGroupAssignmentDelete(ctx, id).Execute() +> NetworkGroupAssignmentDelete(ctx, id).Execute() Network Group Assignment Delete @@ -748,17 +742,15 @@ import ( ) func main() { - id := "id_example" // string | + id := "id_example" // string | The unique identifier of the network group assignment configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationAPI.NetworkGroupAssignmentDelete(context.Background(), id).Execute() + r, err := apiClient.ConfigurationAPI.NetworkGroupAssignmentDelete(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationAPI.NetworkGroupAssignmentDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `NetworkGroupAssignmentDelete`: interface{} - fmt.Fprintf(os.Stdout, "Response from `ConfigurationAPI.NetworkGroupAssignmentDelete`: %v\n", resp) } ``` @@ -768,7 +760,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | | +**id** | **string** | The unique identifier of the network group assignment | ### Other Parameters @@ -781,7 +773,7 @@ Name | Type | Description | Notes ### Return type -**interface{}** + (empty response body) ### Authorization @@ -884,9 +876,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -911,9 +903,9 @@ Other parameters are passed through a pointer to a apiNetworkGroupAssignmentsGet Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type @@ -935,7 +927,7 @@ Name | Type | Description | Notes ## SensorGroupAssignmentDelete -> interface{} SensorGroupAssignmentDelete(ctx, id).Execute() +> SensorGroupAssignmentDelete(ctx, id).Execute() Sensor Group Assignment Delete @@ -954,17 +946,15 @@ import ( ) func main() { - id := "id_example" // string | + id := "id_example" // string | The unique identifier of the sensor group assignment configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationAPI.SensorGroupAssignmentDelete(context.Background(), id).Execute() + r, err := apiClient.ConfigurationAPI.SensorGroupAssignmentDelete(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationAPI.SensorGroupAssignmentDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `SensorGroupAssignmentDelete`: interface{} - fmt.Fprintf(os.Stdout, "Response from `ConfigurationAPI.SensorGroupAssignmentDelete`: %v\n", resp) } ``` @@ -974,7 +964,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | | +**id** | **string** | The unique identifier of the sensor group assignment | ### Other Parameters @@ -987,7 +977,7 @@ Name | Type | Description | Notes ### Return type -**interface{}** + (empty response body) ### Authorization @@ -1090,9 +1080,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -1117,9 +1107,9 @@ Other parameters are passed through a pointer to a apiSensorGroupAssignmentsGetR Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type @@ -1141,7 +1131,7 @@ Name | Type | Description | Notes ## SensorPatch -> SensorPatchResponse SensorPatch(ctx, sensorUid).SensorPatchRequest(sensorPatchRequest).Execute() +> SensorPatchResponse SensorPatch(ctx, id).SensorPatchRequest(sensorPatchRequest).Execute() Sensor Patch @@ -1160,12 +1150,12 @@ import ( ) func main() { - sensorUid := "sensorUid_example" // string | + id := "id_example" // string | The unique identifier of the sensor sensorPatchRequest := *openapiclient.NewSensorPatchRequest() // SensorPatchRequest | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationAPI.SensorPatch(context.Background(), sensorUid).SensorPatchRequest(sensorPatchRequest).Execute() + resp, r, err := apiClient.ConfigurationAPI.SensorPatch(context.Background(), id).SensorPatchRequest(sensorPatchRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationAPI.SensorPatch``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -1181,7 +1171,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**sensorUid** | **string** | | +**id** | **string** | The unique identifier of the sensor | ### Other Parameters @@ -1232,9 +1222,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -1259,9 +1249,9 @@ Other parameters are passed through a pointer to a apiSensorsGetRequest struct v Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type @@ -1283,7 +1273,7 @@ Name | Type | Description | Notes ## ServiceTestGroupAssignmentDelete -> interface{} ServiceTestGroupAssignmentDelete(ctx, id).Execute() +> ServiceTestGroupAssignmentDelete(ctx, id).Execute() Service Test Group Assignment Delete @@ -1302,17 +1292,15 @@ import ( ) func main() { - id := "id_example" // string | + id := "id_example" // string | The unique identifier of the service test group assignment configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.ConfigurationAPI.ServiceTestGroupAssignmentDelete(context.Background(), id).Execute() + r, err := apiClient.ConfigurationAPI.ServiceTestGroupAssignmentDelete(context.Background(), id).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ConfigurationAPI.ServiceTestGroupAssignmentDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - // response from `ServiceTestGroupAssignmentDelete`: interface{} - fmt.Fprintf(os.Stdout, "Response from `ConfigurationAPI.ServiceTestGroupAssignmentDelete`: %v\n", resp) } ``` @@ -1322,7 +1310,7 @@ func main() { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string** | | +**id** | **string** | The unique identifier of the service test group assignment | ### Other Parameters @@ -1335,7 +1323,7 @@ Name | Type | Description | Notes ### Return type -**interface{}** + (empty response body) ### Authorization @@ -1438,9 +1426,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -1465,9 +1453,9 @@ Other parameters are passed through a pointer to a apiServiceTestGroupAssignment Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type @@ -1508,9 +1496,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -1535,9 +1523,9 @@ Other parameters are passed through a pointer to a apiServiceTestsGetRequest str Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type @@ -1578,9 +1566,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -1605,9 +1593,9 @@ Other parameters are passed through a pointer to a apiWiredNetworksGetRequest st Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type @@ -1648,9 +1636,9 @@ import ( ) func main() { - id := "id_example" // string | (optional) - next := "next_example" // string | (optional) - limit := int32(56) // int32 | (optional) (default to 50) + id := "id_example" // string | The ID of the resource. (optional) + next := "next_example" // string | The next cursor for pagination. (optional) + limit := int32(56) // int32 | The maximum number of items returned in the response. (optional) (default to 50) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) @@ -1675,9 +1663,9 @@ Other parameters are passed through a pointer to a apiWirelessNetworksGetRequest Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **string** | | - **next** | **string** | | - **limit** | **int32** | | [default to 50] + **id** | **string** | The ID of the resource. | + **next** | **string** | The next cursor for pagination. | + **limit** | **int32** | The maximum number of items returned in the response. | [default to 50] ### Return type diff --git a/pkg/config-api-client/docs/GroupPatchParent.md b/pkg/config-api-client/docs/GroupPatchParent.md index 48070b3..ca1b3b6 100644 --- a/pkg/config-api-client/docs/GroupPatchParent.md +++ b/pkg/config-api-client/docs/GroupPatchParent.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the parent group | ## Methods diff --git a/pkg/config-api-client/docs/GroupPatchRequest.md b/pkg/config-api-client/docs/GroupPatchRequest.md index 4dd697c..3a96466 100644 --- a/pkg/config-api-client/docs/GroupPatchRequest.md +++ b/pkg/config-api-client/docs/GroupPatchRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | | [optional] +**Name** | Pointer to **string** | The updated group name | [optional] ## Methods diff --git a/pkg/config-api-client/docs/GroupPatchResponse.md b/pkg/config-api-client/docs/GroupPatchResponse.md index ced9bc1..87b493e 100644 --- a/pkg/config-api-client/docs/GroupPatchResponse.md +++ b/pkg/config-api-client/docs/GroupPatchResponse.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Name** | **string** | | -**Path** | **string** | | +**Id** | **string** | The unique identifier of the group | +**Name** | **string** | The name of the group | +**Path** | **string** | The path of the group | **Parent** | [**GroupPatchParent**](GroupPatchParent.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/GroupPostParent.md b/pkg/config-api-client/docs/GroupPostParent.md index 21791d1..0307005 100644 --- a/pkg/config-api-client/docs/GroupPostParent.md +++ b/pkg/config-api-client/docs/GroupPostParent.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the parent group | ## Methods diff --git a/pkg/config-api-client/docs/GroupPostRequest.md b/pkg/config-api-client/docs/GroupPostRequest.md index b070456..6b6964a 100644 --- a/pkg/config-api-client/docs/GroupPostRequest.md +++ b/pkg/config-api-client/docs/GroupPostRequest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ParentId** | Pointer to **NullableString** | | [optional] -**Name** | **string** | | +**ParentId** | Pointer to **NullableString** | The unique identifier of the parent group | [optional] +**Name** | **string** | The name of the group | ## Methods diff --git a/pkg/config-api-client/docs/GroupPostResponse.md b/pkg/config-api-client/docs/GroupPostResponse.md index ffb1201..b990056 100644 --- a/pkg/config-api-client/docs/GroupPostResponse.md +++ b/pkg/config-api-client/docs/GroupPostResponse.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Name** | **string** | | -**Path** | **string** | | +**Id** | **string** | The unique identifier of the group | +**Name** | **string** | The name of the group | +**Path** | **string** | The path of the group | **Parent** | [**GroupPostParent**](GroupPostParent.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/GroupsGetItem.md b/pkg/config-api-client/docs/GroupsGetItem.md index c19c35c..28199b8 100644 --- a/pkg/config-api-client/docs/GroupsGetItem.md +++ b/pkg/config-api-client/docs/GroupsGetItem.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Name** | **string** | | +**Id** | **string** | The unique identifier of the group | +**Name** | **string** | The name of the group | **Parent** | [**NullableGroupsGetParent**](GroupsGetParent.md) | | -**Path** | **string** | | -**Type** | **string** | | +**Path** | **string** | The path of the group | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/GroupsGetParent.md b/pkg/config-api-client/docs/GroupsGetParent.md index e926864..744d4a8 100644 --- a/pkg/config-api-client/docs/GroupsGetParent.md +++ b/pkg/config-api-client/docs/GroupsGetParent.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the parent group | ## Methods diff --git a/pkg/config-api-client/docs/GroupsGetResponse.md b/pkg/config-api-client/docs/GroupsGetResponse.md index f37051d..ee36a8b 100644 --- a/pkg/config-api-client/docs/GroupsGetResponse.md +++ b/pkg/config-api-client/docs/GroupsGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]GroupsGetItem**](GroupsGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]GroupsGetItem**](GroupsGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/docs/NetworkGroupAssignmentPostGroup.md b/pkg/config-api-client/docs/NetworkGroupAssignmentPostGroup.md index 42c352b..dd1613f 100644 --- a/pkg/config-api-client/docs/NetworkGroupAssignmentPostGroup.md +++ b/pkg/config-api-client/docs/NetworkGroupAssignmentPostGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the group | ## Methods diff --git a/pkg/config-api-client/docs/NetworkGroupAssignmentPostNetwork.md b/pkg/config-api-client/docs/NetworkGroupAssignmentPostNetwork.md index bf04f06..17896e9 100644 --- a/pkg/config-api-client/docs/NetworkGroupAssignmentPostNetwork.md +++ b/pkg/config-api-client/docs/NetworkGroupAssignmentPostNetwork.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the network | ## Methods diff --git a/pkg/config-api-client/docs/NetworkGroupAssignmentPostRequest.md b/pkg/config-api-client/docs/NetworkGroupAssignmentPostRequest.md index 1802f11..c39f2e9 100644 --- a/pkg/config-api-client/docs/NetworkGroupAssignmentPostRequest.md +++ b/pkg/config-api-client/docs/NetworkGroupAssignmentPostRequest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GroupId** | **string** | | -**NetworkId** | **string** | | +**GroupId** | **string** | The unique identifier of the group | +**NetworkId** | **string** | The unique identifier of the network | ## Methods diff --git a/pkg/config-api-client/docs/NetworkGroupAssignmentPostResponse.md b/pkg/config-api-client/docs/NetworkGroupAssignmentPostResponse.md index cc29be9..78f272f 100644 --- a/pkg/config-api-client/docs/NetworkGroupAssignmentPostResponse.md +++ b/pkg/config-api-client/docs/NetworkGroupAssignmentPostResponse.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the network group assignment | **Group** | [**NetworkGroupAssignmentPostGroup**](NetworkGroupAssignmentPostGroup.md) | | **Network** | [**NetworkGroupAssignmentPostNetwork**](NetworkGroupAssignmentPostNetwork.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/NetworkGroupAssignmentsGetGroup.md b/pkg/config-api-client/docs/NetworkGroupAssignmentsGetGroup.md index e672164..e211e97 100644 --- a/pkg/config-api-client/docs/NetworkGroupAssignmentsGetGroup.md +++ b/pkg/config-api-client/docs/NetworkGroupAssignmentsGetGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the group | ## Methods diff --git a/pkg/config-api-client/docs/NetworkGroupAssignmentsGetItem.md b/pkg/config-api-client/docs/NetworkGroupAssignmentsGetItem.md index e1eea44..411ba6c 100644 --- a/pkg/config-api-client/docs/NetworkGroupAssignmentsGetItem.md +++ b/pkg/config-api-client/docs/NetworkGroupAssignmentsGetItem.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the network group assignment | **Group** | [**NetworkGroupAssignmentsGetGroup**](NetworkGroupAssignmentsGetGroup.md) | | **Network** | [**NetworkGroupAssignmentsGetNetwork**](NetworkGroupAssignmentsGetNetwork.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/NetworkGroupAssignmentsGetNetwork.md b/pkg/config-api-client/docs/NetworkGroupAssignmentsGetNetwork.md index a9c8dd1..da9557f 100644 --- a/pkg/config-api-client/docs/NetworkGroupAssignmentsGetNetwork.md +++ b/pkg/config-api-client/docs/NetworkGroupAssignmentsGetNetwork.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the network | ## Methods diff --git a/pkg/config-api-client/docs/NetworkGroupAssignmentsGetResponse.md b/pkg/config-api-client/docs/NetworkGroupAssignmentsGetResponse.md index d4a9806..29ce9da 100644 --- a/pkg/config-api-client/docs/NetworkGroupAssignmentsGetResponse.md +++ b/pkg/config-api-client/docs/NetworkGroupAssignmentsGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]NetworkGroupAssignmentsGetItem**](NetworkGroupAssignmentsGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]NetworkGroupAssignmentsGetItem**](NetworkGroupAssignmentsGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/docs/SensorGroupAssignmentPostGroup.md b/pkg/config-api-client/docs/SensorGroupAssignmentPostGroup.md index 871d2ea..aec0ff5 100644 --- a/pkg/config-api-client/docs/SensorGroupAssignmentPostGroup.md +++ b/pkg/config-api-client/docs/SensorGroupAssignmentPostGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the group | ## Methods diff --git a/pkg/config-api-client/docs/SensorGroupAssignmentPostRequest.md b/pkg/config-api-client/docs/SensorGroupAssignmentPostRequest.md index 2a8b726..02277e5 100644 --- a/pkg/config-api-client/docs/SensorGroupAssignmentPostRequest.md +++ b/pkg/config-api-client/docs/SensorGroupAssignmentPostRequest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GroupId** | **string** | | -**SensorId** | **string** | | +**GroupId** | **string** | The unique identifier of the group | +**SensorId** | **string** | The unique identifier of the sensor | ## Methods diff --git a/pkg/config-api-client/docs/SensorGroupAssignmentPostResponse.md b/pkg/config-api-client/docs/SensorGroupAssignmentPostResponse.md index c92e8ce..9ddeb87 100644 --- a/pkg/config-api-client/docs/SensorGroupAssignmentPostResponse.md +++ b/pkg/config-api-client/docs/SensorGroupAssignmentPostResponse.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the sensor group assignment | **Group** | [**SensorGroupAssignmentPostGroup**](SensorGroupAssignmentPostGroup.md) | | **Sensor** | [**SensorGroupAssignmentPostSensor**](SensorGroupAssignmentPostSensor.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/SensorGroupAssignmentPostSensor.md b/pkg/config-api-client/docs/SensorGroupAssignmentPostSensor.md index 12fd379..1ed1301 100644 --- a/pkg/config-api-client/docs/SensorGroupAssignmentPostSensor.md +++ b/pkg/config-api-client/docs/SensorGroupAssignmentPostSensor.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the sensor | ## Methods diff --git a/pkg/config-api-client/docs/SensorGroupAssignmentsGetGroup.md b/pkg/config-api-client/docs/SensorGroupAssignmentsGetGroup.md index 6391506..92a7ce6 100644 --- a/pkg/config-api-client/docs/SensorGroupAssignmentsGetGroup.md +++ b/pkg/config-api-client/docs/SensorGroupAssignmentsGetGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the group | ## Methods diff --git a/pkg/config-api-client/docs/SensorGroupAssignmentsGetItem.md b/pkg/config-api-client/docs/SensorGroupAssignmentsGetItem.md index 070b8da..a04cf0f 100644 --- a/pkg/config-api-client/docs/SensorGroupAssignmentsGetItem.md +++ b/pkg/config-api-client/docs/SensorGroupAssignmentsGetItem.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the sensor group assignment | **Group** | [**SensorGroupAssignmentsGetGroup**](SensorGroupAssignmentsGetGroup.md) | | **Sensor** | [**SensorGroupAssignmentsGetSensor**](SensorGroupAssignmentsGetSensor.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/SensorGroupAssignmentsGetResponse.md b/pkg/config-api-client/docs/SensorGroupAssignmentsGetResponse.md index fa14fc7..9338da4 100644 --- a/pkg/config-api-client/docs/SensorGroupAssignmentsGetResponse.md +++ b/pkg/config-api-client/docs/SensorGroupAssignmentsGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]SensorGroupAssignmentsGetItem**](SensorGroupAssignmentsGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]SensorGroupAssignmentsGetItem**](SensorGroupAssignmentsGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/docs/SensorGroupAssignmentsGetSensor.md b/pkg/config-api-client/docs/SensorGroupAssignmentsGetSensor.md index 041bf3e..aed42a5 100644 --- a/pkg/config-api-client/docs/SensorGroupAssignmentsGetSensor.md +++ b/pkg/config-api-client/docs/SensorGroupAssignmentsGetSensor.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the sensor | ## Methods diff --git a/pkg/config-api-client/docs/SensorPatchRequest.md b/pkg/config-api-client/docs/SensorPatchRequest.md index 959c25a..05bb13a 100644 --- a/pkg/config-api-client/docs/SensorPatchRequest.md +++ b/pkg/config-api-client/docs/SensorPatchRequest.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | | [optional] -**AddressNote** | Pointer to **string** | | [optional] -**Notes** | Pointer to **string** | | [optional] +**Name** | Pointer to **string** | The updated sensor name | [optional] +**AddressNote** | Pointer to **string** | The updated address note for the sensor | [optional] +**Notes** | Pointer to **string** | Additional notes for the sensor | [optional] **PcapMode** | Pointer to [**SensorPcapMode**](SensorPcapMode.md) | | [optional] ## Methods diff --git a/pkg/config-api-client/docs/SensorPatchResponse.md b/pkg/config-api-client/docs/SensorPatchResponse.md index 3aee6e5..448893d 100644 --- a/pkg/config-api-client/docs/SensorPatchResponse.md +++ b/pkg/config-api-client/docs/SensorPatchResponse.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Serial** | **string** | | -**Name** | **string** | | -**ModelNumber** | **string** | | -**WifiMacAddress** | **NullableString** | | -**EthernetMacAddress** | **NullableString** | | -**AddressNote** | **NullableString** | | -**Longitude** | **NullableFloat32** | | -**Latitude** | **NullableFloat32** | | -**Notes** | **NullableString** | | +**Id** | **string** | The unique identifier of the sensor | +**Serial** | **string** | The serial number of the sensor | +**Name** | **string** | The name of the sensor | +**ModelNumber** | **string** | The model number of the sensor | +**WifiMacAddress** | **NullableString** | The WiFi MAC address of the sensor | +**EthernetMacAddress** | **NullableString** | The Ethernet MAC address of the sensor | +**AddressNote** | **NullableString** | The address note of the sensor | +**Longitude** | **NullableFloat32** | The longitude of the sensor | +**Latitude** | **NullableFloat32** | The latitude of the sensor | +**Notes** | **NullableString** | Additional notes for the sensor | **PcapMode** | [**NullableSensorPcapMode**](SensorPcapMode.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/SensorsGetItem.md b/pkg/config-api-client/docs/SensorsGetItem.md index ac64c6b..8097e5e 100644 --- a/pkg/config-api-client/docs/SensorsGetItem.md +++ b/pkg/config-api-client/docs/SensorsGetItem.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Serial** | **string** | | -**Name** | **string** | | -**ModelNumber** | **string** | | -**WifiMacAddress** | **NullableString** | | -**EthernetMacAddress** | **NullableString** | | -**AddressNote** | **NullableString** | | -**Longitude** | **NullableFloat32** | | -**Latitude** | **NullableFloat32** | | -**Notes** | **NullableString** | | +**Id** | **string** | The unique identifier of the sensor | +**Serial** | **string** | The serial number of the sensor | +**Name** | **string** | The name of the sensor | +**ModelNumber** | **string** | The model number of the sensor | +**WifiMacAddress** | **NullableString** | The WiFi MAC address of the sensor | +**EthernetMacAddress** | **NullableString** | The Ethernet MAC address of the sensor | +**AddressNote** | **NullableString** | The address note of the sensor | +**Longitude** | **NullableFloat32** | The longitude of the sensor | +**Latitude** | **NullableFloat32** | The latitude of the sensor | +**Notes** | **NullableString** | The notes of the sensor | **PcapMode** | [**NullableSensorPcapMode**](SensorPcapMode.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/SensorsGetResponse.md b/pkg/config-api-client/docs/SensorsGetResponse.md index fa8e476..09d306f 100644 --- a/pkg/config-api-client/docs/SensorsGetResponse.md +++ b/pkg/config-api-client/docs/SensorsGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]SensorsGetItem**](SensorsGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]SensorsGetItem**](SensorsGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostGroup.md b/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostGroup.md index 15de24c..29aa0f9 100644 --- a/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostGroup.md +++ b/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the group | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostRequest.md b/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostRequest.md index 8297008..73290f2 100644 --- a/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostRequest.md +++ b/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostRequest.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GroupId** | **string** | | -**ServiceTestId** | **string** | | +**GroupId** | **string** | The unique identifier of the group | +**ServiceTestId** | **string** | The unique identifier of the service test | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostResponse.md b/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostResponse.md index 371d921..2a3e46e 100644 --- a/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostResponse.md +++ b/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostResponse.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the service test group assignment | **Group** | [**ServiceTestGroupAssignmentPostGroup**](ServiceTestGroupAssignmentPostGroup.md) | | **ServiceTest** | [**ServiceTestGroupAssignmentPostServiceTest**](ServiceTestGroupAssignmentPostServiceTest.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostServiceTest.md b/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostServiceTest.md index c50f2be..bddb564 100644 --- a/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostServiceTest.md +++ b/pkg/config-api-client/docs/ServiceTestGroupAssignmentPostServiceTest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the service test | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetGroup.md b/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetGroup.md index e2a17e6..02daa76 100644 --- a/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetGroup.md +++ b/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the group | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetItem.md b/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetItem.md index 8f276b6..baeae7e 100644 --- a/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetItem.md +++ b/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetItem.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the service test group assignment | **Group** | [**ServiceTestGroupAssignmentsGetGroup**](ServiceTestGroupAssignmentsGetGroup.md) | | **ServiceTest** | [**ServiceTestGroupAssignmentsGetServiceTest**](ServiceTestGroupAssignmentsGetServiceTest.md) | | -**Type** | **string** | | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetResponse.md b/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetResponse.md index 172776b..e6151bf 100644 --- a/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetResponse.md +++ b/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]ServiceTestGroupAssignmentsGetItem**](ServiceTestGroupAssignmentsGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]ServiceTestGroupAssignmentsGetItem**](ServiceTestGroupAssignmentsGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetServiceTest.md b/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetServiceTest.md index e35e17f..0175708 100644 --- a/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetServiceTest.md +++ b/pkg/config-api-client/docs/ServiceTestGroupAssignmentsGetServiceTest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | +**Id** | **string** | The unique identifier of the service test | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestsGetItem.md b/pkg/config-api-client/docs/ServiceTestsGetItem.md index c3b1e7c..c256099 100644 --- a/pkg/config-api-client/docs/ServiceTestsGetItem.md +++ b/pkg/config-api-client/docs/ServiceTestsGetItem.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Category** | **string** | | -**Name** | **string** | | -**Target** | **NullableString** | | -**Template** | **string** | | -**IsEnabled** | **bool** | | -**Type** | **string** | | +**Id** | **string** | The unique identifier of the service test | +**Category** | **string** | The category of the service test | +**Name** | **string** | The name of the service test | +**Target** | **NullableString** | The target of the service test | +**Template** | **string** | The template of the service test | +**IsEnabled** | **bool** | Indicates if the service test is enabled | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/ServiceTestsGetResponse.md b/pkg/config-api-client/docs/ServiceTestsGetResponse.md index 691f050..8b86a60 100644 --- a/pkg/config-api-client/docs/ServiceTestsGetResponse.md +++ b/pkg/config-api-client/docs/ServiceTestsGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]ServiceTestsGetItem**](ServiceTestsGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]ServiceTestsGetItem**](ServiceTestsGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/docs/WiredNetworksGetItem.md b/pkg/config-api-client/docs/WiredNetworksGetItem.md index baf0d86..2f8307e 100644 --- a/pkg/config-api-client/docs/WiredNetworksGetItem.md +++ b/pkg/config-api-client/docs/WiredNetworksGetItem.md @@ -4,18 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Name** | **string** | | +**Id** | **string** | The unique identifier of the wired network | +**Name** | **string** | The name of the wired network | **IpVersion** | [**IpVersion**](IpVersion.md) | | -**CreatedAt** | **time.Time** | | -**UpdatedAt** | **time.Time** | | -**Security** | **NullableString** | | -**DnsLookupDomain** | **NullableString** | | -**DisableEdns** | **bool** | | -**UseDns64** | **bool** | | -**ExternalConnectivity** | **bool** | | -**VLanId** | **NullableInt32** | | -**Type** | **string** | | +**CreatedAt** | **time.Time** | The creation timestamp of the wired network | +**UpdatedAt** | **time.Time** | The last update timestamp of the wired network | +**Security** | **NullableString** | The security settings of the wired network | +**DnsLookupDomain** | **NullableString** | The DNS lookup domain of the wired network | +**DisableEdns** | **bool** | Whether EDNS is disabled for the wired network | +**UseDns64** | **bool** | Whether DNS64 is used for the wired network | +**ExternalConnectivity** | **bool** | Whether the wired network has external connectivity | +**VLanId** | **NullableInt32** | The VLAN ID of the wired network | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/WiredNetworksGetResponse.md b/pkg/config-api-client/docs/WiredNetworksGetResponse.md index 58f1edb..bb1129e 100644 --- a/pkg/config-api-client/docs/WiredNetworksGetResponse.md +++ b/pkg/config-api-client/docs/WiredNetworksGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]WiredNetworksGetItem**](WiredNetworksGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]WiredNetworksGetItem**](WiredNetworksGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/docs/WirelessNetworksGetItem.md b/pkg/config-api-client/docs/WirelessNetworksGetItem.md index 0edf0e2..541d128 100644 --- a/pkg/config-api-client/docs/WirelessNetworksGetItem.md +++ b/pkg/config-api-client/docs/WirelessNetworksGetItem.md @@ -4,20 +4,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | | -**Name** | **string** | | -**Ssid** | **string** | | -**Security** | **NullableString** | | +**Id** | **string** | The unique identifier of the wireless network | +**Name** | **string** | The name of the wireless network | +**Ssid** | **string** | The SSID of the wireless network | +**Security** | **NullableString** | The security type of the wireless network | **IpVersion** | [**IpVersion**](IpVersion.md) | | -**CreatedAt** | **time.Time** | | -**UpdatedAt** | **time.Time** | | -**Hidden** | **bool** | | -**BandLocking** | **string** | | -**DnsLookupDomain** | **NullableString** | | -**DisableEdns** | **bool** | | -**UseDns64** | **bool** | | -**ExternalConnectivity** | **bool** | | -**Type** | **string** | | +**CreatedAt** | **time.Time** | The creation timestamp of the wireless network | +**UpdatedAt** | **time.Time** | The last update timestamp of the wireless network | +**Hidden** | **bool** | Whether the wireless network is hidden | +**BandLocking** | **string** | The band locking setting of the wireless network | +**DnsLookupDomain** | **NullableString** | The DNS lookup domain of the wireless network | +**DisableEdns** | **bool** | Whether EDNS is disabled for the wireless network | +**UseDns64** | **bool** | Whether DNS64 is used for the wireless network | +**ExternalConnectivity** | **bool** | Whether the wireless network has external connectivity | +**Type** | **string** | The type of the resource. | ## Methods diff --git a/pkg/config-api-client/docs/WirelessNetworksGetResponse.md b/pkg/config-api-client/docs/WirelessNetworksGetResponse.md index 6151715..220c09d 100644 --- a/pkg/config-api-client/docs/WirelessNetworksGetResponse.md +++ b/pkg/config-api-client/docs/WirelessNetworksGetResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Items** | [**[]WirelessNetworksGetItem**](WirelessNetworksGetItem.md) | | -**Count** | **int32** | | -**Next** | **NullableString** | | +**Items** | [**[]WirelessNetworksGetItem**](WirelessNetworksGetItem.md) | The list of resources. | +**Count** | **int32** | The number of resources returned in the response. | +**Next** | **NullableString** | The next cursor for pagination. | ## Methods diff --git a/pkg/config-api-client/model_agent_group_assignment_post_agent.go b/pkg/config-api-client/model_agent_group_assignment_post_agent.go index 8a21ad8..f5e181e 100644 --- a/pkg/config-api-client/model_agent_group_assignment_post_agent.go +++ b/pkg/config-api-client/model_agent_group_assignment_post_agent.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &AgentGroupAssignmentPostAgent{} // AgentGroupAssignmentPostAgent struct for AgentGroupAssignmentPostAgent type AgentGroupAssignmentPostAgent struct { + // The unique identifier of the agent Id string `json:"id"` } diff --git a/pkg/config-api-client/model_agent_group_assignment_post_group.go b/pkg/config-api-client/model_agent_group_assignment_post_group.go index 48bc96e..d204723 100644 --- a/pkg/config-api-client/model_agent_group_assignment_post_group.go +++ b/pkg/config-api-client/model_agent_group_assignment_post_group.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &AgentGroupAssignmentPostGroup{} // AgentGroupAssignmentPostGroup struct for AgentGroupAssignmentPostGroup type AgentGroupAssignmentPostGroup struct { + // The unique identifier of the group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_agent_group_assignment_post_request.go b/pkg/config-api-client/model_agent_group_assignment_post_request.go index 6a7eea4..31795ec 100644 --- a/pkg/config-api-client/model_agent_group_assignment_post_request.go +++ b/pkg/config-api-client/model_agent_group_assignment_post_request.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,7 +26,9 @@ var _ MappedNullable = &AgentGroupAssignmentPostRequest{} // AgentGroupAssignmentPostRequest struct for AgentGroupAssignmentPostRequest type AgentGroupAssignmentPostRequest struct { + // The unique identifier of the group GroupId string `json:"groupId"` + // The unique identifier of the agent AgentId string `json:"agentId"` } diff --git a/pkg/config-api-client/model_agent_group_assignment_post_response.go b/pkg/config-api-client/model_agent_group_assignment_post_response.go index 666576a..ba1598f 100644 --- a/pkg/config-api-client/model_agent_group_assignment_post_response.go +++ b/pkg/config-api-client/model_agent_group_assignment_post_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,10 +26,12 @@ var _ MappedNullable = &AgentGroupAssignmentPostResponse{} // AgentGroupAssignmentPostResponse struct for AgentGroupAssignmentPostResponse type AgentGroupAssignmentPostResponse struct { + // The unique identifier of the agent group assignment Id string `json:"id"` Group AgentGroupAssignmentPostGroup `json:"group"` Agent AgentGroupAssignmentPostAgent `json:"agent"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _AgentGroupAssignmentPostResponse AgentGroupAssignmentPostResponse diff --git a/pkg/config-api-client/model_agent_group_assignments_get_agent.go b/pkg/config-api-client/model_agent_group_assignments_get_agent.go index 950ff30..b66b527 100644 --- a/pkg/config-api-client/model_agent_group_assignments_get_agent.go +++ b/pkg/config-api-client/model_agent_group_assignments_get_agent.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &AgentGroupAssignmentsGetAgent{} // AgentGroupAssignmentsGetAgent struct for AgentGroupAssignmentsGetAgent type AgentGroupAssignmentsGetAgent struct { + // The unique identifier of the agent Id string `json:"id"` } diff --git a/pkg/config-api-client/model_agent_group_assignments_get_group.go b/pkg/config-api-client/model_agent_group_assignments_get_group.go index 2cc4640..fb79776 100644 --- a/pkg/config-api-client/model_agent_group_assignments_get_group.go +++ b/pkg/config-api-client/model_agent_group_assignments_get_group.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &AgentGroupAssignmentsGetGroup{} // AgentGroupAssignmentsGetGroup struct for AgentGroupAssignmentsGetGroup type AgentGroupAssignmentsGetGroup struct { + // The unique identifier of the group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_agent_group_assignments_get_item.go b/pkg/config-api-client/model_agent_group_assignments_get_item.go index 7f43ad1..5154070 100644 --- a/pkg/config-api-client/model_agent_group_assignments_get_item.go +++ b/pkg/config-api-client/model_agent_group_assignments_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,10 +26,12 @@ var _ MappedNullable = &AgentGroupAssignmentsGetItem{} // AgentGroupAssignmentsGetItem struct for AgentGroupAssignmentsGetItem type AgentGroupAssignmentsGetItem struct { + // The unique identifier of the agent group assignment Id string `json:"id"` Group AgentGroupAssignmentsGetGroup `json:"group"` Agent AgentGroupAssignmentsGetAgent `json:"agent"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _AgentGroupAssignmentsGetItem AgentGroupAssignmentsGetItem diff --git a/pkg/config-api-client/model_agent_group_assignments_get_response.go b/pkg/config-api-client/model_agent_group_assignments_get_response.go index b86f171..0197873 100644 --- a/pkg/config-api-client/model_agent_group_assignments_get_response.go +++ b/pkg/config-api-client/model_agent_group_assignments_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &AgentGroupAssignmentsGetResponse{} // AgentGroupAssignmentsGetResponse struct for AgentGroupAssignmentsGetResponse type AgentGroupAssignmentsGetResponse struct { + // The list of resources. Items []AgentGroupAssignmentsGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _AgentGroupAssignmentsGetResponse AgentGroupAssignmentsGetResponse diff --git a/pkg/config-api-client/model_agent_patch_request.go b/pkg/config-api-client/model_agent_patch_request.go index 360c348..1f919f3 100644 --- a/pkg/config-api-client/model_agent_patch_request.go +++ b/pkg/config-api-client/model_agent_patch_request.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -24,7 +24,9 @@ var _ MappedNullable = &AgentPatchRequest{} // AgentPatchRequest Request body for patching an agent. type AgentPatchRequest struct { - Name *string `json:"name,omitempty"` + // The name of the agent + Name *string `json:"name,omitempty"` + // The notes of the agent Notes *string `json:"notes,omitempty"` PcapMode *AgentPcapMode `json:"pcapMode,omitempty"` } diff --git a/pkg/config-api-client/model_agent_patch_response.go b/pkg/config-api-client/model_agent_patch_response.go index bd6ffa8..72d851d 100644 --- a/pkg/config-api-client/model_agent_patch_response.go +++ b/pkg/config-api-client/model_agent_patch_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,15 +26,23 @@ var _ MappedNullable = &AgentPatchResponse{} // AgentPatchResponse struct for AgentPatchResponse type AgentPatchResponse struct { - Id string `json:"id"` - Serial string `json:"serial"` - Name string `json:"name"` - ModelNumber NullableString `json:"modelNumber"` - WifiMacAddress NullableString `json:"wifiMacAddress"` - EthernetMacAddress NullableString `json:"ethernetMacAddress"` - Notes NullableString `json:"notes"` - PcapMode NullableAgentPcapMode `json:"pcapMode"` - Type string `json:"type"` + // The unique identifier of the agent + Id string `json:"id"` + // The serial number of the agent + Serial string `json:"serial"` + // The name of the agent + Name string `json:"name"` + // The model number of the agent + ModelNumber NullableString `json:"modelNumber"` + // The WiFi MAC address of the agent + WifiMacAddress NullableString `json:"wifiMacAddress"` + // The Ethernet MAC address of the agent + EthernetMacAddress NullableString `json:"ethernetMacAddress"` + // The notes of the agent + Notes NullableString `json:"notes"` + PcapMode NullableAgentPcapMode `json:"pcapMode"` + // The type of the resource. + Type string `json:"type"` } type _AgentPatchResponse AgentPatchResponse diff --git a/pkg/config-api-client/model_agent_pcap_mode.go b/pkg/config-api-client/model_agent_pcap_mode.go index 60b7b50..8600451 100644 --- a/pkg/config-api-client/model_agent_pcap_mode.go +++ b/pkg/config-api-client/model_agent_pcap_mode.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ diff --git a/pkg/config-api-client/model_agents_get_item.go b/pkg/config-api-client/model_agents_get_item.go index f92050f..b104281 100644 --- a/pkg/config-api-client/model_agents_get_item.go +++ b/pkg/config-api-client/model_agents_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,15 +26,23 @@ var _ MappedNullable = &AgentsGetItem{} // AgentsGetItem struct for AgentsGetItem type AgentsGetItem struct { - Id string `json:"id"` - Serial string `json:"serial"` - Name string `json:"name"` - ModelNumber NullableString `json:"modelNumber"` - WifiMacAddress NullableString `json:"wifiMacAddress"` - EthernetMacAddress NullableString `json:"ethernetMacAddress"` - Notes NullableString `json:"notes"` - PcapMode NullableAgentPcapMode `json:"pcapMode"` - Type string `json:"type"` + // The unique identifier of the agent + Id string `json:"id"` + // The serial number of the agent + Serial string `json:"serial"` + // The name of the agent + Name string `json:"name"` + // The model number of the agent + ModelNumber NullableString `json:"modelNumber"` + // The WiFi MAC address of the agent + WifiMacAddress NullableString `json:"wifiMacAddress"` + // The Ethernet MAC address of the agent + EthernetMacAddress NullableString `json:"ethernetMacAddress"` + // The notes of the agent + Notes NullableString `json:"notes"` + PcapMode NullableAgentPcapMode `json:"pcapMode"` + // The type of the resource. + Type string `json:"type"` } type _AgentsGetItem AgentsGetItem diff --git a/pkg/config-api-client/model_agents_get_response.go b/pkg/config-api-client/model_agents_get_response.go index 544b253..1a00f75 100644 --- a/pkg/config-api-client/model_agents_get_response.go +++ b/pkg/config-api-client/model_agents_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &AgentsGetResponse{} // AgentsGetResponse struct for AgentsGetResponse type AgentsGetResponse struct { + // The list of resources. Items []AgentsGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _AgentsGetResponse AgentsGetResponse diff --git a/pkg/config-api-client/model_error_detail.go b/pkg/config-api-client/model_error_detail.go index 9912f67..c4a83b8 100644 --- a/pkg/config-api-client/model_error_detail.go +++ b/pkg/config-api-client/model_error_detail.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ diff --git a/pkg/config-api-client/model_error_response.go b/pkg/config-api-client/model_error_response.go index 908beca..3c6c4d2 100644 --- a/pkg/config-api-client/model_error_response.go +++ b/pkg/config-api-client/model_error_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ diff --git a/pkg/config-api-client/model_group_patch_parent.go b/pkg/config-api-client/model_group_patch_parent.go index cdcfc15..3abb4d7 100644 --- a/pkg/config-api-client/model_group_patch_parent.go +++ b/pkg/config-api-client/model_group_patch_parent.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &GroupPatchParent{} // GroupPatchParent struct for GroupPatchParent type GroupPatchParent struct { + // The unique identifier of the parent group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_group_patch_request.go b/pkg/config-api-client/model_group_patch_request.go index e97bf38..14ec8de 100644 --- a/pkg/config-api-client/model_group_patch_request.go +++ b/pkg/config-api-client/model_group_patch_request.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -24,6 +24,7 @@ var _ MappedNullable = &GroupPatchRequest{} // GroupPatchRequest struct for GroupPatchRequest type GroupPatchRequest struct { + // The updated group name Name *string `json:"name,omitempty"` } diff --git a/pkg/config-api-client/model_group_patch_response.go b/pkg/config-api-client/model_group_patch_response.go index ba5505f..4ca0ad1 100644 --- a/pkg/config-api-client/model_group_patch_response.go +++ b/pkg/config-api-client/model_group_patch_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,11 +26,15 @@ var _ MappedNullable = &GroupPatchResponse{} // GroupPatchResponse struct for GroupPatchResponse type GroupPatchResponse struct { - Id string `json:"id"` - Name string `json:"name"` + // The unique identifier of the group + Id string `json:"id"` + // The name of the group + Name string `json:"name"` + // The path of the group Path string `json:"path"` Parent GroupPatchParent `json:"parent"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _GroupPatchResponse GroupPatchResponse diff --git a/pkg/config-api-client/model_group_post_parent.go b/pkg/config-api-client/model_group_post_parent.go index 2c26652..960e003 100644 --- a/pkg/config-api-client/model_group_post_parent.go +++ b/pkg/config-api-client/model_group_post_parent.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &GroupPostParent{} // GroupPostParent struct for GroupPostParent type GroupPostParent struct { + // The unique identifier of the parent group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_group_post_request.go b/pkg/config-api-client/model_group_post_request.go index d040e44..5deefd6 100644 --- a/pkg/config-api-client/model_group_post_request.go +++ b/pkg/config-api-client/model_group_post_request.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,8 +26,10 @@ var _ MappedNullable = &GroupPostRequest{} // GroupPostRequest struct for GroupPostRequest type GroupPostRequest struct { + // The unique identifier of the parent group ParentId NullableString `json:"parentId,omitempty"` - Name string `json:"name"` + // The name of the group + Name string `json:"name"` } type _GroupPostRequest GroupPostRequest diff --git a/pkg/config-api-client/model_group_post_response.go b/pkg/config-api-client/model_group_post_response.go index 691f9a0..4721d50 100644 --- a/pkg/config-api-client/model_group_post_response.go +++ b/pkg/config-api-client/model_group_post_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,11 +26,15 @@ var _ MappedNullable = &GroupPostResponse{} // GroupPostResponse struct for GroupPostResponse type GroupPostResponse struct { - Id string `json:"id"` - Name string `json:"name"` + // The unique identifier of the group + Id string `json:"id"` + // The name of the group + Name string `json:"name"` + // The path of the group Path string `json:"path"` Parent GroupPostParent `json:"parent"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _GroupPostResponse GroupPostResponse diff --git a/pkg/config-api-client/model_groups_get_item.go b/pkg/config-api-client/model_groups_get_item.go index 7d4f846..169cf58 100644 --- a/pkg/config-api-client/model_groups_get_item.go +++ b/pkg/config-api-client/model_groups_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,11 +26,15 @@ var _ MappedNullable = &GroupsGetItem{} // GroupsGetItem struct for GroupsGetItem type GroupsGetItem struct { - Id string `json:"id"` + // The unique identifier of the group + Id string `json:"id"` + // The name of the group Name string `json:"name"` Parent NullableGroupsGetParent `json:"parent"` - Path string `json:"path"` - Type string `json:"type"` + // The path of the group + Path string `json:"path"` + // The type of the resource. + Type string `json:"type"` } type _GroupsGetItem GroupsGetItem diff --git a/pkg/config-api-client/model_groups_get_parent.go b/pkg/config-api-client/model_groups_get_parent.go index 1b02208..472a97a 100644 --- a/pkg/config-api-client/model_groups_get_parent.go +++ b/pkg/config-api-client/model_groups_get_parent.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &GroupsGetParent{} // GroupsGetParent struct for GroupsGetParent type GroupsGetParent struct { + // The unique identifier of the parent group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_groups_get_response.go b/pkg/config-api-client/model_groups_get_response.go index cda7271..111ed0c 100644 --- a/pkg/config-api-client/model_groups_get_response.go +++ b/pkg/config-api-client/model_groups_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &GroupsGetResponse{} // GroupsGetResponse struct for GroupsGetResponse type GroupsGetResponse struct { + // The list of resources. Items []GroupsGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _GroupsGetResponse GroupsGetResponse diff --git a/pkg/config-api-client/model_ip_version.go b/pkg/config-api-client/model_ip_version.go index 8c82bf5..f4cef5d 100644 --- a/pkg/config-api-client/model_ip_version.go +++ b/pkg/config-api-client/model_ip_version.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ diff --git a/pkg/config-api-client/model_issue.go b/pkg/config-api-client/model_issue.go index 690d660..a84ca7a 100644 --- a/pkg/config-api-client/model_issue.go +++ b/pkg/config-api-client/model_issue.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ diff --git a/pkg/config-api-client/model_issue_subject.go b/pkg/config-api-client/model_issue_subject.go index 582cfbf..6ff8a89 100644 --- a/pkg/config-api-client/model_issue_subject.go +++ b/pkg/config-api-client/model_issue_subject.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ diff --git a/pkg/config-api-client/model_network_group_assignment_post_group.go b/pkg/config-api-client/model_network_group_assignment_post_group.go index aca4c75..483e3f2 100644 --- a/pkg/config-api-client/model_network_group_assignment_post_group.go +++ b/pkg/config-api-client/model_network_group_assignment_post_group.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &NetworkGroupAssignmentPostGroup{} // NetworkGroupAssignmentPostGroup struct for NetworkGroupAssignmentPostGroup type NetworkGroupAssignmentPostGroup struct { + // The unique identifier of the group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_network_group_assignment_post_network.go b/pkg/config-api-client/model_network_group_assignment_post_network.go index ed9b8b2..a4ace38 100644 --- a/pkg/config-api-client/model_network_group_assignment_post_network.go +++ b/pkg/config-api-client/model_network_group_assignment_post_network.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &NetworkGroupAssignmentPostNetwork{} // NetworkGroupAssignmentPostNetwork struct for NetworkGroupAssignmentPostNetwork type NetworkGroupAssignmentPostNetwork struct { + // The unique identifier of the network Id string `json:"id"` } diff --git a/pkg/config-api-client/model_network_group_assignment_post_request.go b/pkg/config-api-client/model_network_group_assignment_post_request.go index c6fb11f..828113b 100644 --- a/pkg/config-api-client/model_network_group_assignment_post_request.go +++ b/pkg/config-api-client/model_network_group_assignment_post_request.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,7 +26,9 @@ var _ MappedNullable = &NetworkGroupAssignmentPostRequest{} // NetworkGroupAssignmentPostRequest struct for NetworkGroupAssignmentPostRequest type NetworkGroupAssignmentPostRequest struct { - GroupId string `json:"groupId"` + // The unique identifier of the group + GroupId string `json:"groupId"` + // The unique identifier of the network NetworkId string `json:"networkId"` } diff --git a/pkg/config-api-client/model_network_group_assignment_post_response.go b/pkg/config-api-client/model_network_group_assignment_post_response.go index 3a13389..1dee289 100644 --- a/pkg/config-api-client/model_network_group_assignment_post_response.go +++ b/pkg/config-api-client/model_network_group_assignment_post_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,10 +26,12 @@ var _ MappedNullable = &NetworkGroupAssignmentPostResponse{} // NetworkGroupAssignmentPostResponse struct for NetworkGroupAssignmentPostResponse type NetworkGroupAssignmentPostResponse struct { + // The unique identifier of the network group assignment Id string `json:"id"` Group NetworkGroupAssignmentPostGroup `json:"group"` Network NetworkGroupAssignmentPostNetwork `json:"network"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _NetworkGroupAssignmentPostResponse NetworkGroupAssignmentPostResponse diff --git a/pkg/config-api-client/model_network_group_assignments_get_group.go b/pkg/config-api-client/model_network_group_assignments_get_group.go index 12f7001..eef3fd9 100644 --- a/pkg/config-api-client/model_network_group_assignments_get_group.go +++ b/pkg/config-api-client/model_network_group_assignments_get_group.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &NetworkGroupAssignmentsGetGroup{} // NetworkGroupAssignmentsGetGroup struct for NetworkGroupAssignmentsGetGroup type NetworkGroupAssignmentsGetGroup struct { + // The unique identifier of the group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_network_group_assignments_get_item.go b/pkg/config-api-client/model_network_group_assignments_get_item.go index 3aaebdf..12838ff 100644 --- a/pkg/config-api-client/model_network_group_assignments_get_item.go +++ b/pkg/config-api-client/model_network_group_assignments_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,10 +26,12 @@ var _ MappedNullable = &NetworkGroupAssignmentsGetItem{} // NetworkGroupAssignmentsGetItem struct for NetworkGroupAssignmentsGetItem type NetworkGroupAssignmentsGetItem struct { + // The unique identifier of the network group assignment Id string `json:"id"` Group NetworkGroupAssignmentsGetGroup `json:"group"` Network NetworkGroupAssignmentsGetNetwork `json:"network"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _NetworkGroupAssignmentsGetItem NetworkGroupAssignmentsGetItem diff --git a/pkg/config-api-client/model_network_group_assignments_get_network.go b/pkg/config-api-client/model_network_group_assignments_get_network.go index 36e078a..ca4e8f5 100644 --- a/pkg/config-api-client/model_network_group_assignments_get_network.go +++ b/pkg/config-api-client/model_network_group_assignments_get_network.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &NetworkGroupAssignmentsGetNetwork{} // NetworkGroupAssignmentsGetNetwork struct for NetworkGroupAssignmentsGetNetwork type NetworkGroupAssignmentsGetNetwork struct { + // The unique identifier of the network Id string `json:"id"` } diff --git a/pkg/config-api-client/model_network_group_assignments_get_response.go b/pkg/config-api-client/model_network_group_assignments_get_response.go index d9c581c..3efc894 100644 --- a/pkg/config-api-client/model_network_group_assignments_get_response.go +++ b/pkg/config-api-client/model_network_group_assignments_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &NetworkGroupAssignmentsGetResponse{} // NetworkGroupAssignmentsGetResponse struct for NetworkGroupAssignmentsGetResponse type NetworkGroupAssignmentsGetResponse struct { + // The list of resources. Items []NetworkGroupAssignmentsGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _NetworkGroupAssignmentsGetResponse NetworkGroupAssignmentsGetResponse diff --git a/pkg/config-api-client/model_sensor_group_assignment_post_group.go b/pkg/config-api-client/model_sensor_group_assignment_post_group.go index d546ded..e4a9137 100644 --- a/pkg/config-api-client/model_sensor_group_assignment_post_group.go +++ b/pkg/config-api-client/model_sensor_group_assignment_post_group.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &SensorGroupAssignmentPostGroup{} // SensorGroupAssignmentPostGroup struct for SensorGroupAssignmentPostGroup type SensorGroupAssignmentPostGroup struct { + // The unique identifier of the group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_sensor_group_assignment_post_request.go b/pkg/config-api-client/model_sensor_group_assignment_post_request.go index 50e73ba..89bc5eb 100644 --- a/pkg/config-api-client/model_sensor_group_assignment_post_request.go +++ b/pkg/config-api-client/model_sensor_group_assignment_post_request.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,7 +26,9 @@ var _ MappedNullable = &SensorGroupAssignmentPostRequest{} // SensorGroupAssignmentPostRequest struct for SensorGroupAssignmentPostRequest type SensorGroupAssignmentPostRequest struct { - GroupId string `json:"groupId"` + // The unique identifier of the group + GroupId string `json:"groupId"` + // The unique identifier of the sensor SensorId string `json:"sensorId"` } diff --git a/pkg/config-api-client/model_sensor_group_assignment_post_response.go b/pkg/config-api-client/model_sensor_group_assignment_post_response.go index 765a1d1..e6dc352 100644 --- a/pkg/config-api-client/model_sensor_group_assignment_post_response.go +++ b/pkg/config-api-client/model_sensor_group_assignment_post_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,10 +26,12 @@ var _ MappedNullable = &SensorGroupAssignmentPostResponse{} // SensorGroupAssignmentPostResponse struct for SensorGroupAssignmentPostResponse type SensorGroupAssignmentPostResponse struct { + // The unique identifier of the sensor group assignment Id string `json:"id"` Group SensorGroupAssignmentPostGroup `json:"group"` Sensor SensorGroupAssignmentPostSensor `json:"sensor"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _SensorGroupAssignmentPostResponse SensorGroupAssignmentPostResponse diff --git a/pkg/config-api-client/model_sensor_group_assignment_post_sensor.go b/pkg/config-api-client/model_sensor_group_assignment_post_sensor.go index 99a9b0b..701080a 100644 --- a/pkg/config-api-client/model_sensor_group_assignment_post_sensor.go +++ b/pkg/config-api-client/model_sensor_group_assignment_post_sensor.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &SensorGroupAssignmentPostSensor{} // SensorGroupAssignmentPostSensor struct for SensorGroupAssignmentPostSensor type SensorGroupAssignmentPostSensor struct { + // The unique identifier of the sensor Id string `json:"id"` } diff --git a/pkg/config-api-client/model_sensor_group_assignments_get_group.go b/pkg/config-api-client/model_sensor_group_assignments_get_group.go index 2db26d4..fcc04e8 100644 --- a/pkg/config-api-client/model_sensor_group_assignments_get_group.go +++ b/pkg/config-api-client/model_sensor_group_assignments_get_group.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &SensorGroupAssignmentsGetGroup{} // SensorGroupAssignmentsGetGroup struct for SensorGroupAssignmentsGetGroup type SensorGroupAssignmentsGetGroup struct { + // The unique identifier of the group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_sensor_group_assignments_get_item.go b/pkg/config-api-client/model_sensor_group_assignments_get_item.go index 625db74..3a9753a 100644 --- a/pkg/config-api-client/model_sensor_group_assignments_get_item.go +++ b/pkg/config-api-client/model_sensor_group_assignments_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,10 +26,12 @@ var _ MappedNullable = &SensorGroupAssignmentsGetItem{} // SensorGroupAssignmentsGetItem struct for SensorGroupAssignmentsGetItem type SensorGroupAssignmentsGetItem struct { + // The unique identifier of the sensor group assignment Id string `json:"id"` Group SensorGroupAssignmentsGetGroup `json:"group"` Sensor SensorGroupAssignmentsGetSensor `json:"sensor"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _SensorGroupAssignmentsGetItem SensorGroupAssignmentsGetItem diff --git a/pkg/config-api-client/model_sensor_group_assignments_get_response.go b/pkg/config-api-client/model_sensor_group_assignments_get_response.go index e6465e2..d7101eb 100644 --- a/pkg/config-api-client/model_sensor_group_assignments_get_response.go +++ b/pkg/config-api-client/model_sensor_group_assignments_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &SensorGroupAssignmentsGetResponse{} // SensorGroupAssignmentsGetResponse struct for SensorGroupAssignmentsGetResponse type SensorGroupAssignmentsGetResponse struct { + // The list of resources. Items []SensorGroupAssignmentsGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _SensorGroupAssignmentsGetResponse SensorGroupAssignmentsGetResponse diff --git a/pkg/config-api-client/model_sensor_group_assignments_get_sensor.go b/pkg/config-api-client/model_sensor_group_assignments_get_sensor.go index 8db865e..970ed96 100644 --- a/pkg/config-api-client/model_sensor_group_assignments_get_sensor.go +++ b/pkg/config-api-client/model_sensor_group_assignments_get_sensor.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &SensorGroupAssignmentsGetSensor{} // SensorGroupAssignmentsGetSensor struct for SensorGroupAssignmentsGetSensor type SensorGroupAssignmentsGetSensor struct { + // The unique identifier of the sensor Id string `json:"id"` } diff --git a/pkg/config-api-client/model_sensor_patch_request.go b/pkg/config-api-client/model_sensor_patch_request.go index 12bb11b..a512d63 100644 --- a/pkg/config-api-client/model_sensor_patch_request.go +++ b/pkg/config-api-client/model_sensor_patch_request.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -24,10 +24,13 @@ var _ MappedNullable = &SensorPatchRequest{} // SensorPatchRequest Request body for patching a sensor. type SensorPatchRequest struct { - Name *string `json:"name,omitempty"` - AddressNote *string `json:"addressNote,omitempty"` - Notes *string `json:"notes,omitempty"` - PcapMode *SensorPcapMode `json:"pcapMode,omitempty"` + // The updated sensor name + Name *string `json:"name,omitempty"` + // The updated address note for the sensor + AddressNote *string `json:"addressNote,omitempty"` + // Additional notes for the sensor + Notes *string `json:"notes,omitempty"` + PcapMode *SensorPcapMode `json:"pcapMode,omitempty"` } // NewSensorPatchRequest instantiates a new SensorPatchRequest object diff --git a/pkg/config-api-client/model_sensor_patch_response.go b/pkg/config-api-client/model_sensor_patch_response.go index 2608303..c6d2347 100644 --- a/pkg/config-api-client/model_sensor_patch_response.go +++ b/pkg/config-api-client/model_sensor_patch_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,18 +26,29 @@ var _ MappedNullable = &SensorPatchResponse{} // SensorPatchResponse struct for SensorPatchResponse type SensorPatchResponse struct { - Id string `json:"id"` - Serial string `json:"serial"` - Name string `json:"name"` - ModelNumber string `json:"modelNumber"` - WifiMacAddress NullableString `json:"wifiMacAddress"` - EthernetMacAddress NullableString `json:"ethernetMacAddress"` - AddressNote NullableString `json:"addressNote"` - Longitude NullableFloat32 `json:"longitude"` - Latitude NullableFloat32 `json:"latitude"` - Notes NullableString `json:"notes"` - PcapMode NullableSensorPcapMode `json:"pcapMode"` - Type string `json:"type"` + // The unique identifier of the sensor + Id string `json:"id"` + // The serial number of the sensor + Serial string `json:"serial"` + // The name of the sensor + Name string `json:"name"` + // The model number of the sensor + ModelNumber string `json:"modelNumber"` + // The WiFi MAC address of the sensor + WifiMacAddress NullableString `json:"wifiMacAddress"` + // The Ethernet MAC address of the sensor + EthernetMacAddress NullableString `json:"ethernetMacAddress"` + // The address note of the sensor + AddressNote NullableString `json:"addressNote"` + // The longitude of the sensor + Longitude NullableFloat32 `json:"longitude"` + // The latitude of the sensor + Latitude NullableFloat32 `json:"latitude"` + // Additional notes for the sensor + Notes NullableString `json:"notes"` + PcapMode NullableSensorPcapMode `json:"pcapMode"` + // The type of the resource. + Type string `json:"type"` } type _SensorPatchResponse SensorPatchResponse diff --git a/pkg/config-api-client/model_sensor_pcap_mode.go b/pkg/config-api-client/model_sensor_pcap_mode.go index 9dfe3ca..f6cb3bb 100644 --- a/pkg/config-api-client/model_sensor_pcap_mode.go +++ b/pkg/config-api-client/model_sensor_pcap_mode.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ diff --git a/pkg/config-api-client/model_sensors_get_item.go b/pkg/config-api-client/model_sensors_get_item.go index 8972542..42a8461 100644 --- a/pkg/config-api-client/model_sensors_get_item.go +++ b/pkg/config-api-client/model_sensors_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,18 +26,29 @@ var _ MappedNullable = &SensorsGetItem{} // SensorsGetItem struct for SensorsGetItem type SensorsGetItem struct { - Id string `json:"id"` - Serial string `json:"serial"` - Name string `json:"name"` - ModelNumber string `json:"modelNumber"` - WifiMacAddress NullableString `json:"wifiMacAddress"` - EthernetMacAddress NullableString `json:"ethernetMacAddress"` - AddressNote NullableString `json:"addressNote"` - Longitude NullableFloat32 `json:"longitude"` - Latitude NullableFloat32 `json:"latitude"` - Notes NullableString `json:"notes"` - PcapMode NullableSensorPcapMode `json:"pcapMode"` - Type string `json:"type"` + // The unique identifier of the sensor + Id string `json:"id"` + // The serial number of the sensor + Serial string `json:"serial"` + // The name of the sensor + Name string `json:"name"` + // The model number of the sensor + ModelNumber string `json:"modelNumber"` + // The WiFi MAC address of the sensor + WifiMacAddress NullableString `json:"wifiMacAddress"` + // The Ethernet MAC address of the sensor + EthernetMacAddress NullableString `json:"ethernetMacAddress"` + // The address note of the sensor + AddressNote NullableString `json:"addressNote"` + // The longitude of the sensor + Longitude NullableFloat32 `json:"longitude"` + // The latitude of the sensor + Latitude NullableFloat32 `json:"latitude"` + // The notes of the sensor + Notes NullableString `json:"notes"` + PcapMode NullableSensorPcapMode `json:"pcapMode"` + // The type of the resource. + Type string `json:"type"` } type _SensorsGetItem SensorsGetItem diff --git a/pkg/config-api-client/model_sensors_get_response.go b/pkg/config-api-client/model_sensors_get_response.go index 85b6eff..795f258 100644 --- a/pkg/config-api-client/model_sensors_get_response.go +++ b/pkg/config-api-client/model_sensors_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &SensorsGetResponse{} // SensorsGetResponse struct for SensorsGetResponse type SensorsGetResponse struct { + // The list of resources. Items []SensorsGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _SensorsGetResponse SensorsGetResponse diff --git a/pkg/config-api-client/model_service_test_group_assignment_post_group.go b/pkg/config-api-client/model_service_test_group_assignment_post_group.go index eab17fa..ff29bc2 100644 --- a/pkg/config-api-client/model_service_test_group_assignment_post_group.go +++ b/pkg/config-api-client/model_service_test_group_assignment_post_group.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &ServiceTestGroupAssignmentPostGroup{} // ServiceTestGroupAssignmentPostGroup struct for ServiceTestGroupAssignmentPostGroup type ServiceTestGroupAssignmentPostGroup struct { + // The unique identifier of the group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_service_test_group_assignment_post_request.go b/pkg/config-api-client/model_service_test_group_assignment_post_request.go index 3bcef7b..7926054 100644 --- a/pkg/config-api-client/model_service_test_group_assignment_post_request.go +++ b/pkg/config-api-client/model_service_test_group_assignment_post_request.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,7 +26,9 @@ var _ MappedNullable = &ServiceTestGroupAssignmentPostRequest{} // ServiceTestGroupAssignmentPostRequest struct for ServiceTestGroupAssignmentPostRequest type ServiceTestGroupAssignmentPostRequest struct { - GroupId string `json:"groupId"` + // The unique identifier of the group + GroupId string `json:"groupId"` + // The unique identifier of the service test ServiceTestId string `json:"serviceTestId"` } diff --git a/pkg/config-api-client/model_service_test_group_assignment_post_response.go b/pkg/config-api-client/model_service_test_group_assignment_post_response.go index 25f01cc..9bb5633 100644 --- a/pkg/config-api-client/model_service_test_group_assignment_post_response.go +++ b/pkg/config-api-client/model_service_test_group_assignment_post_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,10 +26,12 @@ var _ MappedNullable = &ServiceTestGroupAssignmentPostResponse{} // ServiceTestGroupAssignmentPostResponse struct for ServiceTestGroupAssignmentPostResponse type ServiceTestGroupAssignmentPostResponse struct { + // The unique identifier of the service test group assignment Id string `json:"id"` Group ServiceTestGroupAssignmentPostGroup `json:"group"` ServiceTest ServiceTestGroupAssignmentPostServiceTest `json:"serviceTest"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _ServiceTestGroupAssignmentPostResponse ServiceTestGroupAssignmentPostResponse diff --git a/pkg/config-api-client/model_service_test_group_assignment_post_service_test_.go b/pkg/config-api-client/model_service_test_group_assignment_post_service_test_.go index c86200d..392d1d1 100644 --- a/pkg/config-api-client/model_service_test_group_assignment_post_service_test_.go +++ b/pkg/config-api-client/model_service_test_group_assignment_post_service_test_.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &ServiceTestGroupAssignmentPostServiceTest{} // ServiceTestGroupAssignmentPostServiceTest struct for ServiceTestGroupAssignmentPostServiceTest type ServiceTestGroupAssignmentPostServiceTest struct { + // The unique identifier of the service test Id string `json:"id"` } diff --git a/pkg/config-api-client/model_service_test_group_assignments_get_group.go b/pkg/config-api-client/model_service_test_group_assignments_get_group.go index 5f64e2c..732b9be 100644 --- a/pkg/config-api-client/model_service_test_group_assignments_get_group.go +++ b/pkg/config-api-client/model_service_test_group_assignments_get_group.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &ServiceTestGroupAssignmentsGetGroup{} // ServiceTestGroupAssignmentsGetGroup struct for ServiceTestGroupAssignmentsGetGroup type ServiceTestGroupAssignmentsGetGroup struct { + // The unique identifier of the group Id string `json:"id"` } diff --git a/pkg/config-api-client/model_service_test_group_assignments_get_item.go b/pkg/config-api-client/model_service_test_group_assignments_get_item.go index 63c842d..f5522cf 100644 --- a/pkg/config-api-client/model_service_test_group_assignments_get_item.go +++ b/pkg/config-api-client/model_service_test_group_assignments_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,10 +26,12 @@ var _ MappedNullable = &ServiceTestGroupAssignmentsGetItem{} // ServiceTestGroupAssignmentsGetItem struct for ServiceTestGroupAssignmentsGetItem type ServiceTestGroupAssignmentsGetItem struct { + // The unique identifier of the service test group assignment Id string `json:"id"` Group ServiceTestGroupAssignmentsGetGroup `json:"group"` ServiceTest ServiceTestGroupAssignmentsGetServiceTest `json:"serviceTest"` - Type string `json:"type"` + // The type of the resource. + Type string `json:"type"` } type _ServiceTestGroupAssignmentsGetItem ServiceTestGroupAssignmentsGetItem diff --git a/pkg/config-api-client/model_service_test_group_assignments_get_response.go b/pkg/config-api-client/model_service_test_group_assignments_get_response.go index 74653fb..ac86f6c 100644 --- a/pkg/config-api-client/model_service_test_group_assignments_get_response.go +++ b/pkg/config-api-client/model_service_test_group_assignments_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &ServiceTestGroupAssignmentsGetResponse{} // ServiceTestGroupAssignmentsGetResponse struct for ServiceTestGroupAssignmentsGetResponse type ServiceTestGroupAssignmentsGetResponse struct { + // The list of resources. Items []ServiceTestGroupAssignmentsGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _ServiceTestGroupAssignmentsGetResponse ServiceTestGroupAssignmentsGetResponse diff --git a/pkg/config-api-client/model_service_test_group_assignments_get_service_test_.go b/pkg/config-api-client/model_service_test_group_assignments_get_service_test_.go index d6fa3f8..4ad58ef 100644 --- a/pkg/config-api-client/model_service_test_group_assignments_get_service_test_.go +++ b/pkg/config-api-client/model_service_test_group_assignments_get_service_test_.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,6 +26,7 @@ var _ MappedNullable = &ServiceTestGroupAssignmentsGetServiceTest{} // ServiceTestGroupAssignmentsGetServiceTest struct for ServiceTestGroupAssignmentsGetServiceTest type ServiceTestGroupAssignmentsGetServiceTest struct { + // The unique identifier of the service test Id string `json:"id"` } diff --git a/pkg/config-api-client/model_service_tests_get_item.go b/pkg/config-api-client/model_service_tests_get_item.go index b3e5418..b49f4bd 100644 --- a/pkg/config-api-client/model_service_tests_get_item.go +++ b/pkg/config-api-client/model_service_tests_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,13 +26,20 @@ var _ MappedNullable = &ServiceTestsGetItem{} // ServiceTestsGetItem struct for ServiceTestsGetItem type ServiceTestsGetItem struct { - Id string `json:"id"` - Category string `json:"category"` - Name string `json:"name"` - Target NullableString `json:"target"` - Template string `json:"template"` - IsEnabled bool `json:"isEnabled"` - Type string `json:"type"` + // The unique identifier of the service test + Id string `json:"id"` + // The category of the service test + Category string `json:"category"` + // The name of the service test + Name string `json:"name"` + // The target of the service test + Target NullableString `json:"target"` + // The template of the service test + Template string `json:"template"` + // Indicates if the service test is enabled + IsEnabled bool `json:"isEnabled"` + // The type of the resource. + Type string `json:"type"` } type _ServiceTestsGetItem ServiceTestsGetItem diff --git a/pkg/config-api-client/model_service_tests_get_response.go b/pkg/config-api-client/model_service_tests_get_response.go index 9a9e38d..7fdebb8 100644 --- a/pkg/config-api-client/model_service_tests_get_response.go +++ b/pkg/config-api-client/model_service_tests_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &ServiceTestsGetResponse{} // ServiceTestsGetResponse struct for ServiceTestsGetResponse type ServiceTestsGetResponse struct { + // The list of resources. Items []ServiceTestsGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _ServiceTestsGetResponse ServiceTestsGetResponse diff --git a/pkg/config-api-client/model_wired_networks_get_item.go b/pkg/config-api-client/model_wired_networks_get_item.go index f6b6d4a..a3cc2e8 100644 --- a/pkg/config-api-client/model_wired_networks_get_item.go +++ b/pkg/config-api-client/model_wired_networks_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -27,18 +27,29 @@ var _ MappedNullable = &WiredNetworksGetItem{} // WiredNetworksGetItem struct for WiredNetworksGetItem type WiredNetworksGetItem struct { - Id string `json:"id"` - Name string `json:"name"` - IpVersion IpVersion `json:"ipVersion"` - CreatedAt time.Time `json:"createdAt"` - UpdatedAt time.Time `json:"updatedAt"` - Security NullableString `json:"security"` - DnsLookupDomain NullableString `json:"dnsLookupDomain"` - DisableEdns bool `json:"disableEdns"` - UseDns64 bool `json:"useDns64"` - ExternalConnectivity bool `json:"externalConnectivity"` - VLanId NullableInt32 `json:"vLanId"` - Type string `json:"type"` + // The unique identifier of the wired network + Id string `json:"id"` + // The name of the wired network + Name string `json:"name"` + IpVersion IpVersion `json:"ipVersion"` + // The creation timestamp of the wired network + CreatedAt time.Time `json:"createdAt"` + // The last update timestamp of the wired network + UpdatedAt time.Time `json:"updatedAt"` + // The security settings of the wired network + Security NullableString `json:"security"` + // The DNS lookup domain of the wired network + DnsLookupDomain NullableString `json:"dnsLookupDomain"` + // Whether EDNS is disabled for the wired network + DisableEdns bool `json:"disableEdns"` + // Whether DNS64 is used for the wired network + UseDns64 bool `json:"useDns64"` + // Whether the wired network has external connectivity + ExternalConnectivity bool `json:"externalConnectivity"` + // The VLAN ID of the wired network + VLanId NullableInt32 `json:"vLanId"` + // The type of the resource. + Type string `json:"type"` } type _WiredNetworksGetItem WiredNetworksGetItem diff --git a/pkg/config-api-client/model_wired_networks_get_response.go b/pkg/config-api-client/model_wired_networks_get_response.go index 1244ac4..2616295 100644 --- a/pkg/config-api-client/model_wired_networks_get_response.go +++ b/pkg/config-api-client/model_wired_networks_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &WiredNetworksGetResponse{} // WiredNetworksGetResponse struct for WiredNetworksGetResponse type WiredNetworksGetResponse struct { + // The list of resources. Items []WiredNetworksGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _WiredNetworksGetResponse WiredNetworksGetResponse diff --git a/pkg/config-api-client/model_wireless_networks_get_item.go b/pkg/config-api-client/model_wireless_networks_get_item.go index cf73e7e..3f329c3 100644 --- a/pkg/config-api-client/model_wireless_networks_get_item.go +++ b/pkg/config-api-client/model_wireless_networks_get_item.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -27,20 +27,33 @@ var _ MappedNullable = &WirelessNetworksGetItem{} // WirelessNetworksGetItem struct for WirelessNetworksGetItem type WirelessNetworksGetItem struct { - Id string `json:"id"` - Name string `json:"name"` - Ssid string `json:"ssid"` - Security NullableString `json:"security"` - IpVersion IpVersion `json:"ipVersion"` - CreatedAt time.Time `json:"createdAt"` - UpdatedAt time.Time `json:"updatedAt"` - Hidden bool `json:"hidden"` - BandLocking string `json:"bandLocking"` - DnsLookupDomain NullableString `json:"dnsLookupDomain"` - DisableEdns bool `json:"disableEdns"` - UseDns64 bool `json:"useDns64"` - ExternalConnectivity bool `json:"externalConnectivity"` - Type string `json:"type"` + // The unique identifier of the wireless network + Id string `json:"id"` + // The name of the wireless network + Name string `json:"name"` + // The SSID of the wireless network + Ssid string `json:"ssid"` + // The security type of the wireless network + Security NullableString `json:"security"` + IpVersion IpVersion `json:"ipVersion"` + // The creation timestamp of the wireless network + CreatedAt time.Time `json:"createdAt"` + // The last update timestamp of the wireless network + UpdatedAt time.Time `json:"updatedAt"` + // Whether the wireless network is hidden + Hidden bool `json:"hidden"` + // The band locking setting of the wireless network + BandLocking string `json:"bandLocking"` + // The DNS lookup domain of the wireless network + DnsLookupDomain NullableString `json:"dnsLookupDomain"` + // Whether EDNS is disabled for the wireless network + DisableEdns bool `json:"disableEdns"` + // Whether DNS64 is used for the wireless network + UseDns64 bool `json:"useDns64"` + // Whether the wireless network has external connectivity + ExternalConnectivity bool `json:"externalConnectivity"` + // The type of the resource. + Type string `json:"type"` } type _WirelessNetworksGetItem WirelessNetworksGetItem diff --git a/pkg/config-api-client/model_wireless_networks_get_response.go b/pkg/config-api-client/model_wireless_networks_get_response.go index 55d5907..3e2e0bd 100644 --- a/pkg/config-api-client/model_wireless_networks_get_response.go +++ b/pkg/config-api-client/model_wireless_networks_get_response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ @@ -26,9 +26,12 @@ var _ MappedNullable = &WirelessNetworksGetResponse{} // WirelessNetworksGetResponse struct for WirelessNetworksGetResponse type WirelessNetworksGetResponse struct { + // The list of resources. Items []WirelessNetworksGetItem `json:"items"` - Count int32 `json:"count"` - Next NullableString `json:"next"` + // The number of resources returned in the response. + Count int32 `json:"count"` + // The next cursor for pagination. + Next NullableString `json:"next"` } type _WirelessNetworksGetResponse WirelessNetworksGetResponse diff --git a/pkg/config-api-client/response.go b/pkg/config-api-client/response.go index e92d7db..10a2fd9 100644 --- a/pkg/config-api-client/response.go +++ b/pkg/config-api-client/response.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */ diff --git a/pkg/config-api-client/test/api_configuration_test.go b/pkg/config-api-client/test/api_configuration_test.go index c5ce2c5..f21fab4 100644 --- a/pkg/config-api-client/test/api_configuration_test.go +++ b/pkg/config-api-client/test/api_configuration_test.go @@ -138,7 +138,7 @@ func TestConfigurationAPI(t *testing.T) { Delete("/networking-uxi/v1alpha1/agents/id"). Reply(http.StatusNoContent) - _, httpRes, err := apiClient.ConfigurationAPI. + httpRes, err := apiClient.ConfigurationAPI. AgentDelete(context.Background(), "id"). Execute() require.Nil(t, err) @@ -260,7 +260,7 @@ func TestConfigurationAPI(t *testing.T) { Delete("/networking-uxi/v1alpha1/groups/id"). Reply(http.StatusNoContent) - _, httpRes, err := apiClient.ConfigurationAPI. + httpRes, err := apiClient.ConfigurationAPI. GroupDelete(context.Background(), "id"). Execute() require.Nil(t, err) @@ -474,7 +474,7 @@ func TestConfigurationAPI(t *testing.T) { Delete("/networking-uxi/v1alpha1/agent-group-assignments/id"). Reply(http.StatusNoContent) - _, httpRes, err := apiClient.ConfigurationAPI. + httpRes, err := apiClient.ConfigurationAPI. AgentGroupAssignmentDelete(context.Background(), "id"). Execute() require.Nil(t, err) @@ -564,7 +564,7 @@ func TestConfigurationAPI(t *testing.T) { Delete("/networking-uxi/v1alpha1/sensor-group-assignments/id"). Reply(http.StatusNoContent) - _, httpRes, err := apiClient.ConfigurationAPI. + httpRes, err := apiClient.ConfigurationAPI. SensorGroupAssignmentDelete(context.Background(), "id"). Execute() require.Nil(t, err) @@ -779,7 +779,7 @@ func TestConfigurationAPI(t *testing.T) { Delete("/networking-uxi/v1alpha1/network-group-assignments/id"). Reply(http.StatusNoContent) - _, httpRes, err := apiClient.ConfigurationAPI. + httpRes, err := apiClient.ConfigurationAPI. NetworkGroupAssignmentDelete(context.Background(), "id"). Execute() require.Nil(t, err) @@ -869,7 +869,7 @@ func TestConfigurationAPI(t *testing.T) { Delete("/networking-uxi/v1alpha1/service-test-group-assignments/id"). Reply(http.StatusNoContent) - _, httpRes, err := apiClient.ConfigurationAPI. + httpRes, err := apiClient.ConfigurationAPI. ServiceTestGroupAssignmentDelete(context.Background(), "id"). Execute() require.Nil(t, err) diff --git a/pkg/config-api-client/utils.go b/pkg/config-api-client/utils.go index de9b683..234e591 100644 --- a/pkg/config-api-client/utils.go +++ b/pkg/config-api-client/utils.go @@ -7,7 +7,7 @@ HPE Aruba Networking UXI Configuration This document outlines the API contracts for HPE Aruba Networking UXI. -API version: 5.21.0 +API version: 5.22.0 Contact: support@capenetworks.com */