Skip to content
GitLab
Commit c2d197ef authored by rameshnaraya's avatar rameshnaraya
Browse files

Fixed SOL005 v2.4.1 Review issues.

parent f8fedac8
Pipeline #323 pending with stage
Show whitespace changes
Inline Side-by-side
src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml
View file @ c2d197ef
swagger: "2.0"
info:
version: "2.4.1"
version: "1.0.0"
title: SOL005 - VNF Package Management Interface
description: >
SOL005 - VNF Package Management Interface
......@@ -19,15 +19,12 @@ externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/vnfpkgm/v1"
schemes:
- https
consumes:
- "application/json"
produces:
- "application/json"
paths:
###############################################################################
# VNF Packages #
......@@ -105,7 +102,8 @@ paths:
responses:
200:
description: >
200 OK.
200 OK
Information of the selected VNF packages.
headers:
Content-Type:
......@@ -114,11 +112,13 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
schema:
type: array
items:
......@@ -186,35 +186,52 @@ paths:
responses:
201:
description: >
"Status 201 - Created"
201 Created
"An individual VNF package resource has been created successfully.
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
in clause 9.5.2.4.
The HTTP response shall include a "Location" HTTP
header that contains the resource URI of the individual
VNF package resource."
VNF package resource.
schema:
properties:
VnfPkgInfo:
$ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
headers:
Location:
Content-Type:
type: "string"
description: >
"The HTTP response shall include a "Location" HTTP header
that contains the resource URI of the new NS descriptor resource."
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
maximum: 1
minimum: 1
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
###############################################################################
# Individual VNF Package #
###############################################################################
'/vnf_packages/{vnfPkgId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
parameters:
- name: "vnfPkgId"
description: >
Identifier of the VNF package. The identifier is allocated by the NFVO.
in: "path"
type: "string"
required: true
get:
summary: Read information about an individual VNF package.
description: >
"This resource represents an individual VNF package.
The client can use this resource to read information of the VNF
package, update information of the VNF package, or delete a VNF package."
The GET method reads the information of a VNF package.
parameters:
- name: Accept
description: >
......@@ -232,20 +249,16 @@ paths:
type: string
responses:
200:
description: 200 OK.
schema:
type: "object"
description: >
200 OK
Information of the VNF package.
schema:
type: "object"
properties:
VnfPkgInfo:
$ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
headers:
Location:
type: "string"
description: >
The HTTP response shall include a Location HTTP header
that contains the resource URI of the new NS descriptor resource.
Content-Type:
type: "string"
description: >
......@@ -257,6 +270,8 @@ paths:
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
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -278,7 +293,7 @@ paths:
delete:
summary: Delete an individual VNF package.
description: >
"The DELETE method deletes an individual NS descriptor resource.
The DELETE method deletes an individual VNF Package resource.
parameters:
- name: Authorization
description: >
......@@ -290,7 +305,7 @@ paths:
responses:
204:
description: >
204 No Content.
204 No Content
The VNF package was deleted successfully.
The response body shall be empty.
......@@ -349,11 +364,10 @@ paths:
in: header
required: true
type: string
responses:
200:
description: >
200 OK.
200 OK
The operation was completed successfully.
The response body shall contain attribute
......@@ -366,11 +380,11 @@ paths:
maximum: 1
minimum: 1
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.
type: string
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
schema:
......@@ -398,14 +412,6 @@ paths:
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
parameters:
- name: "vnfPkgId"
description: >
Identifier of the VNF package. The identifier is allocated by the NFVO.
in: "path"
required: true
type: "string"
###############################################################################
# VNFD in an individual VNF package #
###############################################################################
......@@ -458,7 +464,7 @@ paths:
responses:
200:
description: >
200 OK.
200 OK
On success, the content of the VNFD is returned.
The payload body shall contain a copy of the file
......@@ -475,11 +481,11 @@ paths:
maximum: 1
minimum: 1
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.
type: string
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
400:
......@@ -514,6 +520,13 @@ paths:
###############################################################################
'/vnf_packages/{vnfPkgId}/package_content':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5
parameters:
- name: "vnfPkgId"
description: >
Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
in: "path"
required: true
type: "string"
get:
summary: Fetch an on-boarded VNF package.
description: >
......@@ -528,7 +541,6 @@ paths:
required: true
type: string
enum:
- text/plain
- application/zip
- name: Authorization
description: >
......@@ -551,7 +563,7 @@ paths:
responses:
200:
description: >
200 OK.
200 OK
On success, a copy of the VNF package file is returned.
The response body shall include a copy of the VNF package file.
......@@ -566,11 +578,11 @@ paths:
maximum: 1
minimum: 1
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.
type: string
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
206:
......@@ -579,9 +591,7 @@ paths:
description: >
$ref: "responses/VNFPackageManagement_resp.yaml#/responses/409-state-conflict-ONBOARDING"
416:
description: >
"416 Range Not Satisfiable"
$ref: "responses/SOL005_resp.yaml#/responses/416-range-not-satisfiable"
$ref: "responses/SOL005_resp.yaml#/responses/416"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -609,6 +619,21 @@ paths:
consumes:
- 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
......@@ -621,7 +646,7 @@ paths:
responses:
202:
description: >
202 Accepted.
202 Accepted
The VNF package was accepted for uploading, but the
processing has not been completed. It is expected to
......@@ -646,13 +671,6 @@ paths:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
parameters:
- name: "vnfPkgId"
description: >
Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
in: "path"
required: true
type: "string"
###############################################################################
# Upload VNF package from URI task #
......@@ -662,9 +680,10 @@ paths:
post:
summary: Upload a VNF package by providing the address information of the VNF package.
description: >
This task resource represents the "Upload VNF package from URI" operation. The client can use this resource to
request the uploading of a VNF package by providing address information to the NFVO for retrieving the content of the
VNF package.
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: >
......@@ -712,7 +731,7 @@ paths:
responses:
202:
description: >
202 Accepted.
202 Accepted
The information about the VNF package was received
successfully, but the on-boarding has not been
......@@ -741,11 +760,12 @@ paths:
# Individual VNF package artifact #
###############################################################################
'/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.6
#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
......@@ -793,8 +813,7 @@ paths:
responses:
200:
description: >
200 OK.
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.
......@@ -803,16 +822,23 @@ paths:
determined, the header shall be set to the value
"application/octet-stream".
headers:
WWW-Authenticate:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
206:
description: >
Partial Content.
On success, if the NFVO supports range requests, a single
consecutive byte range from the content of the VNF package file is
returned.
......@@ -823,12 +849,23 @@ paths:
The "Content-Type" HTTP header shall be set as defined above for
the "200 OK" response.
headers:
WWW-Authenticate:
Content-Range:
type: string
maximum: 1
minimum: 1
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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.
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -850,10 +887,11 @@ paths:
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
##############################################################################
# Subscriptions #
###############################################################################
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.8
post:
summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
description: >
......@@ -906,7 +944,7 @@ paths:
responses:
201:
description: >
201 Created.
201 Created
Representation of the created subscription resource.
The HTTP response shall include a "Location"
......@@ -918,11 +956,13 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
schema:
type: array
items:
......@@ -950,8 +990,7 @@ paths:
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
get:
summary: >
Query multiple subscriptions.
summary: Query multiple subscriptions.
description: >
The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used
e.g. for resynchronization after error situations.
......@@ -986,7 +1025,7 @@ paths:
responses:
200:
description: >
200 OK.
200 OK
Active subscriptions of the functional block that invokes the method.
headers:
......@@ -996,11 +1035,13 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
schema:
type: array
items:
......@@ -1030,7 +1071,7 @@ paths:
# Individual subscription #
###############################################################################
'/subscriptions/{subscriptionId}':
#SOL003 location: 10.4.8
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.9
parameters:
- name: subscriptionId
description: >
......@@ -1043,8 +1084,7 @@ paths:
type: string
required: true
get:
summary: >
Read an individual subscription resource.
summary: Read an individual subscription resource.
description: >
Query Subscription Information
The GET method reads an individual subscription.
......@@ -1066,7 +1106,7 @@ paths:
responses:
200:
description: >
200 OK.
200 OK
Representation of the subscription resource.
headers:
......@@ -1076,14 +1116,16 @@ paths:
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
schema:
properties:
NsdInfo:
PkgmSubscription:
$ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
......@@ -1104,8 +1146,7 @@ paths:
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
delete:
summary: >
Terminate a subscription.
summary: Terminate a subscription.
description: >
The DELETE method terminates an individual subscription.
parameters:
......@@ -1119,16 +1160,16 @@ paths:
responses:
204:
description: >
No Content.
No Content
The subscription resource was deleted successfully.
headers:
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.
type: string
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
400:
......@@ -1150,44 +1191,30 @@ paths:
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
##################################################################################
# Notification endpoint #
# "/notification_endpoint" is the #
# is the dummy URI used for testing, in real case endpoint URI has to #
# provided by client. #
###############################################################################
'/notification_endpoint':
#SOL005 location: 8.2-1
# Dummy URI is used for testing. #
# In real, resource URI is provided by the client when creating the subscription.#
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageOnboardingNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.10
post:
summary: >
Notify about VNF package on boarding or change.
summary: Notify about VNF package onboarding or change
description: >
The POST method delivers a notification from the server to the client.
This method shall follow the provisions specified in the
Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters,
request and response data structures, and response codes.
# Don't know how to pass multiple body parameters in the POST request.
# Jenkin build is failing if enable more than one body parameters, So commented body parameters.
parameters:
- name: VnfPackageOnboardingNotification
description: >
Notification about performance information availability.
A notification about on-boarding of a VNF package.
in: body
required: true
schema:
properties:
VnfPackageOnboardingNotification:
$ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPackageOnboardingNotification"
#- name: VnfPackageChangeNotification
# description: >
# Notification about threshold crossing.
# in: body
# required: true
# schema:
# properties:
# VnfPackageChangeNotification: