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