SOL005: fixes in VNF Pkg mgmt responses schema (c2bcc532) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerformanceManagement_def.yaml

+3 −3

Original line number	Diff line number	Diff line
		@@ -290,7 +290,7 @@ definitions:
		nsInstanceSubscriptionFilter:
		description: >
		Filter criteria to select NS instances about which to notify.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/NSInstanceSubscriptionFilter"
		$ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter"
		notificationTypes:
		description: >
		Match particular notification types.
		@@ -322,7 +322,7 @@ definitions:
		for the specified object instances. At least one
		of the two attributes (performance metric or
		group) shall be present.
		type: "array"
		type: array
		items:
		$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
		performanceMetricGroup:
		@@ -333,7 +333,7 @@ definitions:
		individual metrics. At least one of the two
		attributes (performance metric or group) shall
		be present.
		type: "array"
		type: array
		items:
		$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
		collectionPeriod:

src/SOL005/NSPerformanceManagementNotification/definitions/SOL005NSPerformanceManagementNotification_def.yaml

+1 −0

Original line number	Diff line number	Diff line
		# Copyright (c) ETSI 2017.
		# https://forge.etsi.org/etsi-forge-copyright-notice.txt

		definitions:
		PerformanceInformationAvailableNotification:
		description: >

src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml

+99 −140

Original line number	Diff line number	Diff line
		@@ -18,13 +18,13 @@ info:
		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"
		basePath: /vnfpkgm/v1
		schemes:
		- https
		consumes:
		- "application/json"
		- application/json
		produces:
		- "application/json"
		- application/json
		paths:
		###############################################################################
		# VNF Packages #
		@@ -39,41 +39,41 @@ paths:
		Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters,
		request and response data structures, and response codes.
		parameters:
		- name: "filter"
		in: "query"
		- name: filter
		in: query
		required: false
		type: "string"
		type: string
		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.
		All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
		be supported in attribute-based filtering parameters.
		- name: "all_fields"
		in: "query"
		- name: all_fields
		in: query
		required: false
		type: "string"
		type: string
		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"
		- name: fields
		in: query
		required: false
		type: "string"
		type: string
		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"
		- name: exclude_fields
		in: query
		required: false
		type: "string"
		type: string
		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"
		- name: exclude_default
		in: query
		required: false
		type: "string"
		type: string
		description: >
		Indicates to exclude the following complex attributes from the response. See clause 4.3.3
		for details.
		@@ -112,7 +112,7 @@ 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
		@@ -170,19 +170,13 @@ paths:
		in: header
		required: true
		type: string
		- name: "body"
		in: "body"
		- name: body
		in: body
		required: true
		schema:
		type: "object"
		required:
		- "CreateVnfPkgInfoRequest"
		properties:
		CreateVnfPkgInfoRequest:
		$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
		description: >
		IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2

		responses:
		201:
		description: >
		@@ -196,12 +190,10 @@ paths:
		header that contains the resource URI of the individual
		VNF package resource.
		schema:
		properties:
		VnfPkgInfo:
		$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
		headers:
		Content-Type:
		type: "string"
		type: string
		description: >
		The MIME type of the body of the response.This header
		field shall be present if the response has a non-empty message
		@@ -209,24 +201,25 @@ 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.
		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"
		- name: vnfPkgId
		description: >
		Identifier of the VNF package. The identifier is allocated by the NFVO.
		in: "path"
		type: "string"
		in: path
		type: string
		required: true
		get:
		summary: Read information about an individual VNF package.
		@@ -254,18 +247,15 @@ paths:

		Information of the VNF package.
		schema:
		type: "object"
		properties:
		VnfPkgInfo:
		$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
		headers:
		Content-Type:
		type: "string"
		type: string
		description: >
		The MIME type of the body of the response.This header
		field shall be present if the response has a non-empty message body.
		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
		@@ -290,6 +280,7 @@ paths:
		$ref: "../responses/SOL005_resp.yaml#/responses/500"
		503:
		$ref: "../responses/SOL005_resp.yaml#/responses/503"

		delete:
		summary: Delete an individual VNF package.
		description: >
		@@ -329,6 +320,7 @@ paths:
		$ref: "../responses/SOL005_resp.yaml#/responses/500"
		503:
		$ref: "../responses/SOL005_resp.yaml#/responses/503"

		patch:
		summary: Update information about an individual VNF package.
		description: >
		@@ -338,15 +330,10 @@ paths:
		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"
		- name: body
		in: body
		required: true
		schema:
		type: "object"
		required:
		- "VnfPkgInfoModifications"
		properties:
		VnfPkgInfoModifications:
		$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
		description: >
		Parameters for VNF package information modifications.
		@@ -380,7 +367,7 @@ 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
		@@ -481,7 +468,7 @@ 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
		@@ -515,12 +502,12 @@ paths:
		'/vnf_packages/{vnfPkgId}/package_content':
		#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5
		parameters:
		- name: "vnfPkgId"
		- name: vnfPkgI
		description: >
		Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
		in: "path"
		in: path
		required: true
		type: "string"
		type: string
		get:
		summary: Fetch an on-boarded VNF package.
		description: >
		@@ -543,10 +530,10 @@ paths:
		in: header
		required: false
		type: string
		- name: "Range"
		in: "header"
		- name: Range
		in: header
		required: false
		type: "string"
		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
		@@ -572,7 +559,7 @@ 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
		@@ -692,35 +679,20 @@ paths:
		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: "vnfPkgId"
		- name: vnfPkgId
		description: >
		Identifier of the VNF package. The identifier is allocated by the NFVO.
		in: "path"
		in: path
		required: true
		type: "string"

		- name: "body"
		in: "body"
		type: string
		- name: body
		in: body
		required: true
		schema:
		type: "object"
		required:
		- "UploadVnfPkgFromUriRequest"
		properties:
		UploadVnfPkgFromUriRequest:
		$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: >
		@@ -821,14 +793,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.
		maximum: 1
		minimum: 0

		206:
		description: >
		Partial Content.
		@@ -852,7 +823,7 @@ 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
		@@ -880,7 +851,7 @@ paths:
		503:
		$ref: "../responses/SOL005_resp.yaml#/responses/503"

		##############################################################################
		###############################################################################
		# Subscriptions #
		###############################################################################
		'/subscriptions':
		@@ -919,21 +890,15 @@ paths:
		in: header
		required: true
		type: string
		- name: "body"
		in: "body"
		- name: body
		in: body
		required: true
		schema:
		type: "object"
		required:
		- "PkgmSubscriptionRequest"
		properties:
		PkgmSubscriptionRequest:
		$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
		description: >
		Representation of the created subscription resource.
		The HTTP response shall include a "Location" HTTP header that
		points to the created subscription resource.

		responses:
		201:
		description: >
		@@ -949,7 +914,7 @@ 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
		@@ -959,8 +924,6 @@ paths:
		schema:
		type: array
		items:
		properties:
		PkgmSubscription:
		$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
		303:
		$ref: "../responses/SOL005_resp.yaml#/responses/303"
		@@ -991,10 +954,10 @@ paths:
		Tables 9.4.7.8.2-1 and 9.4.8.3.2-2 for URI query parameters,
		request and response data structures, and response codes.
		parameters:
		- name: "filter"
		in: "query"
		- name: filter
		in: query
		required: false
		type: "string"
		type: string
		description: >
		Attribute-based filtering parameters according to clause 4.3.2.
		The NFVO shall support receiving filtering parameters as part of the URI query
		@@ -1028,7 +991,7 @@ 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
		@@ -1038,8 +1001,6 @@ paths:
		schema:
		type: array
		items:
		properties:
		PkgmSubscription:
		$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
		400:
		$ref: "../responses/SOL005_resp.yaml#/responses/400"
		@@ -1109,7 +1070,7 @@ 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
		@@ -1117,8 +1078,6 @@ paths:
		maximum: 1
		minimum: 0
		schema:
		properties:
		PkgmSubscription:
		$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
		400:
		$ref: "../responses/SOL005_resp.yaml#/responses/400"
		@@ -1158,7 +1117,7 @@ paths:
		The subscription resource was deleted successfully.
		headers:
		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

src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml

+0 −5

Original line number	Diff line number	Diff line
		swagger: "2.0"

		info:
		version: "1.1.0"
		title: "SOL005 - VNF Package Management Notification interface"
		@@ -23,17 +22,13 @@ info:
		license:
		name: "ETSI Forge copyright notice"
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

		externalDocs:
		description: ETSI GS NFV-SOL 005 V2.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf

		basePath: /callback/v1

		schemes:
		- http
		- https

		consumes:
		- application/json
		produces:

src/SOL005/responses/SOL005_resp.yaml

+1 −0

Original line number	Diff line number	Diff line
		# Copyright (c) ETSI 2017.
		# https://forge.etsi.org/etsi-forge-copyright-notice.txt

		responses:
		206:
		description: >

Admin message