Skip to content
GitLab
Commit c7a05648 authored by ishaqm's avatar ishaqm
Browse files

Updated SOL003 APIs

parent 96a1ff75
Pipeline #13159 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml
View file @ c7a05648
......@@ -672,23 +672,16 @@ components:
Subscriptions.Post.422:
description: |
422 Unprocessable Entity
422 Unprocessable Content
Shall be returned upon the following error: The
content type of the payload body is supported
and the payload body of a request contains
syntactically correct data but the data cannot be
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 [8], 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 7.4.6.3.2 and the test has failed.
In this case, the "detail" attribute in the
"ProblemDetails" structure shall convey more
The general cause for this error and its handling is specified in clause 6.4 of ETSI
GS NFV-SOL 013 [8], 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 7.4.6.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:
Version:
......
src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml
View file @ c7a05648
......@@ -38,7 +38,7 @@ definitions:
properties:
id:
description: >
Identifier of this Alarm information element.
Identifier of this Alarm.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
managedObjectId:
description: >
......
src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml
View file @ c7a05648
......@@ -19,8 +19,8 @@ info:
version: 1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 003 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.06.01_60/gs_NFV-SOL003v030601p.pdf
description: ETSI GS NFV-SOL 003 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.07.01_60/gs_NFV-SOL003v030701p.pdf
servers:
- url: http://127.0.0.1/callback/v1
......
src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml
View file @ c7a05648
......@@ -1605,11 +1605,11 @@ components:
VNFInstances.Post.422:
description: |
422 Unprocessable Entity
422 Unprocessable Content
Shall be returned upon the following error: The content
type of the payload body is supported and the payload
body of a request contains syntactically correct data
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 [8],
......@@ -1620,7 +1620,7 @@ components:
"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 erro
more information about the error.
headers:
WWW-Authenticate:
description: |
......@@ -2916,7 +2916,7 @@ components:
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response shall have an empty payload body.
The response shall have an empty message content.
headers:
WWW-Authenticate:
description: |
......@@ -3027,7 +3027,7 @@ components:
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response shall have an empty payload body.
The response shall have an empty message content.
headers:
WWW-Authenticate:
description: |
......@@ -3264,7 +3264,7 @@ components:
202 ACCEPTED
Shall be returned when the request has been accepted for processing.
The response shall have an empty payload body.
The response shall have an empty message content.
headers:
WWW-Authenticate:
description: |
......@@ -3459,11 +3459,11 @@ components:
Subscriptions.Post.422:
description: |
422 Unprocessable Entity
422 Unprocessable Content
Shall be returned upon the following error: The
content type of the payload body is supported
and the payload body of a request contains
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
......@@ -3730,11 +3730,11 @@ components:
CreateVnfSnapshotTask.Post.422:
description: |
422 Unprocessable Entity
422 Unprocessable Content
Shall be returned upon the following error: The
content type of the payload body is supported and
the payload body of a request contains syntactically
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
......@@ -4206,7 +4206,7 @@ components:
Shall be returned when the whole content of the VNF state snapshot file has been read successfully.
The payload body shall contain a copy of the VNF state snapshot file and the "Content-Type" HTTP
The message content shall contain a copy of the VNF state snapshot file and the "Content-Type" HTTP
header shall be set according to the content type of the VNF state snapshot file. If the VNF state
snapshot content is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193).
......@@ -4250,7 +4250,7 @@ components:
header shall be set according to the content type of the VNF state snapshot file. If the content type cannot
be determined, the header shall be set to the value "application/octet-stream".
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
headers:
WWW-Authenticate:
description: |
......
src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml
View file @ c7a05648
......@@ -71,7 +71,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: >
......@@ -203,9 +203,8 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
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: >
......@@ -265,7 +264,7 @@ definitions:
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".
VNFD as part of "TerminateVnfOpConfig"." defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
HealVnfRequest:
......@@ -279,7 +278,7 @@ definitions:
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".
as part of "HealVnfOpConfig"." defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
OperateVnfRequest:
......@@ -317,7 +316,7 @@ definitions:
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".
declared in the VNFD as part of "OperateVnfOpConfig"." defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
ChangeExtVnfConnectivityRequest:
......@@ -357,9 +356,9 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
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 NFVO 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:
......@@ -421,7 +420,7 @@ definitions:
description: >
Additional parameters passed by the NFVO 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".
the VNFD as part of "ChangeCurrentVnfPkgOpConfig"." defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
......@@ -597,7 +596,7 @@ definitions:
description: >
Additional input parameters for the snapshot creation process, specific
for the VNF being “snapshotted”, as declared in the VNFD as part of
“CreateSnapshotVnfOpConfig”.
“CreateSnapshotVnfOpConfig"." defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
userDefinedData:
description: >
......@@ -639,7 +638,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”.
“reverted”, as declared in the VNFD as part of “RevertToSnapshotVnfOpConfig"." defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfSnapshotInfoModificationRequest:
......@@ -774,7 +773,7 @@ definitions:
Configurable properties referred in these attributes are declared in the VNFD. The declaration
of configurable properties in the VNFD can optionally contain the specification of initial values.
See notes 2, 3 and 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
not declared in the 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
......@@ -940,7 +939,7 @@ definitions:
All extensions that are allowed for the VNF are declared in the VNFD. The declaration of an extension
in the VNFD contains information on whether its presence is optional or required, and optionally can
specify an initial value. See notes 2 and 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
that are not declared in the VNFD with a "422 Unprocessable 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
......
src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml
View file @ c7a05648
......@@ -19,8 +19,8 @@ info:
version: "2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
externalDocs:
description: ETSI GS NFV-SOL 003 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.06.01_60/gs_NFV-SOL003v030601p.pdf
description: ETSI GS NFV-SOL 003 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.07.01_60/gs_NFV-SOL003v030701p.pdf
servers:
- url: http://127.0.0.1/callback/v2
......
src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml
View file @ c7a05648
......@@ -1146,12 +1146,9 @@ components:
200 OK
Shall be returned when the content of the VNFD has been read successfully.
The payload body shall contain a copy of the file representing the VNFD or
a ZIP file that contains the file or multiple files representing the VNFD,
The message content shall contain a ZIP archive that contains the files representing the VNFD,
as specified above.
The "Content-Type" HTTP header shall be set according to the format of the
returned file, i.e. to "text/plain" for a YAML file or to "application/zip"
for a ZIP file.
The "Content-Type" HTTP header shall be set to "application/zip".
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -1225,7 +1222,7 @@ components:
Shall be returned when the content of the manifest has been read successfully.
If the "include_signatures" URI query parameter was absent in the request,
or if the manifest file has all security-related information embedded
(i.e. there is no separate certificate file), the payload body shall contain
(i.e. there is no separate certificate file), the message content shall contain
a copy of the manifest file of the VNF package and the "Content-Type" HTTP
header shall be set to "text/plain".
......@@ -1233,7 +1230,7 @@ components:
request and the manifest file does not have all the security-related
information embedded (i.e. there is a separate certificate file),
the "Content-Type" HTTP header shall be set to "application/zip and the
payload body shall contain a ZIP archive which includes:
message content shall contain a ZIP archive which includes:
• a copy of the manifest file of the VNF package;
• a copy of the related individual certificate file.
headers:
......
src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml
View file @ c7a05648
......@@ -546,11 +546,11 @@ components:
PmJobs.Post.422:
description: |
422 Unprocessable Entity
422 Unprocessable Content
Shall be returned upon the following error: The
content type of the payload body is supported and
the payload body of a request contains syntactically
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 [8],
......@@ -736,11 +736,11 @@ components:
IndividualPmJob.Patch.422:
description: |
422 Unprocessable Entity
422 Unprocessable Content
Shall be returned upon the following error: The
content type of the payload body is supported and the
payload body of a request contains syntactically
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 [8],
......@@ -880,11 +880,11 @@ components:
Thresholds.Post.422:
description: |
422 Unprocessable Entity
422 Unprocessable Content
Shall be returned upon the following error: The
content type of the payload body is supported and
the payload body of a request contains
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
......@@ -1078,11 +1078,11 @@ components:
IndividualThreshold.Patch.422:
description: |
422 Unprocessable entity
422 Unprocessable Content
Shall be returned upon the following error: The
content type of the payload body is supported and
the payload body of a request contains
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
......
src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml
View file @ c7a05648
......@@ -19,8 +19,8 @@ info:
version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 003 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.06.01_60/gs_NFV-SOL003v030601p.pdf
description: ETSI GS NFV-SOL 003 V3.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.07.01_60/gs_NFV-SOL003v030701p.pdf
servers:
- url: http://127.0.0.1/callback/v2
......
src/SOL003/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml
View file @ c7a05648
......@@ -408,7 +408,7 @@ components:
from the content of the VNF snapshot package file has been read successfully according to the request.
The response body shall contain the requested part of the VNF snapshot package file. The "Content-Range"
HTTP header shall be provided according to IETF RFC 7233. The "Content-Type" HTTP header shall be set as
HTTP header shall be provided according to IETF RFC 9110. The "Content-Type" HTTP header shall be set as
defined above for the "200 OK" response.
headers:
Version:
......@@ -550,7 +550,7 @@ components:
IndividualArtifact.Get.206:
description: |
2006 PARTIAL CONTENT
206 PARTIAL CONTENT
If the NFVO supports range requests, this response shall be returned when a single consecutive byte range
from the content of the artifact file has been read successfully according to the request.
......@@ -561,7 +561,7 @@ components:
The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the
content type cannot be determined, the header shall be set to the value "application/octet-stream".
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
headers:
Version:
description: The used API version.
......
src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml
View file @ c7a05648
......@@ -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" defined in ETSI GS NFV-IFA 011.
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" defined in ETSI GS NFV-IFA 011.
VNFD as part of "ScaleVnfToLevelOpConfig-" defined in ETSI GS NFV-IFA 011.
$ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfInfoModificationRequest:
......@@ -1087,7 +1087,7 @@ definitions:
properties:
cpInstanceId:
description: >
Identifier of this VIP CP instance and of this VipCpInfo.
Identifier of this VIP CP instance and of this VipCpInfo structure.
$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
......
src/definitions/SOL002SOL003_def.yaml
View file @ c7a05648
......@@ -239,10 +239,10 @@ definitions:
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
message content, 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
If the VimConnectionInfo structure is part of an HTTP request message content,
sensitive attributes that are children of this attribute (such
as passwords) shall be present if they have not been provisioned out
of band.
......@@ -330,7 +330,7 @@ definitions:
Map of instance data that need to be configured on the CP instances
created from the respective CPD.
The key of the map which identifies the individual VnfExtCpConfig entries is of type "IdentifierInVnf"
and is managed by the API consumer.
and is managed by the NFVO.
The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396).
See notes 2, 3 and 4.
type: object
......@@ -357,7 +357,7 @@ definitions:
a pre created link port, and the VNFM can use means outside the scope of the present document to obtain
the pre-configured address information for the connection point from the resource representing
the link port.
5) If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that the
5) If both "cpProtocolData" and "linkportId" are provided, the NFVO shall ensure that the
cpProtocolData can be used with the pre-created link port referenced by "linkPortId".
anyOf:
- required:
......
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