Merge branch '4.3.1-dev' into 'Release-4' (340d43dc) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

Readme.md

+2 −2

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 v3.6.1.
		for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v4.3.1.

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

		@@ -35,7 +35,7 @@ and the results will be stored in a `build/` directory in the project folder.

		## How to raise issues

		Change requests can be filed at [ETSI Forge Bugzilla](forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=62&product=NFV). Please report errors, bugs or other issues [here](https://forge.etsi.org/bugzilla/enter_bug.cgi?product=NFV).
		Please report errors, bugs or other issues [here](https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/issues).

		## How to contribute

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 V3.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf
		description: ETSI GS NFV-SOL 002 V4.3.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.03.01_60/gs_NFV-SOL002v040301p.pdf

		paths:
		/vnfconfig/api_versions:

src/definitions/SOL002SOL003_def.yaml→src/SOL002/General_Definitions/SOL002_def.yaml

+325 −110

File changed and moved.

Preview size limit exceeded, changes collapsed.

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+38 −4

Original line number	Diff line number	Diff line
		@@ -16,11 +16,11 @@ info:
		license:
		name: ETSI Forge copyright notice
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
		version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

		externalDocs:
		description: ETSI GS NFV-SOL 002 V3.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.06.01_60/gs_NFV-SOL002v030601p.pdf
		description: ETSI GS NFV-SOL 002 V4.3.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/04.03.01_60/gs_NFV-SOL002v040301p.pdf

		servers:
		- url: http://127.0.0.1/vnfconfig/v1
		@@ -67,6 +67,9 @@ paths:
		patch:
		description: \|
		This method sets or modifies a configuration resource. See clause 9.4.2.3.4.
		parameters:
		- $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Unmodified-Since
		- $ref: ../../components/SOL002_params.yaml#/components/parameters/If-Match
		requestBody:
		$ref: '#/components/requestBodies/ConfigurationRequest'
		responses:
		@@ -132,11 +135,27 @@ components:
		schema:
		type: string
		Content-Type:
		description: The MIME type of the body of the response.
		description: >
		The MIME type of the body of the response.
		style: simple
		explode: false
		schema:
		type: string
		ETag:
		description: >
		Used to provide the current entity-tag for the selected resource representation. It can be sent in
		"200 OK", "201 Created" and "204 No Content" responses.
		style: simple
		schema:
		type: string
		Last-Modified:
		description: >
		Used to provide a timestamp indicating the date and time at which the server believes the selected resource
		representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses.
		style: simple
		schema:
		type: string
		format: date-time
		content:
		application/json:
		schema:
		@@ -160,6 +179,21 @@ components:
		explode: false
		schema:
		type: string
		ETag:
		description: >
		Used to provide the current entity-tag for the selected resource representation. It can be sent in
		"200 OK", "201 Created" and "204 No Content" responses.
		style: simple
		schema:
		type: string
		Last-Modified:
		description: >
		Used to provide a timestamp indicating the date and time at which the server believes the selected resource
		representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses.
		style: simple
		schema:
		type: string
		format: date-time
		content:
		application/json:
		schema:

src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml

+20 −25

Original line number	Diff line number	Diff line
		@@ -53,7 +53,7 @@ definitions:
		as "deleteIdList" as defined below this table.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../General_Definitions/SOL002_def.yaml#/definitions/Identifier"

		VnfConfiguration:
		description: >
		@@ -86,16 +86,11 @@ definitions:
		type: array
		items:
		$ref: '#/definitions/CpConfiguration'
		dhcpServer:
		description: >
		IP address of the DHCP server that the VNF instance can use to obtain
		IP addresses to be assigned to its external CPs.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress'
		vnfSpecificData:
		description: >
		Additional configurable properties of the VNF instance declared in the
		VNFD as "VnfConfigurableProperties". see note.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs'
		$ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs'

		VnfcConfigurationData:
		description: >
		@@ -110,7 +105,7 @@ definitions:
		description: >
		Identifier of a VNFC instance to which this set of configuration data applies.
		The identifier references the "id" attribute in a "VnfcInfo" structure.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf'
		$ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf'
		intCpConfig:
		description: >
		Configuration parameters for the internal CPs of the VNFC instance.
		@@ -121,12 +116,12 @@ definitions:
		description: >
		IP address of the DHCP server that the VNF instance can use to obtain
		IP addresses to be assigned to its external CPs.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress'
		$ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IpAddress'
		vnfcSpecificData:
		description: >
		Additional configurable properties of the VNFC instance declared in the
		VNFD as "VnfcConfigurableProperties". See note.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs'
		$ref: '../../General_Definitions/SOL002_def.yaml#/definitions/KeyValuePairs'

		CpConfiguration:
		description: >
		@@ -140,11 +135,11 @@ definitions:
		cpId:
		description: >
		Identifier of a CP instance within the namespace of a specific VNF instance or a VNFC instance.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf'
		$ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnf'
		cpdId:
		description: >
		Identifier of the CPD in the VNFD.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd'
		$ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IdentifierInVnfd'
		addresses:
		description: >
		Network address and port assigned to the CP.
		@@ -177,11 +172,11 @@ definitions:
		macAddress:
		description: >
		Mac address. See NOTE 2.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/MacAddress'
		$ref: '../../General_Definitions/SOL002_def.yaml#/definitions/MacAddress'
		ipAddress:
		description: >
		IP address. See NOTE 2.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress'
		$ref: '../../General_Definitions/SOL002_def.yaml#/definitions/IpAddress'
		useDynamicAddress:
		description: >
		Set to true if an address shall be assigned dynamically. Otherwise set to false.