Skip to content
GitLab
Commit 40302faf authored by Sana Zulfiqar's avatar Sana Zulfiqar
Browse files

Updated error codes descriptions

parent 44336082
Pipeline #7811 passed with stage
in 0 seconds
Show whitespace changes
Inline Side-by-side
src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml
View file @ 40302faf
......@@ -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
......
src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml
View file @ 40302faf
......@@ -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.