Commit 1174d87b authored by moscatelli's avatar moscatelli
Browse files

SOL003_204/SOL003_207/SOL003_208: VNF Packages methods updated

parent bbd4f366
Pipeline #1203 passed with stage
in 0 seconds
swagger: "2.0"
info:
version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL003 - VNF Package Management interface
description: >
SOL003 - VNF Package Management interface
......@@ -25,8 +25,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 003 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf
description: ETSI GS NFV-SOL 003 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf
basePath: "/vnfpkgm/v1"
......@@ -48,15 +48,14 @@ paths:
###############################################################################
# VNF packages #
###############################################################################
'/vnf_packages':
'/onboarded_vnf_packages':
#SOL003 location: 10.4.2
get:
description: >
Query VNF Package Info
The GET method queries the information of the VNF packages matching
the filter.
Query VNF Package Info.
The GET method queries the information of the VNF packages matching the filter.
This method shall follow the provisions specified in the tables 10.4.2.3.2-1 and 10.4.2.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Accept
description: >
......@@ -74,7 +73,7 @@ paths:
type: string
- name: filter
description: >
Attribute-based filtering expression according to clause 4.3.2.
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
The VNFM shall support receiving this parameter as part of the
URI query string. The NFVO may supply this parameter.
All attribute names that appear in the VnfPkgInfo and in data
......@@ -86,28 +85,28 @@ paths:
- name: all_fields
description: >
Include all complex attributes in the response.
See clause 4.3.3 for details. The VNFM shall support this parameter.
See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM shall support this parameter.
in: query
required: false
type: string
- name: fields
description: >
Complex attributes to be included into the response.
See clause 4.3.3 for details. The VNFM should support this parameter.
See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM should support this parameter.
in: query
required: false
type: string
- name: exclude_fields
description: >
Complex attributes to be excluded from the response.
See clause 4.3.3 for details. The VNFM should support this parameter.
See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM should support this parameter.
in: query
required: false
type: string
- name: exclude_default
description: >
Indicates to exclude the following complex attributes from the response.
See clause 4.3.3 for details. The VNFM shall support this parameter.
See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM shall support this parameter.
The following attributes shall be excluded from the VnfPkgInfo structure
in the response body if this parameter is provided, or none of the parameters
"all_fields," "fields", "exclude_fields", "exclude_default" are provided:
......@@ -120,7 +119,7 @@ paths:
- name: nextpage_opaque_marker
description: >
Marker to obtain the next page of a paged response. Shall be supported by the
VNFM if the VNFM supports alternative 2 (paging) according to clause 4.7.2.1
NFVO if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
for this resource.
in: query
required: false
......@@ -136,13 +135,16 @@ paths:
description: >
200 OK
Information about zero or more VNF packages was queried successfully.
The response body shall contain in an array the VNF package info
representations that match the attribute filter, i.e. zero or more
VNF package representations as defined in clause 10.5.2.2.
If the VNFM supports alternative 2 (paging) according to clause
4.7.2.1 for this resource, inclusion of the Link HTTP header in
this response shall follow the provisions in clause 4.7.2.3.
Shall be returned when information about zero or more VNF packages has been queried successfully.
The response body shall contain in an array the VNF package info representations that match the
attribute filter, i.e. zero or more VNF package info representations as defined in clause 10.5.2.2.
If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"
(if supported) or "exclude_default" URI parameters was supplied in the request, the data in the
response body shall have been transformed according to the rules specified in clauses 5.2.2 and
5.3.2 of ETSI GS NFV-SOL 013, respectively.
If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
headers:
Content-Type:
description: The MIME type of the body of the response.
......
Markdown is supported
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