Commit 728e0e06 authored by Ayesha Ayub's avatar Ayesha Ayub
Browse files

resolve issues raised by Vlademir in SOL002 and SOL003 v3.7.1

parent 20e183cc
Pipeline #13385 passed with stage
in 0 seconds
...@@ -185,91 +185,6 @@ definitions: ...@@ -185,91 +185,6 @@ definitions:
items: items:
type: string type: string
VimConnectionInfo:
description: >
This type represents parameters to connect to a VIM, a CISM, a CIR or a MCIOP repository for managing
the resources of a VNF instance.
This structure is used to convey VIM-related, CISM-related, CIR-related, or MCIOP-repository-relate
dparameters over the Or-Vnfm interface. Additional parameters for a VIM, a CISM, a CIR or a MCIOP
repository may be configured into the VNFM by means outside the scope of the present document and
bound to the identifier of that VIM.
* NOTE 1: If applicable, this attribute also provides information about the resourceGroupIds
that are accessible using a particular set of credentials. See definition of
"resourceGroupId" in clause 9.5.3.3.
* NOTE 2: Once the connectivity between VNFM and VIM, CISM, CIR or MCIOP repository is provided
through a secure connection over HTTP Secure (HTTP over SSL/TLS), and the connection might also be
established through a VPN (for example TLS-based VPN tunnelling) for site-to-site connection, the
"accessInfo" JSON data structure, and the sensitive data related information ("username"/"password" as
required properties for authentication purpose), will be transmitted as plain text through a TLS tunnel
without additional encoding/encryption before transmitting it, making the sensitive data visible to the
endpoint. The base64 encoded certificates are only used by the VNFM to verify the authenticity of the
interface endpoint of the VIM., CISM, CIR or MCIOP repository.
type: object
required:
- vimType
properties:
vimId:
description: >
The identifier of the VIM, CISM, CIR or MCIOP repository
instance. This identifier is managed by the NFVO.
Shall be present to address additional information about
the VIM, CISM, CIR or MCIOP repository if such
information has been configured into the VNFM by
means outside the scope of the present document and
should be absent otherwise.
$ref: "#/definitions/Identifier"
vimType:
description: >
Discriminator for the different types of the VIM
information.
The value of this attribute determines the structure of the
"interfaceInfo" and "accessInfo" attributes, based on the
type of the VIM., CISM, CIR or MCIOP repository.
The set of permitted values is expected to change over
time as new types or versions of VIMs become available.
The ETSI NFV registry of VIM-related information [i.3]
provides access to information about VimConnectionInfo
definitions for various VIM, CISM, CIR or MCIOP
repository types. The structure of the registry is defined in
annex C.
type: string
interfaceInfo:
description: >
Information about the interface or interfaces to the VIM,
CISM, CIR or MCIOP repository, if applicable, such as
the URI of an interface endpoint to communicate with the
VIM, CISM, CIR or MCIOP repository. The applicable
keys are dependent on the content of vimType.
Alternatively, such information may have been configured
into the VNFM and bound to the vimId.
$ref: "#/definitions/KeyValuePairs"
accessInfo:
description: >
Authentication credentials for accessing the VIM, CISM,
CIR or MCIOP repository and other access-related
information such as tenants or infrastructure resource
groups (see note 1). The applicable keys are dependent
on the content of vimType.
If the VimConnectionInfo structure is part of an HTTP
response payload body, sensitive attributes that are
children of this attributes (such as passwords) shall not
be included.
If the VimConnectionInfo structure is part of an HTTP
request payload body, sensitive attributes that are
children of this attribute (such as passwords) shall be
present if they have not been provisioned out of band.
See note 2.
$ref: "#/definitions/KeyValuePairs"
extra:
description: >
VIM, CISM, CIR or MCIOP repository type specific
additional information. The applicable structure, and
whether or not this attribute is available, is dependent on
the content of vimType.
$ref: "#/definitions/KeyValuePairs"
ResourceHandle: ResourceHandle:
required: required:
- resourceId - resourceId
......
...@@ -380,7 +380,7 @@ components: ...@@ -380,7 +380,7 @@ components:
description: | description: |
Identifier of the alarm. This identifier can be retrieved from the "id" attribute of the "alarm" attribute Identifier of the alarm. This identifier can be retrieved from the "id" attribute of the "alarm" attribute
in the AlarmNotification or AlarmClearedNotification. It can also be retrieved from the "id" attribute of in the AlarmNotification or AlarmClearedNotification. It can also be retrieved from the "id" attribute of
the applicable array element in the payload body of the response to a GET request to the "Alarms" resource. the applicable array element in the message content of the response to a GET request to the "Alarms" resource.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -393,7 +393,7 @@ components: ...@@ -393,7 +393,7 @@ components:
description: | description: |
Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved
from the "id" attribute in the payload body of that response. from the "id" attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -342,7 +342,7 @@ components: ...@@ -342,7 +342,7 @@ components:
Identifier of the VNF instance to which the VNF indicators applies. Identifier of the VNF instance to which the VNF indicators applies.
NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the
response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id"
attribute in the payload body of that response. attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -354,6 +354,8 @@ components: ...@@ -354,6 +354,8 @@ components:
in: path in: path
description: | description: |
Identifier of the VNF indicator. Identifier of the VNF indicator.
This identifier can be retrieved from the resource referenced by the message content in the response to a
POST request creating a new "Individual VNF instance" resource.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -367,7 +369,7 @@ components: ...@@ -367,7 +369,7 @@ components:
Identifier of this subscription. NOTE: Identifier of this subscription. NOTE:
This identifier can be retrieved from the resource referenced by the "Location" HTTP header This identifier can be retrieved from the resource referenced by the "Location" HTTP header
in the response to a POST request creating a new subscription resource. It can also be retrieved in the response to a POST request creating a new subscription resource. It can also be retrieved
from the "id" attribute in the payload body of that response. from the "id" attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -172,7 +172,7 @@ components: ...@@ -172,7 +172,7 @@ components:
content: content:
application/json: application/json:
schema: schema:
$ref: ./definitions/SOL002VNFLifecycleCoordination_def.yaml#/definitions/LcmCoordRequest $ref: ./definitions/SOL002VNFLCMCoordination_def.yaml#/definitions/LcmCoordRequest
required: true required: true
responses: responses:
...@@ -221,7 +221,7 @@ components: ...@@ -221,7 +221,7 @@ components:
content: content:
application/json: application/json:
schema: schema:
$ref: ./definitions/SOL002VNFLifecycleCoordination_def.yaml#/definitions/LcmCoord $ref: ./definitions/SOL002VNFLCMCoordination_def.yaml#/definitions/LcmCoord
Coordination_async.Post.202: Coordination_async.Post.202:
description: | description: |
...@@ -418,7 +418,7 @@ components: ...@@ -418,7 +418,7 @@ components:
content: content:
application/json: application/json:
schema: schema:
$ref: ./definitions/SOL002VNFLifecycleCoordination_def.yaml#/definitions/LcmCoord $ref: ./definitions/SOL002VNFLCMCoordination_def.yaml#/definitions/LcmCoord
LcmCoord.Get.202: LcmCoord.Get.202:
description: | description: |
......
...@@ -1316,7 +1316,7 @@ components: ...@@ -1316,7 +1316,7 @@ components:
description: | description: |
Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved
from the "id" attribute in the payload body of that response. from the "id" attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -1342,7 +1342,7 @@ components: ...@@ -1342,7 +1342,7 @@ components:
description: | description: |
Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from
the "id" attribute in the payload body of that response. the "id" attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -1355,7 +1355,7 @@ components: ...@@ -1355,7 +1355,7 @@ components:
description: | description: |
Identifier of the individual VNF snapshot resource. This identifier can be retrieved from the resource referenced by the Identifier of the individual VNF snapshot resource. This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a new VNF snapshot resource. It can also be "Location" HTTP header in the response to a POST request creating a new VNF snapshot resource. It can also be
retrieved from the "id" attribute in the payload body of that response. retrieved from the "id" attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -5,6 +5,9 @@ definitions: ...@@ -5,6 +5,9 @@ definitions:
VnfInstance: VnfInstance:
description: > description: >
This type represents a VNF instance. This type represents a VNF instance.
* NOTE: Clause B.3.2 provides examples illustrating the relationship among the different run-time
data types (CP, VL and link ports) used to represent the connectivity of a VNF.
* NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist * NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist
between the previous and the newly referred VNF package, i.e. when the new VNFD is between the previous and the newly referred VNF package, i.e. when the new VNFD is
changed with respect to the previous VNFD in other aspects than merely referencing changed with respect to the previous VNFD in other aspects than merely referencing
...@@ -1965,7 +1968,7 @@ definitions: ...@@ -1965,7 +1968,7 @@ definitions:
description: > description: >
Additional parameters passed by the NFVO as input to the scaling Additional parameters passed by the NFVO as input to the scaling
process, specific to the VNF being scaled, as declared in the VNFD process, specific to the VNF being scaled, as declared in the VNFD
as part of "ScaleVnfOpConfig" defined in ETSI GS NFV-IFA 011 [7]. as part of "ScaleVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs"
ScaleVnfToLevelRequest: ScaleVnfToLevelRequest:
...@@ -2001,7 +2004,7 @@ definitions: ...@@ -2001,7 +2004,7 @@ definitions:
description: > description: >
Additional parameters passed by the NFVO as input to the scaling Additional parameters passed by the NFVO as input to the scaling
process, specific to the VNF being scaled, as declared in the process, specific to the VNF being scaled, as declared in the
VNFD as part of "ScaleVnfToLevelOpConfig" defined in ETSI GS NFV-IFA 011 [7]. VNFD as part of "ScaleVnfToLevelOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs"
CancelMode: CancelMode:
...@@ -2722,14 +2725,6 @@ definitions: ...@@ -2722,14 +2725,6 @@ definitions:
description: > description: >
If present, this attribute signals the new value of the "vnfdVersion" attribute in "VnfInstance". See note 2. If present, this attribute signals the new value of the "vnfdVersion" attribute in "VnfInstance". See note 2.
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Version" $ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Version"
vimConnectionInfo:
description: >
If present, this attribute signals the changes to VIM connection info that were passed in the related
"ChangeCurrentVnfPkgRequest" structure. The provisions for sensitive information defined in clause
4.4.1.6 apply.
type: object
additionalProperties:
$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/VimConnectionInfo"
LcmOpOccNotificationVerbosityType: LcmOpOccNotificationVerbosityType:
description: > description: >
......
...@@ -495,7 +495,7 @@ components: ...@@ -495,7 +495,7 @@ components:
description: | description: |
Identifier of the PM job. This identifier can be retrieved from the resource referenced by the "Location" HTTP Identifier of the PM job. This identifier can be retrieved from the resource referenced by the "Location" HTTP
header in the response to a POST request creating a new PM job resource. It can also be retrieved from the "id" header in the response to a POST request creating a new PM job resource. It can also be retrieved from the "id"
attribute in the payload body of that response. attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -519,7 +519,7 @@ components: ...@@ -519,7 +519,7 @@ components:
description: | description: |
Identifier of the threshold. This identifier can be retrieved from the resource referenced by the "Location" Identifier of the threshold. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new threshold resource. It can also be retrieved from HTTP header in the response to a POST request creating a new threshold resource. It can also be retrieved from
the "id" attribute in the payload body of that response. the "id" attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -325,7 +325,7 @@ components: ...@@ -325,7 +325,7 @@ components:
Identifier of the alarm. Identifier of the alarm.
This identifier can be retrieved from the "id" attribute of the "alarm" attribute in the AlarmNotification or This identifier can be retrieved from the "id" attribute of the "alarm" attribute in the AlarmNotification or
AlarmClearedNotification. It can also be retrieved from the "id" attribute of the applicable array element in AlarmClearedNotification. It can also be retrieved from the "id" attribute of the applicable array element in
the payload body of the response to a GET request to the "Alarms" resource. the message content of the response to a GET request to the "Alarms" resource.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -340,7 +340,7 @@ components: ...@@ -340,7 +340,7 @@ components:
This identifier can be retrieved from the resource referenced by the This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a "Location" HTTP header in the response to a POST request creating a
new "Individual subscription" resource. It can also be retrieved from the "id" new "Individual subscription" resource. It can also be retrieved from the "id"
attribute in the payload body of that response. attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -343,7 +343,7 @@ components: ...@@ -343,7 +343,7 @@ components:
This identifier can be retrieved from the resource referenced by the This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a "Location" HTTP header in the response to a POST request creating a
new "Individual VNF instance" resource. It can also be retrieved from the "id" new "Individual VNF instance" resource. It can also be retrieved from the "id"
attribute in the payload body of that response. attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -356,7 +356,7 @@ components: ...@@ -356,7 +356,7 @@ components:
description: | description: |
Identifier of the VNF indicator. Identifier of the VNF indicator.
This identifier can be retrieved from the resource referenced by the This identifier can be retrieved from the resource referenced by the
payload body in the response to a POST request creating a new "Individual VNF message content in the response to a POST request creating a new "Individual VNF
instance" resource. instance" resource.
required: true required: true
style: simple style: simple
...@@ -372,7 +372,7 @@ components: ...@@ -372,7 +372,7 @@ components:
This identifier can be retrieved from the resource referenced by the This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a "Location" HTTP header in the response to a POST request creating a
new "Individual subscription" resource. It can also be retrieved from the "id" new "Individual subscription" resource. It can also be retrieved from the "id"
attribute in the payload body of that response. attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -1367,7 +1367,7 @@ components: ...@@ -1367,7 +1367,7 @@ components:
description: | description: |
Identifier of the VNF instance for the VNF snapshot to be reverted to. This identifier can be retrieved from the resource Identifier of the VNF instance for the VNF snapshot to be reverted to. This identifier can be retrieved from the resource
referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual VNF instance" resource. referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual VNF instance" resource.
It can also be retrieved from the "id" attribute in the payload body of that response. It can also be retrieved from the "id" attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -1393,7 +1393,7 @@ components: ...@@ -1393,7 +1393,7 @@ components:
description: | description: |
Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"
HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from
the "id" attribute in the payload body of that response. the "id" attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -1407,7 +1407,7 @@ components: ...@@ -1407,7 +1407,7 @@ components:
Identifier of the "Individual VNF snapshot" resource. This identifier can be retrieved Identifier of the "Individual VNF snapshot" resource. This identifier can be retrieved
from the resource referenced by the "Location" HTTP header in the response to a POST request from the resource referenced by the "Location" HTTP header in the response to a POST request
creating a new VNF snapshot resource. It can also be retrieved from the "id" attribute in creating a new VNF snapshot resource. It can also be retrieved from the "id" attribute in
the payload body of that response. the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -674,7 +674,7 @@ definitions: ...@@ -674,7 +674,7 @@ definitions:
This type represents a VNF instance. This type represents a VNF instance.
NOTE: Clause B.3.2 provides examples illustrating the relationship among the different run-time NOTE: Clause B.3.2 provides examples illustrating the relationship among the different run-time
information elements (CP, VL and link ports) used to represent the connectivity of a VNF. data types (CP, VL and link ports) used to represent the connectivity of a VNF.
NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist between NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist between
the previous and the newly referred VNF package, i.e. when the new VNFD is changed with the previous and the newly referred VNF package, i.e. when the new VNFD is changed with
......
...@@ -124,7 +124,7 @@ components: ...@@ -124,7 +124,7 @@ components:
This identifier can be retrieved from the resource referenced by the This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request granting a "Location" HTTP header in the response to a POST request granting a
new VNF lifecycle operation. It can also be retrieved from the "id" new VNF lifecycle operation. It can also be retrieved from the "id"
attribute in the payload body of that response. attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -890,7 +890,7 @@ components: ...@@ -890,7 +890,7 @@ components:
This identifier can be retrieved from the resource referenced by This identifier can be retrieved from the resource referenced by
the "Location" HTTP header in the response to a POST request the "Location" HTTP header in the response to a POST request
creating a new "Individual subscription" resource. It can also be retrieved from creating a new "Individual subscription" resource. It can also be retrieved from
the "id" attribute in the payload body of that response. the "id" attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -420,6 +420,7 @@ definitions: ...@@ -420,6 +420,7 @@ definitions:
Shall be present if the artifact is external to the package and shall be absent otherwise. Shall be present if the artifact is external to the package and shall be absent otherwise.
EXAMPLE: https://example.com/m%40ster.sh EXAMPLE: https://example.com/m%40ster.sh
See note.
type: array type: array
items: items:
$ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Uri" $ref: "../../General_Definitions/SOL003_def.yaml#/definitions/Uri"
......
...@@ -463,7 +463,7 @@ components: ...@@ -463,7 +463,7 @@ components:
This identifier can be retrieved from the resource referenced by the This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a "Location" HTTP header in the response to a POST request creating a
new "Individual PM job" resource. It can also be retrieved from the "id" new "Individual PM job" resource. It can also be retrieved from the "id"
attribute in the payload body of that response. attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -489,7 +489,7 @@ components: ...@@ -489,7 +489,7 @@ components:
This identifier can be retrieved from the resource referenced by the This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a "Location" HTTP header in the response to a POST request creating a
new "Individual threshold" resource. It can also be retrieved from the "id" new "Individual threshold" resource. It can also be retrieved from the "id"
attribute in the payload body of that response. attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
......
...@@ -194,7 +194,7 @@ components: ...@@ -194,7 +194,7 @@ components:
This identifier can be retrieved from the resource referenced by the This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a "Location" HTTP header in the response to a POST request creating a
new "Individual subscription" resource. It can also be retrieved from the "id" new "Individual subscription" resource. It can also be retrieved from the "id"
attribute in the payload body of that response. attribute in the message content of that response.
required: true required: true
style: simple style: simple
explode: false explode: false
...@@ -303,11 +303,11 @@ components: ...@@ -303,11 +303,11 @@ components:
Subscriptions.Post.422: Subscriptions.Post.422:
description: | description: |
422 Unprocessable Entity 422 Unprocessable Content
Shall be returned upon the following error: Shall be returned upon the following error:
The content type of the payload body is The content type of the message content is
supported and the payload body of a supported and the message content of a
request contains syntactically correct data request contains syntactically correct data
but the data cannot be processed. but the data cannot be processed.
The general cause for this error and its The general cause for this error and its
......
...@@ -77,14 +77,15 @@ components: ...@@ -77,14 +77,15 @@ components:
"ProblemDetails" structure to be returned. "ProblemDetails" structure to be returned.
If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect
query parameters or the payload body contains a syntactically incorrect data structure), query parameters or the message content contains a syntactically incorrect data structure),
the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, the API producer shall respond with this response code. More details are defined in IETF RFC 9110.
and should include in the "detail" attribute more information about the source of the problem. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more
information about the source of the problem.
If the response to a GET request which queries a container resource would be so big that the performance If the response to a GET request which queries a container resource would be so big that the performance
of the API producer is adversely affected, and the API producer does not support paging for the affected resource, of the API producer is adversely affected, and the API producer does not support paging for the affected resource,
it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include it shall respond with this response code. Clause 5.4.2.2 specifies provisions for the "ProblemDetails" structure