Merge branch '5.3.1' into 'Release-5' (7364bfa4) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

Readme.md

+1 −1

Original line number	Diff line number	Diff line
		# NFV SOL002 and SOL003 APIs

		This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation
		for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v5.2.1.
		for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v5.3.1.

		The APIs described in this repository are defined for the following reference points:

src/SOL002/APIVersion/APIVersion.yaml

+2 −2

Original line number	Diff line number	Diff line
		@@ -19,8 +19,8 @@ info:
		version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

		externalDocs:
		description: ETSI GS NFV-SOL 002 V5.2.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.02.01_60/gs_NFV-SOL002v050201p.pdf
		description: ETSI GS NFV-SOL 002 V5.3.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.03.01_60/gs_NFV-SOL002v050301p.pdf

		paths:
		/vnfconfig/api_versions:

src/SOL002/General_Definitions/SOL002_def.yaml

+93 −28

Original line number	Diff line number	Diff line
		@@ -269,6 +269,11 @@ definitions:
		type: object
		additionalProperties:
		$ref: "#/definitions/Number"
		cpuPowerStateRequirements:
		description: >
		Requirements of virtual CPU power state configuration data for the OS container resource.
		$ref: "#/definitions/CpuPowerStateData"

		VirtualComputeDescData:
		description: >
		This type represents selected values for capacity related VDU attributes of the virtual compute resource of a VM.
		@@ -318,6 +323,50 @@ definitions:
		type: object
		additionalProperties:
		$ref: "#/definitions/Number"
		cpuPowerStateRequirements:
		description: >
		Requirements of virtual CPU power state configuration data for the virtual compute resource.
		$ref: "#/definitions/CpuPowerStateData"

		CpuPowerStateData:
		description: >
		This type provides virtual CPU power state configuration data for the virtual compute or OS container resource.

		* NOTE 1: In case the value of the cpuPowerStateManagementPolicy attribute
		is "DYNAMIC", dynamic adjustment of CPU power states of logical CPU cores
		should adhere to the range of CPU P and C states defined in the
		cpuOperationalPowerStates attribute.
		* NOTE 2: In case the value of the cpuPowerStateManagementPolicy attribute
		is "STATIC", the cpuOperationalPowerStates attribute shall contain only
		one set of CPU P and C states requested for the virtual CPU.
		If the value of the cpuPowerStateManagementPolicy attribute is
		"DYNAMIC", multiple CPU P and C states can be defined to indicate the
		range of allowed P/C state values during dynamic power state management.
		type: object
		required:
		- cpuPowerStateManagementPolicy
		properties:
		cpuPowerStateManagementPolicy:
		description: >
		Indicates the policy for CPU power state management.
		Permitted values:
		* STATIC
		* DYNAMIC
		In case of "STATIC", the virtual CPU cores are requested to be
		allocated to logical CPU cores according to the
		cpuOperationalPowerStates attribute.
		In case of "DYNAMIC", the CPU power states of virtual CPU cores
		can be allocated to logical CPU cores whose power states can be
		adjusted dynamically depending on core utilization (see note 1).
		type: string
		enum:
		- STATIC
		- DYNAMIC
		cpuOperationalPowerStates:
		description: >
		Provides the list of operational power states (i.e. P and C states)
		defined for the virtual CPU (see note 2).
		$ref: "#/definitions/KeyValuePairs"

		VirtualStorageDescData:
		description: >
		@@ -776,7 +825,19 @@ definitions:
		type: array
		items:
		$ref: "#/definitions/CpProtocolData"

		cpSecurityGroupData:
		description: >
		Parameters for modifying and overriding security groups
		information bound to this CP. The parameters identify
		which "SecurityGroupRule" specified in the VNFD is
		activated/deactivated and for an activated security group
		rule the values of attributes defined in the VNFD that can
		be overridden such as "portRangeMin" and "portRangeMax".
		If no security group configuration is provided for a given
		"SecurityGroupRule" specified in the VNFD as part of this
		attribute, the VNFM shall use the configuration as specified
		in the VNFD.
		$ref: "#/definitions/CpSecurityGroupData"
		netAttDefResourceId:
		description: >
		Identifier of the “NetAttDefResourceData” structure that
		@@ -838,6 +899,36 @@ definitions:
		the fully qualified domain names.
		type: string

		CpSecurityGroupData:
		description: >
		This type provides input parameters for modifying and overriding security groups.
		The parameters identify which "SecurityGroupRule" specified in the VNFD is activated/deactivated
		and for an activated security group rule the values of attributes defined in the VNFD that can be
		overriden such as "portRangeMin" and "portRangeMax".
		type: object
		required:
		- securityGroupRuleId
		properties:
		securityGroupRuleId:
		description: >
		Identifier of the security group rule policy in the VNFD.
		$ref: "#/definitions/IdentifierInVnfd"
		isActivated:
		description: >
		Indicates whether the rule is to be active (true) or inactive (false). If no attribute value
		is provided, the Security Group Rule is activated by default.
		type: boolean
		portRangeMin:
		description: >
		Value for the minimum port number in the range that is matched by the security group rule.
		The value shall be within the range "0 - 65535".
		type: integer
		portRangeMax:
		description: >
		Value for the maximum port number in the range that is matched by the security group rule.
		The value shall be within the range "0 - 65535".
		type: integer

		IpOverEthernetAddressData:
		description: >
		This type represents network address data for IP over Ethernet.
		@@ -1501,32 +1592,6 @@ definitions:
		Representation: string of variable length.
		type: string

		Checksum: #no definition found
		description: >
		Cheksum description
		type: string

		########################################################################################################################
		# TO CHECK IF INCLUDE THESE DATA TYPES IN ANOTHER DEF FILES

		VnfLinkPortData:
		description: >
		This type represents an externally provided link port to be used to connect a VNFC connection point
		to an exernally managed VL.
		type: object
		required:
		- vnfLinkPortId
		- resourceHandle
		properties:
		vnfLinkPortId:
		description: >
		Identifier of this link port as provided by the entity that has created the link port.
		$ref: "#/definitions/Identifier"
		resourceHandle:
		description: >
		Resource handle of the virtualised resource that realizes the link port.
		$ref: "#/definitions/ResourceHandle"

		ExtLinkPortData:
		description: >
		This type represents an externally provided link port to be used to

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+2 −4

Original line number	Diff line number	Diff line
		@@ -19,8 +19,8 @@ info:
		version: 1.12.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

		externalDocs:
		description: ETSI GS NFV-SOL 002 V5.2.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.02.01_60/gs_NFV-SOL002v050201p.pdf
		description: ETSI GS NFV-SOL 002 V5.3.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.03.01_60/gs_NFV-SOL002v050301p.pdf

		servers:
		- url: http://127.0.0.1/vnfconfig/v1
		@@ -89,8 +89,6 @@ paths:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		"412":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
		"416":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
		"422":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		"429":

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+45 −22

Original line number	Diff line number	Diff line
		@@ -19,8 +19,8 @@ info:
		version: 1.14.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

		externalDocs:
		description: ETSI GS NFV-SOL 002 V5.2.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.02.01_60/gs_NFV-SOL002v050201p.pdf
		description: ETSI GS NFV-SOL 002 V5.3.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.03.01_60/gs_NFV-SOL002v050301p.pdf

		servers:
		- url: http://127.0.0.1/vnffm/v1
		@@ -57,8 +57,6 @@ paths:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
		"406":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		"416":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
		"422":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		"429":
		@@ -96,8 +94,6 @@ paths:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
		"406":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		"416":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
		"422":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		"429":
		@@ -138,8 +134,6 @@ paths:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		"412":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
		"416":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
		"422":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		"429":
		@@ -177,8 +171,6 @@ paths:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
		"406":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		"416":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
		"422":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		"429":
		@@ -218,8 +210,6 @@ paths:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
		"406":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		"416":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
		"422":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		"429":
		@@ -256,10 +246,8 @@ paths:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
		"406":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		"416":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
		"422":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		$ref: '#/components/responses/Subscriptions.Post.422'
		"429":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
		"500":
		@@ -296,8 +284,6 @@ paths:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
		"406":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		"416":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
		"422":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		"429":
		@@ -327,8 +313,6 @@ paths:
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
		"406":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		"416":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
		"422":
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
		"429":
		@@ -346,7 +330,7 @@ components:
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI
		GS NFV-SOL 013 [6].
		GS NFV-SOL 013.
		The VNFM shall support receiving this parameter as part of the URI query
		string. The EM may supply this parameter. The VNF may supply its instance
		Id as an attribute filter.
		@@ -361,7 +345,7 @@ components:
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI
		GS NFV-SOL 013 [6].
		GS NFV-SOL 013.
		The VNFM shall support receiving this parameter as part of the URI query string. The
		EM may supply this parameter. The VNF may supply its instance Id as an attribute
		filter.
		@@ -699,6 +683,45 @@ components:
		schema:
		$ref: definitions/SOL002VNFFaultManagement_def.yaml#/definitions/FmSubscription

		Subscriptions.Post.422:
		description: \|
		422 Unprocessable Content

		Shall be returned upon the following error: The content type of the message content is supported
		and the message content of a request contains syntactically correct data but the data cannot be processed.
		The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
		including rules for the presence of the response body.
		Specifically in case of this resource, the response code 422 shall also be returned if the VNFM has tested
		the Notification endpoint as described in clause 7.4.7.3.2 and the test has failed.
		In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information
		about the error.
		headers:
		WWW-Authenticate:
		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.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: Version of the API used in the response.
		style: simple
		explode: false
		schema:
		type: string
		Content-Type:
		description: \|
		The MIME type of the body of the response. Reference: IETF RFC 7231
		style: simple
		explode: false
		schema:
		type: string
		content:
		application/json:
		schema:
		$ref: "../General_Definitions/SOL002_def.yaml#/definitions/ProblemDetails"

		IndividualSubscription.Get.200:
		description: \|
		200 OK