Skip to content
GitLab
Commit 4125b462 authored by Ayesha Ayub's avatar Ayesha Ayub
Browse files

update SOL002VNFLifecycleManagement

parent 34dfc683
Pipeline #13133 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml
View file @ 4125b462
......@@ -100,7 +100,7 @@ paths:
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: '#/components/responses/VnfInstances.Post.422'
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
"500":
......@@ -790,6 +790,8 @@ paths:
The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled
back, i.e. the related "Individual VNF LCM operation occurrence" is either in "PROCESSING" or "ROLLING_BACK" state.
See clause 5.4.17.3.1.
requestBody:
$ref: '#/components/requestBodies/VnfInstanceCancelModeRequest'
responses:
"202":
$ref: '#/components/responses/VnfLcmOpOccCancel.Post.202'
......@@ -884,7 +886,7 @@ paths:
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: '#/components/responses/Subscriptions.Post.442'
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
"500":
......@@ -993,7 +995,7 @@ paths:
"416":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
"422":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
$ref: '#/components/responses/VnfInstanceCreateSnapshot.Post.422'
"429":
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
"500":
......@@ -1452,6 +1454,15 @@ components:
$ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeCurrentVnfPkgRequest
required: true
VnfInstanceCancelModeRequest:
description: |
The POST request to this resource shall include a CancelMode structure in the message content to
choose between "graceful" and "forceful" cancellation.
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelMode
VnfLcmSubscriptionRequest:
description: |
Details of the subscription to be created.
......@@ -1565,6 +1576,45 @@ components:
schema:
$ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance
VnfInstances.Post.422:
description: |
422 Unprocessable Content
Shall be returned upon the following error: The content type of the message content is supported and
the message content of a request contains syntactically correct data but the data cannot be processed.
The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [6],
including rules for the presence of the response body.
Specifically in case of this resource, the response code 422 shall also be returned if the VNF package
referenced by the "vnfdId" attribute in the "CreateVnfRequest" structure is not in the "ENABLED" state
or does not exist. In this case, the "detail" attribute in the "ProblemDetails" structure 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: Version of the API used in the response.
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"
IndividualVnfInstance.Get.200:
description: |
200 OK
......@@ -2565,7 +2615,7 @@ components:
description: |
202 ACCEPTED
The request has been accepted for processing, but processing has not been completed. The response shall
have an empty payload body.
have an empty message content.
headers:
Version:
description: The used API version.
......@@ -2629,7 +2679,7 @@ components:
description: |
202 ACCEPTED
The request has been accepted for processing, but processing has not been completed. The response shall have
an empty payload body.
an empty message content.
headers:
Version:
description: The used API version.
......@@ -2766,7 +2816,7 @@ components:
description: |
202 ACCEPTED
The request has been accepted for processing, but processing has not been completed. The response shall
have an empty payload body.
have an empty message content.
headers:
Version:
description: The used API version.
......@@ -2896,6 +2946,45 @@ components:
schema:
$ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription
Subscriptions.Post.442:
description: |
422 Unprocessable Content
Shall be returned upon the following error: The content type of the message content is supported and
the message content of a request contains syntactically correct data but the data cannot be processed.
The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [6],
including rules for the presence of the response body.
Specifically in case of this resource, the response code 422 shall also be returned if the VNFM has tested
the Notification endpoint as described in clause 5.4.20.3.2 and the test has failed.
In this case, the "detail" attribute in the "ProblemDetails" structure 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: Version of the API used in the response.
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"
IndividualSubscription.Get.200:
description: |
200 OK
......@@ -3028,6 +3117,45 @@ components:
schema:
$ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
VnfInstanceCreateSnapshot.Post.422:
description: |
422 Unprocessable Content
Shall be returned upon the following error: The content type of the message content is supported and the
message content of a request contains syntactically correct data but the data cannot be processed.
The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [6],
including rules for the presence of the response body.
Specifically in case of this resource, the response code 422 shall also be returned if the provided
identifier of the target "Individual VNF snapshot" resource for the VNF snapshot is invalid.
In this case, the "detail" attribute in the "ProblemDetails" structure 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: Version of the API used in the response.
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
......
src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml
View file @ 4125b462
......@@ -94,7 +94,7 @@ definitions:
The declaration of configurable properties in the VNFD can optionally
contain the specification of initial values. See note 2, note 3 and note 4. The VNFM
shall reject requests to write configurable properties that are not declared in the
VNFD with a "422 Unprocessable entity" error response as defined in clause 6.4 of ETSI GS NFV SOL 013.
VNFD with a "422 Unprocessable Content" error response as defined in clause 6.4 of ETSI GS NFV SOL 013.
These configurable properties include the following standard attributes,
which are declared in the VNFD if auto-scaling and/or auto-healing are
supported by the VNF:
......@@ -259,7 +259,7 @@ definitions:
extension in the VNFD contains information on whether its presence is optional or required,
and optionally can specify an initial value. See note 2 and note 4. The VNFM shall reject
requests to write extension attributes that are not declared in the VNFD with a "422 Unprocessable
entity" error response as defined in clause 6.4 of ETSI GS NFV SOL 013.
Content" error response as defined in clause 6.4 of ETSI GS NFV SOL 013.
Modifying the values of these attributes has no direct effect on the VNF instance; however, the
modified attribute values can be considered during subsequent VNF lifecycle management operations,
......@@ -407,7 +407,7 @@ definitions:
description: >
Additional input parameters for the instantiation process, specific
to the VNF being instantiated, as declared in the VNFD as part of
"InstantiateVnfOpConfig".
"InstantiateVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
......@@ -466,9 +466,8 @@ definitions:
$ref: "#/definitions/ExtManagedVirtualLinkData"
additionalParams:
description: >
Additional input parameters for the instantiation process, specific
to the VNF being instantiated, as declared in the VNFD as part of
"InstantiateVnfOpConfig".
Additional input parameters for the flavour change process, specific to the VNF being modified, as
declared in the VNFD as part of "ChangeVnfFlavourOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
......@@ -515,12 +514,10 @@ definitions:
the VNFM waits for the successful taking out of service of the VNF, no matter how long it takes, before shutting
down the VNF and releasing the resources.
type: integer
additionalParams:
description: >
Additional parameters passed by the NFVO as input to the termination
process, specific to the VNF being terminated, as declared in the
VNFD as part of "TerminateVnfOpConfig".
Additional parameters passed by the EM as input to the termination process, specific to the VNF being terminated,
as declared in the VNFD as part of "TerminateVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
HealVnfRequest:
......@@ -540,9 +537,8 @@ definitions:
type: string
additionalParams:
description: >
Additional parameters passed by the NFVO as input to the healing
process, specific to the VNF being healed, as declared in the VNFD
as part of "HealVnfOpConfig".
Additional parameters passed by the EM as input to the healing process, specific to the VNF being healed as
declared in the VNFD as part of "HealVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
healScript:
description: >
......@@ -590,9 +586,8 @@ definitions:
type: integer
additionalParams:
description: >
Additional parameters passed by the NFVO as input to the process,
specific to the VNF of which the operation status is changed, as
declared in the VNFD as part of "OperateVnfOpConfig".
Additional parameters passed by the EM as input to the process, specific to the VNF of which the operation
status is changed, as declared in the VNFD as part of "OperateVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
ChangeExtVnfConnectivityRequest:
......@@ -619,9 +614,9 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
additionalParams:
description: >
Additional input parameters for the instantiation process, specific
to the VNF being instantiated, as declared in the VNFD as part of
"ChangeExtVnfConnectivityOpConfig".
Additional parameters passed by the EM as input to the process, specific to the VNF of which the
external connectivity is changed, as declared in the VNFD as part of "ChangeExtVnfConnectivityOpConfig"
defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
ChangeCurrentVnfPkgRequest:
......@@ -664,7 +659,7 @@ definitions:
additionalParams:
description: >
Additional parameters passed by the EM as input to the process, specific to the VNF of which the underlying
VNF package is changed, as declared in the VNFD as part of "ChangeCurrentVnfPkgOpConfig".
VNF package is changed, as declared in the VNFD as part of "ChangeCurrentVnfPkgOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
descriptions: >
......@@ -743,7 +738,7 @@ definitions:
CreateVnfSnapshotRequest:
description: >
This type represents request parameters for the "Create VNF Snapshot" operation.
This type represents request parameters for the "Create VNF Snapshot" LCM operation.
type: object
required:
- vnfSnapshotResId
......@@ -761,7 +756,7 @@ definitions:
additionalParams:
description: >
Additional input parameters for the snapshot creation process, specific for the VNF being “snapshotted”,
as declared in the VNFD as part of "CreateSnapshotVnfOpConfig".
as declared in the VNFD as part of "CreateSnapshotVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
userDefinedData:
description: >
......@@ -790,7 +785,7 @@ definitions:
additionalParams:
description: >
Additional input parameters for the revert to VNF snapshot process, specific for the VNF being “reverted”,
as declared in the VNFD as part of “RevertToSnapshotVnfOpConfig”.
as declared in the VNFD as part of “RevertToSnapshotVnfOpConfig” defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
CreateVnfSnapshotInfoRequest:
......@@ -1146,7 +1141,7 @@ definitions:
Identifier of another VNFC CP instance that corresponds to the parent port
of a trunk that the present VNFC CP instance participates in.
Shall be provided if the present CP instance participates in a trunk as subport.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
metadata:
description: >
Metadata about this CP.
......
src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml
View file @ 4125b462
......@@ -60,7 +60,7 @@ definitions:
description: >
Additional parameters passed by the NFVO as input to the scaling
process, specific to the VNF being scaled, as declared in the VNFD
as part of "ScaleVnfOpConfig".
as part of "ScaleVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
ScaleVnfToLevelRequest:
......@@ -97,7 +97,7 @@ definitions:
description: >
Additional parameters passed by the NFVO as input to the scaling
process, specific to the VNF being scaled, as declared in the
VNFD as part of "ScaleVnfToLevelOpConfig".
VNFD as part of "ScaleVnfToLevelOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfInfoModificationRequest:
......@@ -923,8 +923,7 @@ definitions:
$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
vduId:
description: >
Reference to the applicable VDU information element in
the VNFD.
Reference to the applicable VDU in the VNFD.
$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
vnfcResourceInfoId:
description: >
......@@ -1088,7 +1087,7 @@ definitions:
properties:
cpInstanceId:
description: >
Identifier of this VIP CP instance and of this VipCpInfo information element.
Identifier of this VIP CP instance and of this VipCpInfo.
$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment