diff options
| author |   ToineSiebelink <toine.siebelink@est.tech> | 2024-04-09 18:39:51 +0100 |
|---|---|---|
| committer | ToineSiebelink <toine.siebelink@est.tech> | 2024-04-10 11:47:06 +0100 |
| commit | 693cfdd2467d01bf9a90f588ba827454a7b20f33 (patch) | |
| tree | 2d9a3e3e587d4b5e7909c4748e1c105b5f1a2483 /cps-ncmp-rest/docs | |
| parent | 868ff64f0f1873518b1a2225e5c35fa89fdc6d33 (diff) | |
Introduce and handle Operation Too Large Exception for batch operations
Issue-ID: CPS-2164
Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
Change-Id: Iec05d2013be4f971309f0e75d84dc5d0936eb8ef
Diffstat (limited to 'cps-ncmp-rest/docs')
| -rw-r--r-- | cps-ncmp-rest/docs/openapi/components.yaml | 15 | ||||
| -rwxr-xr-x | cps-ncmp-rest/docs/openapi/ncmp.yml | 4 |
2 files changed, 16 insertions, 3 deletions
diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index 0ad453a1cf..8aa38c0f70 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -366,6 +366,7 @@ components: type: array items: type: string + description: targeted cm handles, maximum of 50 supported. If this limit is exceeded the request wil be refused. example: [ "da310eecdb8d44c2acc0ddaae01174b1","c748c58f8e0b438f9fd1f28370b17d47" ] examples: @@ -695,7 +696,7 @@ components: schema: $ref: '#/components/schemas/ErrorMessage' example: - status: 400 BAD_REQUEST + status: 400 message: Bad request error message details: Bad request error details Conflict: @@ -705,9 +706,19 @@ components: schema: $ref: '#/components/schemas/ErrorMessage' example: - status: 409 CONFLICT + status: 409 message: Conflict error message details: Conflict error details + PayloadTooLarge: + description: The request is larger than the server is willing or able to process + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 413 + message: Payload Too Large error message + details: Payload Too Large error details NotImplemented: description: The given path has not been implemented content: diff --git a/cps-ncmp-rest/docs/openapi/ncmp.yml b/cps-ncmp-rest/docs/openapi/ncmp.yml index 0cb1cdffb1..d0b1f35eaa 100755 --- a/cps-ncmp-rest/docs/openapi/ncmp.yml +++ b/cps-ncmp-rest/docs/openapi/ncmp.yml @@ -194,7 +194,7 @@ dataOperationForCmHandle: tags: - network-cm-proxy summary: Execute a data operation for group of cm handle ids - description: This request will be handled asynchronously using messaging to the supplied topic. The rest response will be an acknowledge with a requestId to identify the relevant messages. + description: This request will be handled asynchronously using messaging to the supplied topic. The rest response will be an acknowledge with a requestId to identify the relevant messages. A maximum of 50 cm handles per operation is supported. operationId: executeDataOperationForCmHandles parameters: - $ref: 'components.yaml#/components/parameters/requiredTopicParamInQuery' @@ -216,6 +216,8 @@ dataOperationForCmHandle: $ref: 'components.yaml#/components/responses/BadRequest' 403: $ref: 'components.yaml#/components/responses/Forbidden' + 413: + $ref: 'components.yaml#/components/responses/PayloadTooLarge' 500: $ref: 'components.yaml#/components/responses/InternalServerError' 502: |