Skip to content
GitLab
Commit 3ced595f authored by Ayesha Ayub's avatar Ayesha Ayub
Browse files

fix issues in SOL003 APIs

parent c7a05648
Pipeline #13165 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
Readme.md
View file @ 3ced595f
# NFV SOL002 and SOL003 APIs
This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation
for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v3.6.1.
for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v3.7.1.
The APIs described in this repository are defined for the following reference points:
......
src/SOL003/APIVersion/APIVersion.yaml
View file @ 3ced595f
......@@ -20,8 +20,8 @@ info:
version: "1.0.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
paths:
/vrqan/api_versions:
......
src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml
View file @ 3ced595f
......@@ -16,7 +16,7 @@ info:
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
version: 1.5.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 003 V3.7.1
......
src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml
View file @ 3ced595f
......@@ -16,11 +16,11 @@ info:
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: "1.3.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
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 @ 3ced595f
......@@ -1607,20 +1607,14 @@ components:
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 [8],
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 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.
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: |
......@@ -3461,22 +3455,15 @@ components:
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
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 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
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 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: |
......@@ -3732,21 +3719,14 @@ components:
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 [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 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
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 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: |
......
src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml
View file @ 3ced595f
......@@ -61,7 +61,6 @@ definitions:
type: object
additionalProperties:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
localizationLanguage:
description: >
Localization language of the VNF to be instantiated. The value shall
......@@ -71,7 +70,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"." defined in ETSI GS NFV-IFA 011.
"InstantiateVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
......@@ -204,7 +203,7 @@ definitions:
additionalParams:
description: >
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.
declared in the VNFD as part of "ChangeVnfFlavourOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
......@@ -264,7 +263,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"." defined in ETSI GS NFV-IFA 011.
VNFD as part of "TerminateVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
HealVnfRequest:
......@@ -278,7 +277,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"." defined in ETSI GS NFV-IFA 011.
as part of "HealVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
OperateVnfRequest:
......@@ -316,7 +315,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"." defined in ETSI GS NFV-IFA 011.
declared in the VNFD as part of "OperateVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
ChangeExtVnfConnectivityRequest:
......@@ -356,9 +355,9 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
additionalParams:
description: >
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.
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:
......@@ -420,7 +419,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"." defined in ETSI GS NFV-IFA 011.
the VNFD as part of "ChangeCurrentVnfPkgOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
......@@ -596,7 +595,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"." defined in ETSI GS NFV-IFA 011.
“CreateSnapshotVnfOpConfig" defined in ETSI GS NFV-IFA 011.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
userDefinedData:
description: >
......@@ -638,7 +637,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"." defined in ETSI GS NFV-IFA 011.
“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:
......
src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml
View file @ 3ced595f
......@@ -16,7 +16,7 @@ info:
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: "2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
version: "2.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
externalDocs:
description: ETSI GS NFV-SOL 003 V3.7.1
......
src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml
View file @ 3ced595f
......@@ -1069,7 +1069,7 @@ 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
The message content shall contain a copy of the file representing the VNFD or
a ZIP file that contains the file or multiple files representing the VNFD,
as specified above.
The "Content-Type" HTTP header shall be set according to the format of the
......@@ -1340,7 +1340,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 messgae 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".
......@@ -1348,7 +1348,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/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml
View file @ 3ced595f
......@@ -16,11 +16,11 @@ info:
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 2.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
version: 2.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/v2
......
src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml
View file @ 3ced595f
......@@ -548,20 +548,14 @@ components:
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 [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 6.4.9.3.2 and the test has failed.
In this case, the "detail" attribute in the
"ProblemDetails" structure sh
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 6.4.9.3.2 and the test has failed.
In this case, the "detail" attribute in the "ProblemDetails" structure structure shall convey more
information about the error.
headers:
WWW-Authenticate:
description: |
......@@ -738,20 +732,14 @@ components:
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 [8],
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 6.4.9.3.2 and the test has failed.
In this case, the "detail" attribute in the
"ProblemDetails" structure shall convey more
information about the error.
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 6.4.9.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:
Content-Type:
description: |
......@@ -882,22 +870,14 @@ components:
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 [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 6.4.9.3.2 and the test has failed.
In this case, the "detail" attribute in the
"ProblemDetails" structure shall convey more
information about the error
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 6.4.9.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:
Content-Type:
description: |
......@@ -1080,22 +1060,14 @@ components:
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 [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 6.4.9.3.2 and the test has failed.
In this case, the "detail" attribute in the
"ProblemDetails" structure shall convey more
information about the error
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 6.4.9.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:
Content-Type:
description: |
......
src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml
View file @ 3ced595f
......@@ -16,7 +16,7 @@ info:
license:
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
version: 2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
description: ETSI GS NFV-SOL 003 V3.7.1
......
src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml
View file @ 3ced595f
......@@ -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:
......
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