Skip to content
GitLab
Commit 44336082 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

updated response descriptions

parent b1c5eccc
Pipeline #7781 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml
View file @ 44336082
......@@ -129,14 +129,7 @@ paths:
406:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
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).
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
$ref: '#/components/responses/IndividualAlarm.Patch.409'
412:
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
422:
......@@ -449,7 +442,49 @@ components:
application/json:
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"
Subscriptions.Get.200:
description: |
200 OK
......
src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml
View file @ 44336082
......@@ -167,13 +167,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 VNF instance" resource.
#Typically, this is due to the fact that another LCM operation is ongoing.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/IndividualVnfInstance.Patch.409'
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
500:
......@@ -201,13 +195,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 INSTANTIATED state.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/IndividualVnfInstance.Delete.409'
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
500:
......@@ -248,15 +236,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 INSTANTIATED state,
#or that a required child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/InstantiateVnfInstance.Post.409'
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
500:
......@@ -309,16 +289,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/ScaleVnfInstance.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -369,16 +340,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/ScaleToLevelVnfInstance.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -428,16 +390,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/ChangeFlavourVnfInstance.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -478,16 +431,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/TerminateVnfInstance.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -537,16 +481,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/HealVnfInstance.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -596,16 +531,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 child attribute of
#the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/OperateVnfInstance.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -645,15 +571,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/ChangeExtConnVnfInstance.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -693,15 +611,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 child attribute of the "extensions" attribute has not been set.
#Those attributes are marked as "required" in the VNFD.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/ChangeVnfpkgVnfInstance.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -829,14 +739,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/RetryVnfLcmOpOcc.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -885,14 +788,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/RollbackVnfLcmOpOcc.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -941,14 +837,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/FailVnfLcmOpOcc.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -987,14 +876,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/CancelVnfLcmOpOcc.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -1185,16 +1067,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/CreateVnfSnapshotTask.Post.409'
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
500:
......@@ -1248,16 +1121,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/RevertToVnfSnapshotTask.Post.409'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -1294,8 +1158,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"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -1404,7 +1266,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/IndividualVnfSnapshot.Patch.409'
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
416:
......@@ -1437,16 +1299,7 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
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 snapshot is in use by some operation such
#as reverting a VNF instance to a VNF snapshot or creating a VNF snapshot package.
#The response body shall contain a ProblemDetails structure, in which the "detail" attribute
#shall convey more information about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/IndividualVnfSnapshot.Delete.409'
412:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412"
500:
......@@ -1488,9 +1341,9 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
409:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.409'
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: '#/components/responses/IndividualVnfSnapshotState.Get.416'
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
503:
......@@ -1876,13 +1729,19 @@ components:
schema:
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
IndividualVnfInstance.Delete.204:
IndividualVnfInstance.Patch.409:
description: |
204 NO CONTENT
409 CONFLICT
Shall be returned when the "Individual VNF instance" resource and the associated
VNF identifier were deleted successfully.
The response body shall be empty.
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:
WWW-Authenticate:
description: |
......@@ -1898,25 +1757,26 @@ components:
explode: false
schema:
type: string
InstantiateVnfInstance.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 operation.
headers:
Location:
Content-Type:
description: |
The resource URI of the created subscription resource.
The MIME type of the body of the response. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
format: url
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
IndividualVnfInstance.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the "Individual VNF instance" resource and the associated
VNF identifier were deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
......@@ -1932,24 +1792,19 @@ components:
schema:
type: string
ScaleVnfInstance.Post.202:
IndividualVnfInstance.Delete.409:
description: |
202 ACCEPTED
409 CONFLICT
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 "VNF LCM operation
occurrence" resource corresponding to the operation.
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:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
......@@ -1964,15 +1819,26 @@ components:
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"
ScaleToLevelVnfInstance.Post.202:
InstantiateVnfInstance.Post.202:
description: |
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
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 "VNF LCM operation
contains the URI of the newly-created "Individual VNF LCM operation
occurrence" resource corresponding to the operation.
headers:
Location:
......@@ -1998,24 +1864,21 @@ components:
schema:
type: string
ChangeFlavourVnfInstance.Post.202:
InstantiateVnfInstance.Post.409:
description: |
202 ACCEPTED
409 CONFLICT
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 "VNF LCM operation
occurrence" resource corresponding to the operation.
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:
Location:
description: |
The resource URI of the created subscription resource.
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
description: |
Challenge if the corresponding HTTP request has not provided authorization, or error details if the
......@@ -2030,8 +1893,19 @@ components:
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"
TerminateVnfInstance.Post.202:
ScaleVnfInstance.Post.202:
description: |
202 ACCEPTED
......@@ -2064,24 +1938,22 @@ components:
schema:
type: string
HealVnfInstance.Post.202:
ScaleVnfInstance.Post.409:
description: |
202 ACCEPTED
409 CONFLICT
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 "VNF LCM operation
occurrence" resource corresponding to the operation.
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:
Location: