Merge branch '2.5.1-dev' (bf7a57a4) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

.gitignore

+1 −0

Original line number	Diff line number	Diff line
		build/
		*.pyc

src/SOL002/APIVersion/APIVersion.yaml

0 → 100644

+50 −0

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

		info:
		version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
		title: SOL002 - API version interface
		description: >
		SOL002 - API version Interface
		IMPORTANT: Please note that this file might be not aligned to the current
		version of the ETSI Group Specification it refers to and has not been
		approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
		Group Specification takes precedence.
		Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
		license:
		name: ETSI Forge copyright notice
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		contact:
		name: NFV-SOL WG

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

		schemes:
		- http
		- https

		consumes:
		- application/json

		produces:
		- application/json

		paths:
		###############################################################################
		# API Versions #
		###############################################################################
		'/vnfconfig/api-versions':
		$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'

		'/vnffm/api-versions':
		$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'

		'/vnfind/api-versions':
		$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'

		'/vnflcm/api-versions':
		$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'

		'/vnfpm/api-versions':
		$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
		No newline at end of file

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+151 −80

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

		info:
		version: "1.1.0"
		version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
		title: SOL002 - VNF Configuration interface
		description: >
		VNF Configuration interface of ETSI NFV SOL002


		SOL002 - VNF Configuration Interface
		IMPORTANT: Please note that this file might be not aligned to the current
		version of the ETSI Group Specification it refers to. In case of
		discrepancies the published ETSI Group Specification takes precedence.


		Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---
		version of the ETSI Group Specification it refers to and has not been
		approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
		Group Specification takes precedence.
		Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
		license:
		name: "ETSI Forge copyright notice"
		name: ETSI Forge copyright notice
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		contact:
		name: NFV-SOL WG

		externalDocs:
		description: ETSI GS NFV-SOL 002 V2.4.1
		url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
		description: ETSI GS NFV-SOL 002 V2.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf

		basePath: /vnfconfig/v1

		@@ -32,70 +32,141 @@ consumes:
		produces:
		- application/json


		paths:
		###############################################################################
		# Configuration #
		# API Versions #
		###############################################################################
		'/api-versions':
		$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'

		###############################################################################
		# VNF Configuration #
		###############################################################################
		/configuration:
		#SOL002 location: 9.4.2
		'/configuration':
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		type: string
		- name: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: false
		type: string
		get:
		summary: Read VNF/VNFC configuration from VNF.
		summary: Read VNF/VNFC configuration from VNF
		description: >
		The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
		responses:
		200:
		description: >
		OK

		200 OK
		Configuration information about a VNF instance was read successfully.
		The response body shall contain a representation of the configuration resource.
		schema:
		$ref: '#/definitions/VnfConfiguration'
		400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
		401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
		403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
		404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
		405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
		406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
		409: { $ref: 'responses/VNFConfiguration_resp.yaml#/responses/409' }
		416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
		422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
		500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
		503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
		$ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfiguration'
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		type: string
		maximum: 1
		minimum: 1
		Version:
		description: The used API version.
		type: string
		maximum: 1
		minimum: 1
		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.
		type: string
		maximum: 1
		minimum: 0
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
		401:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		404:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		416:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
		429:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		504:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
		patch:
		summary: Modify VNF/VNFC configuration.
		description: This method sets or modifies a configuration resource.
		parameters:
		- name: configModifications
		description: The parameter for the configuration modification.
		description: >
		The parameter for the configuration modification, as defined in
		clause 9.5.2.2.
		required: true
		in: body
		schema:
		$ref: '#/definitions/VnfConfigModifications'
		$ref: 'definitions/SOL002VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
		responses:
		200:
		description: >
		OK
		200 OK

		The request was accepted and completed. The response body shall contain the parameters
		of the configuration modification that was applied to the configuration resource.
		schema:
		$ref: '#/definitions/VnfConfigModifications'
		412: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/412' }
		400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
		401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
		403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
		404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
		405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
		406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
		409: { $ref: 'responses/VNFConfiguration_resp.yaml#/responses/409' }
		416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
		422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
		500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
		503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
		definitions:
		VnfConfiguration:
		$ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfiguration'
		VnfConfigModifications:
		$ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
		$ref: 'definitions/SOL002VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		type: string
		maximum: 1
		minimum: 1
		Version:
		description: The used API version.
		type: string
		maximum: 1
		minimum: 1
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
		401:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		404:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		412:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
		416:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
		429:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		504:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
		No newline at end of file

src/SOL002/VNFConfiguration/definitions/VnfConfiguration_def.yaml→src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml

+58 −59

Original line number	Diff line number	Diff line
		definitions:

		VnfConfiguration:
		description: >
		This type represents configuration parameters of a VNF instance and its VNFC instances.
		type: object
		required:
		- vnfConfigurationData
		properties:
		vnfConfigurationData:
		description: >
		Configuration parameters of the VNF instance.
		$ref: '#/definitions/VnfConfigurationData'
		vnfcConfigurationData:
		description: >
		Configuration parameters of the VNFC instances.
		type: array
		items:
		$ref: '#/definitions/VnfcConfigurationData'

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

		definitions:
		VnfConfigModifications:
		description: >
		This type represents request parameters for the "Set Configuration" operation.
		@@ -59,7 +42,31 @@ definitions:
		type: array
		items:
		$ref: '#/definitions/VnfcConfigurationData'
		vnfcConfigurationDataDeleteIds:
		description: >
		List of identifiers entries to be deleted from the 'vnfcConfigurationData" attribute array to be used
		as "deleteIdList" as defined below this table.
		type: array
		items:
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"

		VnfConfiguration:
		description: >
		This type represents configuration parameters of a VNF instance and its VNFC instances.
		type: object
		required:
		- vnfConfigurationData
		properties:
		vnfConfigurationData:
		description: >
		Configuration parameters of the VNF instance.
		$ref: '#/definitions/VnfConfigurationData'
		vnfcConfigurationData:
		description: >
		Configuration parameters of the VNFC instances.
		type: array
		items:
		$ref: '#/definitions/VnfcConfigurationData'

		VnfConfigurationData:
		description: >
		@@ -81,7 +88,6 @@ definitions:
		VNFD as "VnfConfigurableProperties".
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs'


		VnfcConfigurationData:
		description: >
		This type represents configuration parameters of a VNFC instance.
		@@ -93,11 +99,9 @@ definitions:
		description: >
		Identifier of a VNFC instance to which this set of configuration data applies.
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf'
		intCpConfig:
		extCpConfig:
		description: >
		Configuration parameters for the internal CPs of the VNFC instance.
		type: array
		items:
		Configuration parameters for the external CPs of the VNFC instance.
		$ref: '#/definitions/CpConfiguration'
		dhcpServer:
		description: >
		@@ -110,7 +114,6 @@ definitions:
		VNFD as "VnfcConfigurableProperties".
		$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs'


		CpConfiguration:
		description: >
		This type represents configuration parameters of a CP instance.
		@@ -164,7 +167,3 @@ definitions:
		description: >
		The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).
		type: integer
		No newline at end of file

src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml

deleted100644 → 0

+0 −16

Original line number	Diff line number	Diff line
		responses:
		409:
		description: >
		Conflict

		Another request is in progress that prohibits the fulfilment of
		the current request, or the current resource state is inconsistent
		with the request.
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		type: string
		maximum: 1
		minimum: 1
		schema:
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"