Commit ce906647 authored by moscatelli's avatar moscatelli

SOL005: fix in NS Lifecycle mgmt data types

parent 30dec88e
Pipeline #793 failed with stage
in 0 seconds
......@@ -413,13 +413,13 @@ definitions:
subscription:
description: >
Link to the subscription that triggered this notification.
$ref: ""../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
nslcmOpOcc:
description: >
Link to the lifecycle operation occurrence that this
notification is related to. Shall be present if there is a
related lifecycle operation occurrence
$ref: ""../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
Version:
description: >
......@@ -926,7 +926,7 @@ definitions:
- LEAST_RESPONSE_TIME
- CHAINED_FAILOVER
- SOURCE_IP_HASH
- SOURCE_MAC_HASH
- SOURCE_MAC_HASH
algorithmWeights:
description: >
Percentage of messages sent to a CP instance. May be included if applicable to
......@@ -1622,7 +1622,7 @@ definitions:
nsProfileId:
description: >
Identifier of a NsProfile to which the additional parameters apply.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
additionalParam:
description: >
Additional parameters that are to be applied on a per nested NS instance.
......@@ -1739,7 +1739,7 @@ definitions:
required:
- nestedNsInstanceId
properties:
nestedNsInstanceId:
nestedNsInstanceId:
description: >
Identifier of the existing nested NS instance to be used in the NS.
$ref: "SOL005_def.yaml#/definitions/Identifier"
......
......@@ -13,7 +13,7 @@ info:
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1
......@@ -26,14 +26,14 @@ consumes:
produces:
- application/json
paths:
###############################################################################
# VNF Packages #
###############################################################################
###############################################################################
# VNF Packages #
###############################################################################
'/vnf_packages':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
get:
summary: Query VNF packages information.
description: >
description: >
The GET method queries the information of the VNF packages matching the filter.
This method shall follow the provisions specified in the
Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters,
......@@ -43,7 +43,7 @@ paths:
in: query
required: false
type: string
description: >
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query string. The
OSS/BSS may supply filtering parameters.
......@@ -53,28 +53,28 @@ paths:
in: query
required: false
type: string
description: >
description: >
Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
shall support this parameter.
- name: fields
in: query
required: false
type: string
description: >
description: >
Complex attributes to be included into the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
- name: exclude_fields
in: query
required: false
type: string
description: >
description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
- name: exclude_default
in: query
required: false
type: string
description: >
description: >
Indicates to exclude the following complex attributes from the response. See clause 4.3.3
for details.
The NFVO shall support this parameter.
......@@ -98,12 +98,12 @@ paths:
Reference: IETF RFC 7235
in: header
required: false
type: string
type: string
responses:
200:
description: >
200 OK
Information of the selected VNF packages.
headers:
Content-Type:
......@@ -111,14 +111,14 @@ paths:
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
minimum: 0
schema:
type: array
items:
......@@ -146,42 +146,42 @@ paths:
post:
summary: Create a new individual VNF package resource.
description: >
description: >
The POST method creates a new individual VNF package resource.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
description: >
IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
description: >
IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
responses:
201:
description: >
description: >
201 Created
An individual VNF package resource has been created successfully.
The response body shall contain a representation of
the new individual VNF package resource, as defined
......@@ -199,7 +199,7 @@ paths:
field shall be present if the response has a non-empty message
body.
maximum: 1
minimum: 1
minimum: 1
WWW-Authenticate:
type: string
description: >
......@@ -223,7 +223,7 @@ paths:
required: true
get:
summary: Read information about an individual VNF package.
description: >
description: >
The GET method reads the information of a VNF package.
parameters:
- name: Accept
......@@ -239,12 +239,12 @@ paths:
Reference: IETF RFC 7235
in: header
required: false
type: string
type: string
responses:
200:
description: >
200 OK
Information of the VNF package.
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
......@@ -283,7 +283,7 @@ paths:
delete:
summary: Delete an individual VNF package.
description: >
description: >
The DELETE method deletes an individual VNF Package resource.
parameters:
- name: Authorization
......@@ -292,12 +292,12 @@ paths:
Reference: IETF RFC 7235
in: header
required: false
type: string
type: string
responses:
204:
description: >
204 No Content
The VNF package was deleted successfully.
The response body shall be empty.
409:
......@@ -323,39 +323,39 @@ paths:
patch:
summary: Update information about an individual VNF package.
description: >
description: >
"The PATCH method updates the information of a VNF package."
"This method shall follow the provisions specified in the
Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query parameters,
request and response data structures, and response codes."
parameters:
- name: body
in: body
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
description: >
Parameters for VNF package information modifications.
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
- name: body
in: body
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
description: >
Parameters for VNF package information modifications.
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
200:
description: >
200 OK
The operation was completed successfully.
The response body shall contain attribute
modifications for an "Individual VNF
......@@ -376,7 +376,7 @@ paths:
minimum: 0
schema:
properties:
VnfPkgInfoModifications:
VnfPkgInfoModifications:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
......@@ -398,7 +398,7 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# VNFD in an individual VNF package #
###############################################################################
......@@ -410,12 +410,12 @@ paths:
Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
in: path
type: string
required: true
required: true
get:
summary: Read VNFD of an on-boarded VNF package.
description: >
description: >
The GET method reads the content of the VNFD within a VNF package.
The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the
form of multiple files, a ZIP file embedding these files shall be returned. If the VNFD is implemented as a single file,
either that file or a ZIP file embedding that file shall be returned.
......@@ -432,25 +432,25 @@ paths:
This method shall follow the provisions specified in the Tables 9.4.4.3.2-1 and 9.4.4.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- application/zip
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- application/zip
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
200:
description: >
description: >
200 OK
On success, the content of the VNFD is returned.
......@@ -495,7 +495,7 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# VNF Package Content #
###############################################################################
......@@ -510,40 +510,40 @@ paths:
type: string
get:
summary: Fetch an on-boarded VNF package.
description: >
description: >
The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.
This method shall follow the provisions specified in the Tables 9.4.5.3.2-1 and 9.4.5.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- application/zip
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Range
in: header
required: false
type: string
description: >
The request may contain a "Range" HTTP header to obtain single
range of bytes from the VNF package file. This can be used to
continue an aborted transmission.
If the NFVO does not support range requests, it should return the
whole file with a 200 OK response instead.
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- application/zip
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Range
in: header
required: false
type: string
description: >
The request may contain a "Range" HTTP header to obtain single
range of bytes from the VNF package file. This can be used to
continue an aborted transmission.
If the NFVO does not support range requests, it should return the
whole file with a 200 OK response instead.
responses:
200:
description: >
description: >
200 OK
On success, a copy of the VNF package file is returned.
......@@ -588,52 +588,52 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
put:
summary: Upload a VNF package by providing the content of the VNF package.
description: >
description: >
The PUT method uploads the content of a VNF package.
This method shall follow the provisions specified in the
Tables 9.4.5.3.3-1 and 9.4.5.3.3-2 for URI query parameters,
request and response data structures, and response codes.
consumes:
- multipart/form-data
- multipart/form-data
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- application/zip
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- in: formData
name: file
required: false
type: file
description: >
The payload body contains a ZIP file that represents the VNF package.
The "Content-Type" HTTP header shall be set according to the
type of the file, i.e. to "application/zip" for a VNF Package as
defined in ETSI GS NFV-SOL 004 [5].
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- application/zip
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- in: formData
name: file
required: false
type: file
description: >
The payload body contains a ZIP file that represents the VNF package.
The "Content-Type" HTTP header shall be set according to the
type of the file, i.e. to "application/zip" for a VNF Package as
defined in ETSI GS NFV-SOL 004 [5].
responses:
202:
description: >
description: >
202 Accepted
The VNF package was accepted for uploading, but the
processing has not been completed. It is expected to
take some time for processing.
The response body shall be empty.
409:
description: >
description: >
$ref: "../responses/SOL005_resp.yaml#/responses/409"
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
......@@ -659,45 +659,45 @@ paths:
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.6
post:
summary: Upload a VNF package by providing the address information of the VNF package.
description: >
description: >
The POST method provides the information for the NFVO to get the content of a VNF package.
This method shall follow the provisions specified in the
Tables 9.4.6.3.1-1 and 9.4.6.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: vnfPkgId
description: >
Identifier of the VNF package. The identifier is allocated by the NFVO.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest"
description: >
The payload body contains the address information based on
which the NFVO can obtain the content of the VNF package.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: vnfPkgId
description: >
Identifier of the VNF package. The identifier is allocated by the NFVO.
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest"
description: >
The payload body contains the address information based on
which the NFVO can obtain the content of the VNF package.
responses:
202:
description: >
202 Accepted
The information about the VNF package was received
successfully, but the on-boarding has not been
completed. It is expected to take some time for processing.
......@@ -720,145 +720,145 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual VNF package artifact #
###############################################################################
'/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.7
parameters:
- name: vnfPkgId
description: >
Identifier of the on-boarded VNF package.
The identifier is allocated by the NFVO.
This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or
VnfPackageChangeNotification.
in: path
type: string
required: true
- name: artifactPath
description: >
Path of the artifact within the VNF package.
This identifier can be retrieved from the "artifactPath" attribute of the applicable "additionalArtifacts" entry in
the body of the response to a GET request querying the "Individual VNF package" or the "VNF packages"
resource.
in: path
type: string
required: true
get:
summary: Fetch individual VNF package artifact.
description: >
The GET method fetches the content of an artifact within a VNF package.
This method shall follow the provisions specified in the
Tables 9.4.7.3.2-1 and 9.4.7.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Range
description: >
The request may contain a "Range" HTTP header to obtain single
range of bytes from the VNF package file. This can be used to
continue an aborted transmission.
If the NFVO does not support range requests, it should return the
whole file with a 200 OK response instead.
in: header
type: string
responses:
200:
description: >
200 OK
On success, the content of the artifact is returned.
The payload body shall contain a copy of the artifact file from
the VNF package, as defined by ETSI GS NFV-SOL 004.
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".
headers:
Content-Type: