From 40302faf7c29e7af2b9b5ba04787dd3ca57edf07 Mon Sep 17 00:00:00 2001 From: zulfiqar Date: Fri, 23 Jul 2021 12:45:25 +0200 Subject: [PATCH] Updated error codes descriptions --- .../VNFFaultManagement.yaml | 46 +- .../VNFLifecycleManagement.yaml | 1108 ++++++++++++++--- 2 files changed, 974 insertions(+), 180 deletions(-) diff --git a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml index 7f5a8031..381d753b 100644 --- a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml @@ -120,6 +120,8 @@ paths: responses: "200": $ref: '#/components/responses/IndividualAlarm.Patch.200' + "409": + $ref: '#/components/responses/IndividualAlarm.Patch.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -132,8 +134,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "412": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 "416": @@ -496,6 +496,48 @@ components: schema: $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications + IndividualAlarm.Patch.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the "Individual alarm" + resource. + Typically, this is due to the fact that the alarm is + already in the state that is requested to be set (such + as trying to acknowledge an already-acknowledged + alarm). + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + IndividualAlarmEscalate.Post.204: description: | 204 No Content diff --git a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml index 80a4759d..a4bb1e96 100644 --- a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -152,6 +152,8 @@ paths: responses: "204": $ref: '#/components/responses/IndividualVnfInstance.Delete.204' + "409": + $ref: '#/components/responses/IndividualVnfInstance.Delete.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -164,8 +166,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -187,6 +187,8 @@ paths: responses: "202": $ref: '#/components/responses/IndividualVnfInstance.Patch.202' + "409": + $ref: '#/components/responses/IndividualVnfInstance.Patch.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -199,8 +201,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "412": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 "416": @@ -229,6 +229,8 @@ paths: responses: "202": $ref: '#/components/responses/InstantiateVnfInstance.Post.202' + "409": + $ref: '#/components/responses/InstantiateVnfInstance.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -241,8 +243,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -269,6 +269,8 @@ paths: responses: "202": $ref: '#/components/responses/ScaleVnfInstance.Post.202' + "409": + $ref: '#/components/responses/ScaleVnfInstance.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -281,8 +283,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -309,6 +309,8 @@ paths: responses: "202": $ref: '#/components/responses/ScaleVnfInstanceToLevel.Post.202' + "409": + $ref: '#/components/responses/ScaleVnfInstanceToLevel.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -321,8 +323,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -349,6 +349,8 @@ paths: responses: "202": $ref: '#/components/responses/VnfInstanceChangeFlavour.Post.202' + "409": + $ref: '#/components/responses/VnfInstanceChangeFlavour.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -361,8 +363,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -390,6 +390,8 @@ paths: responses: "202": $ref: '#/components/responses/TerminateVnfInstance.Post.202' + "409": + $ref: '#/components/responses/TerminateVnfInstance.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -402,8 +404,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -430,6 +430,8 @@ paths: responses: "202": $ref: '#/components/responses/HealVnfInstance.Post.202' + "409": + $ref: '#/components/responses/HealVnfInstance.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -442,8 +444,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -470,6 +470,8 @@ paths: responses: "202": $ref: '#/components/responses/OperateVnfInstance.Post.202' + "409": + $ref: '#/components/responses/OperateVnfInstance.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -482,8 +484,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -510,6 +510,8 @@ paths: responses: "202": $ref: '#/components/responses/VnfInstanceChangeExtConn.Post.202' + "409": + $ref: '#/components/responses/VnfInstanceChangeExtConn.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -522,8 +524,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -551,6 +551,8 @@ paths: responses: "202": $ref: '#/components/responses/VnfInstanceChangeVnfPkg.Post.202' + "409": + $ref: '#/components/responses/VnfInstanceChangeVnfPkg.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -563,8 +565,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -671,6 +671,8 @@ paths: responses: "202": $ref: '#/components/responses/VnfLcmOpOccRetry.Post.202' + "409": + $ref: '#/components/responses/VnfLcmOpOccRetry.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -683,8 +685,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -711,6 +711,8 @@ paths: responses: "202": $ref: '#/components/responses/VnfLcmOpOccRollback.Post.202' + "409": + $ref: '#/components/responses/VnfLcmOpOccRollback.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -723,8 +725,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -750,6 +750,8 @@ paths: responses: "200": $ref: '#/components/responses/VnfLcmOpOccFail.Post.200' + "409": + $ref: '#/components/responses/VnfLcmOpOccFail.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -762,8 +764,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -790,6 +790,8 @@ paths: responses: "202": $ref: '#/components/responses/VnfLcmOpOccCancel.Post.202' + "409": + $ref: '#/components/responses/VnfLcmOpOccCancel.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -802,8 +804,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -973,6 +973,8 @@ paths: responses: "202": $ref: '#/components/responses/VnfInstanceCreateSnapshot.Post.202' + "409": + $ref: '#/components/responses/VnfInstanceCreateSnapshot.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -985,8 +987,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -1013,6 +1013,8 @@ paths: responses: "202": $ref: '#/components/responses/VnfInstanceRevertToSnapshot.Post.202' + "409": + $ref: '#/components/responses/VnfInstanceRevertToSnapshot.Post.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -1025,8 +1027,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -1162,6 +1162,8 @@ paths: responses: "204": $ref: '#/components/responses/IndividualVnfSnapshot.Delete.204' + "409": + $ref: '#/components/responses/IndividualVnfSnapshot.Delete.409' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 "401": @@ -1174,8 +1176,6 @@ paths: $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 - "409": - $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 "422": @@ -1504,19 +1504,19 @@ components: schema: $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification - IndividualVnfInstance.Patch.202: + IndividualVnfInstance.Delete.409: description: | - 202 ACCEPTED - The request was accepted for processing, but the processing has not been completed. On success, the HTTP - response shall include a "Location" HTTP header that contains the URI of the newly-created an "Individual - VNF LCM operation occurrence" resource corresponding to the operation. The response body shall be empty. + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the "Individual + VNF instance" resource is in INSTANTIATED state. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. headers: - Version: - description: The used API version. - style: simple - explode: false - schema: - type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the @@ -1525,30 +1525,30 @@ components: explode: false schema: type: string - Content-Type: - description: The MIME type of the body of the response. + Version: + description: The used API version. style: simple explode: false schema: type: string - Location: + Content-Type: description: | - Used in redirection, or when a new resource has been created. This header field shall be present if the - response status code is 201 or 3xx. In the present document this header field is also used if the response - status code is 202 and a new resource was created. + The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string - format: url - content: {} + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - InstantiateVnfInstance.Post.202: + IndividualVnfInstance.Patch.202: description: | 202 ACCEPTED - The request has been accepted for processing, but the processing has not been completed. The response body - shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the - newly-created "VNF LCM operation occurrence" resource corresponding to the operation. + The request was accepted for processing, but the processing has not been completed. On success, the HTTP + response shall include a "Location" HTTP header that contains the URI of the newly-created an "Individual + VNF LCM operation occurrence" resource corresponding to the operation. The response body shall be empty. headers: Version: description: The used API version. @@ -1582,19 +1582,20 @@ components: format: url content: {} - ScaleVnfInstance.Post.202: + IndividualVnfInstance.Patch.409: description: | - 202 ACCEPTED - The request has been accepted for processing, but the processing has not been completed. The response body - shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the - newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation. + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the "Individual VNF instance" + resource + Typically, this is due to the fact that another LCM + operation is ongoing. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute should convey + more information about the error headers: - Version: - description: The used API version. - style: simple - explode: false - schema: - type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the @@ -1603,30 +1604,30 @@ components: explode: false schema: type: string - Content-Type: - description: The MIME type of the body of the response. + Version: + description: The used API version. style: simple explode: false schema: type: string - Location: + Content-Type: description: | - Used in redirection, or when a new resource has been created. This header field shall be present if the - response status code is 201 or 3xx. In the present document this header field is also used if the response - status code is 202 and a new resource was created. + The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string - format: url - content: {} + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - ScaleVnfInstanceToLevel.Post.202: + InstantiateVnfInstance.Post.202: description: | 202 ACCEPTED - The request has been accepted for processing, but the processing has not been completed. The response body shall - be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created - "VNF LCM operation occurrence" resource corresponding to the operation. + The request has been accepted for processing, but the processing has not been completed. The response body + shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the + newly-created "VNF LCM operation occurrence" resource corresponding to the operation. headers: Version: description: The used API version. @@ -1660,19 +1661,21 @@ components: format: url content: {} - VnfInstanceChangeFlavour.Post.202: + InstantiateVnfInstance.Post.409: description: | - 202 ACCEPTED - The request has been accepted for processing, but the processing has not been completed. The response body - shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the - newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation. + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the "Individual + VNF instance" resource is in INSTANTIATED state + or that a required (see note) child attribute of the + "extensions" attribute has not been set. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. headers: - Version: - description: The used API version. - style: simple - explode: false - schema: - type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the @@ -1681,30 +1684,30 @@ components: explode: false schema: type: string - Content-Type: - description: The MIME type of the body of the response. + Version: + description: The used API version. style: simple explode: false schema: type: string - Location: + Content-Type: description: | - Used in redirection, or when a new resource has been created. This header field shall be present if the - response status code is 201 or 3xx. In the present document this header field is also used if the response - status code is 202 and a new resource was created. + The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string - format: url - content: {} + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - TerminateVnfInstance.Post.202: + ScaleVnfInstance.Post.202: description: | 202 ACCEPTED - The request has been accepted for processing. The response body shall be empty. The HTTP response shall include - a "Location" HTTP header that contains the URI of the newly-created "Individual VNF LCM operation occurrence" - resource corresponding to the operation. + The request has been accepted for processing, but the processing has not been completed. The response body + shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the + newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation. headers: Version: description: The used API version. @@ -1738,19 +1741,22 @@ components: format: url content: {} - HealVnfInstance.Post.202: - description: | - 202 ACCEPTED - The request has been accepted for processing, but the processing has not been completed. The response body - shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the - newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation. + ScaleVnfInstance.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the "Individual + VNF instance" resource is in NOT_INSTANTIATED + state, that another lifecycle management operation is + ongoing, or that a required (see note) child attribute + of the "extensions" attribute has not been set. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. headers: - Version: - description: The used API version. - style: simple - explode: false - schema: - type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the @@ -1759,30 +1765,30 @@ components: explode: false schema: type: string - Content-Type: - description: The MIME type of the body of the response. + Version: + description: The used API version. style: simple explode: false schema: type: string - Location: + Content-Type: description: | - Used in redirection, or when a new resource has been created. This header field shall be present if the - response status code is 201 or 3xx. In the present document this header field is also used if the response - status code is 202 and a new resource was created. + The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string - format: url - content: {} + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - OperateVnfInstance.Post.202: + ScaleVnfInstanceToLevel.Post.202: description: | 202 ACCEPTED - The request has been accepted for processing, but the processing has not been completed. The response body - shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the - newly-created "VNF LCM operation occurrence" resource corresponding to the operation. + The request has been accepted for processing, but the processing has not been completed. The response body shall + be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created + "VNF LCM operation occurrence" resource corresponding to the operation. headers: Version: description: The used API version. @@ -1816,19 +1822,23 @@ components: format: url content: {} - VnfInstanceChangeExtConn.Post.202: - description: | - 202 ACCEPTED - The request has been accepted for processing, but the processing has not been completed. The response body - shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the - newly-created "VNF LCM operation occurrence" resource corresponding to the operation. + ScaleVnfInstanceToLevel.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the VNF instance + resource is in NOT_INSTANTIATED state, that + another lifecycle management operation is ongoing, + or that a required (see note) child attribute of the + "extensions" attribute has not been set. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + Note: Required attributes are marked as "required" in the VNFD. headers: - Version: - description: The used API version. - style: simple - explode: false - schema: - type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the @@ -1837,30 +1847,30 @@ components: explode: false schema: type: string - Content-Type: - description: The MIME type of the body of the response. + Version: + description: The used API version. style: simple explode: false schema: type: string - Location: + Content-Type: description: | - Used in redirection, or when a new resource has been created. This header field shall be present if the - response status code is 201 or 3xx. In the present document this header field is also used if the response - status code is 202 and a new resource was created. + The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: type: string - format: url - content: {} + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - VnfInstanceChangeVnfPkg.Post.202: + VnfInstanceChangeFlavour.Post.202: description: | 202 ACCEPTED - Shall be returned when the request has been accepted for processing. - The response body shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI - of the newly-created "Individual VNF LCM operation occurrence" resource corresponding to the instantiation operation. + The request has been accepted for processing, but the processing has not been completed. The response body + shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the + newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation. headers: Version: description: The used API version. @@ -1894,22 +1904,25 @@ components: format: url content: {} - VnfLcmOpOccs.Get.200: - description: | - 200 OK - Status information for zero or more VNF lifecycle management operation occurrences has been queried - successfully. The response body shall contain in an array the status information about zero or more VNF - lifecycle operation occurrences, as defined in clause 5.5.2.13. If the VNFM supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in - this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + VnfInstanceChangeFlavour.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the + "Individual VNF instance" resource is in + NOT_INSTANTIATED state, that another + lifecycle management operation is ongoing, or + that a required (see note) child attribute of the + "extensions" attribute has not been set. + The response body shall contain a + ProblemDetails structure, in which the "detail" + attribute shall convey more information about the + error. + note: Required attributes are marked as "required" in the VNFD. headers: - Version: - description: | - The used API version. - style: simple - explode: false - schema: - type: string WWW-Authenticate: description: | Challenge if the corresponding HTTP request has not provided authorization, or error details if the @@ -1918,15 +1931,15 @@ components: explode: false schema: type: string - Link: - description: | - Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + Version: + description: The used API version. style: simple explode: false schema: type: string Content-Type: - description: The MIME type of the body of the response. + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 style: simple explode: false schema: @@ -1934,13 +1947,462 @@ components: content: application/json: schema: - $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - IndividualVnfLcmOpOcc.Get.200: + TerminateVnfInstance.Post.202: description: | - 200 OK - Information about an individual VNF instance has been queried successfully. The response body shall contain - status information about a VNF lifecycle management operation occurrence. + 202 ACCEPTED + The request has been accepted for processing. The response body shall be empty. The HTTP response shall include + a "Location" HTTP header that contains the URI of the newly-created "Individual VNF LCM operation occurrence" + resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + TerminateVnfInstance.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the "Individual VNF + instance" resource is in NOT_INSTANTIATED state, or + that another lifecycle management operation is + ongoing, or that a required (see note) child attribute of + the "extensions" attribute has not been set. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + note: Required attributes are marked as "required" in the VNFD. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + HealVnfInstance.Post.202: + description: | + 202 ACCEPTED + The request has been accepted for processing, but the processing has not been completed. The response body + shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the + newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + HealVnfInstance.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the "Individual VNF + instance" resource is in NOT_INSTANTIATED state, + that another lifecycle management operation is + ongoing, or that a required (see note) child attribute of + the "extensions" attribute has not been set. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + note: Required attributes are marked as "required" in the VNFD. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + OperateVnfInstance.Post.202: + description: | + 202 ACCEPTED + The request has been accepted for processing, but the processing has not been completed. The response body + shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the + newly-created "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + OperateVnfInstance.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the "Individual VNF + instance" resource is in NOT_INSTANTIATED state, + that another lifecycle management operation is + ongoing, or that a required (see note) child attribute of + the "extensions" attribute has not been set. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + note: Required attributes are marked as "required" in the VNFD. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + VnfInstanceChangeExtConn.Post.202: + description: | + 202 ACCEPTED + The request has been accepted for processing, but the processing has not been completed. The response body + shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the + newly-created "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + VnfInstanceChangeExtConn.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that another + lifecycle management operation is ongoing, or that + a required (see note) child attribute of the + "extensions" attribute has not been set. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + note: Required attributes are marked as "required" in the VNFD. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + VnfInstanceChangeVnfPkg.Post.202: + description: | + 202 ACCEPTED + Shall be returned when the request has been accepted for processing. + The response body shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI + of the newly-created "Individual VNF LCM operation occurrence" resource corresponding to the instantiation operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + VnfInstanceChangeVnfPkg.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: + The operation cannot be executed + currently, due to a conflict with the state of + the resource. + Typically, this is due to the fact that another + lifecycle management operation is ongoing. + The response body shall contain a + ProblemDetails structure, in which the + "detail" attribute shall convey more + information about the error. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + VnfLcmOpOccs.Get.200: + description: | + 200 OK + Status information for zero or more VNF lifecycle management operation occurrences has been queried + successfully. The response body shall contain in an array the status information about zero or more VNF + lifecycle operation occurrences, as defined in clause 5.5.2.13. If the VNFM supports alternative 2 (paging) + according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in + this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: | + The used API version. + style: simple + explode: false + schema: + type: string + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc + + IndividualVnfLcmOpOcc.Get.200: + description: | + 200 OK + Information about an individual VNF instance has been queried successfully. The response body shall contain + status information about a VNF lifecycle management operation occurrence. headers: Version: description: The used API version. @@ -1989,6 +2451,48 @@ components: type: string content: {} + VnfLcmOpOccRetry.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the VNF LCM operation + occurrence. + Typically, this is due to the fact that the VNF LCM + operation occurrence is not in FAILED_TEMP state + or another error handling action is starting such as + rollback or fail. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + VnfLcmOpOccRollback.Post.202: description: | 202 ACCEPTED @@ -2011,6 +2515,48 @@ components: type: string content: {} + VnfLcmOpOccRollback.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the VNF LCM operation + occurrence. + Typically, this is due to the fact that the VNF LCM + operation occurrence is not in FAILED_TEMP state + or another error handling action is starting such as + retry or fail. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + VnfLcmOpOccFail.Post.200: description: | 200 OK @@ -2042,6 +2588,48 @@ components: schema: $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc + VnfLcmOpOccFail.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the VNF LCM operation + occurrence. + Typically, this is due to the fact that the VNF LCM + operation occurrence is not in FAILED_TEMP state or + another error handling action is starting such as retry + or rollback. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + VnfLcmOpOccCancel.Post.202: description: | 202 ACCEPTED @@ -2064,6 +2652,47 @@ components: type: string content: {} + VnfLcmOpOccCancel.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the VNF LCM operation + occurrence. + Typically, this is due to the fact that the operation + occurrence is not in STARTING, PROCESSING or + ROLLING_BACK state. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + Subscriptions.Get.200: description: | 200 OK @@ -2226,6 +2855,47 @@ components: format: url content: {} + VnfInstanceCreateSnapshot.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the VNF + instance resource is in NOT_INSTANTIATED + state, or that another lifecycle management + operation is ongoing. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall + convey more information about the error. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + VnfInstanceRevertToSnapshot.Post.202: description: | 202 ACCEPTED @@ -2265,6 +2935,47 @@ components: format: url content: {} + VnfInstanceRevertToSnapshot.Post.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the VNF + instance resource is in NOT_INSTANTIATED + state, or that another lifecycle management + operation is ongoing. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall + convey more information about the error. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + VnfSnapshots.Post.201: description: | 201 CREATED @@ -2403,4 +3114,45 @@ components: explode: false schema: type: string - content: {} \ No newline at end of file + content: {} + + IndividualVnfSnapshot.Delete.409: + description: | + 409 CONFLICT + + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact that the VNF + instance resource is in NOT_INSTANTIATED + state, or that another lifecycle management + operation is ongoing. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall + convey more information about the error. + headers: + WWW-Authenticate: + description: | + Challenge if the corresponding HTTP request has not provided authorization, or error details if the + corresponding HTTP request has provided an invalid authorization token. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" \ No newline at end of file -- GitLab