Updated API version resource, and Version HTTP Header - SOL002... (058a4f8c) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+36 −1

Original line number	Diff line number	Diff line
		swagger: "2.0"
		info:
		version: "1.1.0"
		version: "1.2.0"
		title: "SOL002 - VNF Configuration interface"
		description: >
		SOL002 - VNF Configuration Interface
		@@ -36,6 +36,13 @@ paths:
		The GET method reads API version information. This method shall follow the provisions specified in
		table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
		supported.
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		responses:
		200:
		description: >
		@@ -50,6 +57,11 @@ paths:
		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' }
		@@ -73,6 +85,13 @@ paths:
		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.
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		responses:
		200:
		description: >
		@@ -87,6 +106,11 @@ paths:
		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' }
		@@ -114,6 +138,12 @@ paths:
		in: body
		schema:
		$ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		responses:
		200:
		description: >
		@@ -129,6 +159,11 @@ paths:
		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' }

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+130 −23

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

		info:
		version: "1.1.1"
		version: "1.2.0"
		title: SOL002 - VNF Configuration interface
		description: >
		VNF Configuration interface of ETSI NFV SOL002
		@@ -36,11 +36,69 @@ produces:


		paths:
		###############################################################################
		# API Versions #
		###############################################################################
		'/api-versions':
		get:
		summary: Retrieve API version information
		description: >
		The GET method reads API version information. This method shall follow the provisions specified in
		table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
		supported.
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		responses:
		200:
		description: >
		API version information was read successfully.
		The response body shall contain 4.4 API version
		information, as defined in clause 4.4.1.13.
		schema:
		$ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation'
		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' }
		413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' }
		414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' }
		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' }

		###############################################################################
		# Alarms #
		###############################################################################
		'/alarms':
		#SOL003 location: 7.4.2
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		get:
		description: >
		The client can use this method to retrieve information about the alarm
		@@ -122,9 +180,12 @@ paths:
		inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		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
		@@ -136,6 +197,7 @@ paths:
		type: string
		maximum: 1
		minimum: 0

		schema:
		$ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/Alarm"
		400:
		@@ -169,6 +231,12 @@ paths:
		in: path
		type: string
		required: true
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		get:
		description: >
		The client can use this method to read an individual alarm.
		@@ -204,9 +272,12 @@ paths:
		alarm.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		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
		@@ -275,9 +346,12 @@ paths:
		resource.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		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
		@@ -314,6 +388,13 @@ paths:
		###############################################################################
		'/alarms/{alarmId}/escalate':
		#SOL002 location: 7.4.4
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		post:
		description: >
		The POST method enables the consumer to escalate the perceived severity
		@@ -342,6 +423,12 @@ paths:

		The VNFM has received the proposed "escalated perceived severity" value
		successfully. The response body shall be empty.
		headers:
		Version:
		description: The used API version.
		type: string
		maximum: 1
		minimum: 1
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
		401:
		@@ -364,6 +451,13 @@ paths:
		###############################################################################
		'/subscriptions':
		#SOL003 location: 7.4.4
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		post:
		description: >
		The POST method creates a new subscription.
		@@ -406,9 +500,12 @@ paths:
		points to the created subscription resource.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		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
		@@ -522,9 +619,12 @@ paths:
		response shall follow the provisions in clause 4.7.2.3.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		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
		@@ -570,6 +670,12 @@ paths:
		in: path
		type: string
		required: true
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		get:
		description: >
		The client can use this method for reading an individual subscription
		@@ -606,9 +712,12 @@ paths:
		subscription resource.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		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
		@@ -655,10 +764,8 @@ paths:
		The subscription resource was deleted successfully.
		The response body shall be empty.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		Version:
		description: The used API version.
		type: string
		maximum: 1
		minimum: 1

src/SOL002/VNFIndicator/VNFIndicator.yaml

+184 −13

Original line number	Diff line number	Diff line
		@@ -40,10 +40,68 @@ produces:


		paths:
		###############################################################################
		# API Versions #
		###############################################################################
		'/api-versions':
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		get:
		summary: Retrieve API version information
		description: >
		The GET method reads API version information. This method shall follow the provisions specified in
		table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
		supported.
		responses:
		200:
		description: >
		API version information was read successfully.
		The response body shall contain 4.4 API version
		information, as defined in clause 4.4.1.13.
		schema:
		$ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation'
		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' }
		413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' }
		414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' }
		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' }

		###############################################################################
		# VNF Indicators #
		###############################################################################
		/indicators:
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		get:
		summary: Query multiple indicators
		description: Get a list of indicators. Support of attribute based filtering via query parameters.
		@@ -100,6 +158,17 @@ paths:
		i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2.
		If the EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
		inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
		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
		schema:
		type: array
		items:
		@@ -116,7 +185,6 @@ paths:
		500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
		503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }


		/indicators/{vnfInstanceId}:
		parameters:
		- name: vnfInstanceId
		@@ -130,6 +198,12 @@ paths:
		of that response.
		type: string
		required: true
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		get:
		summary: Query multiple indicators related to a VNF instance.
		description: >
		@@ -189,6 +263,17 @@ paths:
		If the EM/VMF supports alternative 2 (paging) according to clause 4.7.2.1
		for this resource, inclusion of the Link HTTP header in this response shall
		follow the provisions in clause 4.7.2.3.
		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
		schema:
		type: array
		items:
		@@ -226,6 +311,12 @@ paths:
		# LEH NOTE from SOL002 is strange
		type: string
		required: true
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		get:
		summary: Read an inidividual VNF indicator related to a VNF instance.
		description: >
		@@ -240,6 +331,17 @@ paths:

		The VNF indicator was read successfully.
		The response body shall contain the representation of the VNF indicator.
		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
		schema:
		$ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator'
		400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
		@@ -262,6 +364,12 @@ paths:
		Identifier of the VNF indicator.
		type: string
		required: true
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		get:
		summary: Read an inidividual VNF indicator related to a VNF instance.
		description: >
		@@ -273,6 +381,17 @@ paths:

		The VNF indicator was read successfully.
		The response body shall contain the representation of the VNF indicator.
		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
		schema:
		$ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator'
		400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
		@@ -288,6 +407,13 @@ paths:
		503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }

		/subscriptions:
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		post:
		summary: Create a new subscription to VNF indicator change notifications
		description: Create a new subscription
		@@ -313,6 +439,16 @@ paths:
		Pointer to the created subscription resource.
		type: string
		format: URI
		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' }
		@@ -386,6 +522,17 @@ paths:
		as defined in clause 8.5.2.4.
		If the EM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
		inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
		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
		schema:
		type: array
		items:
		@@ -404,6 +551,13 @@ paths:


		/subscriptions/{subscriptionId}:
		parameters:
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: false
		type: string
		get:
		summary: Read an individual subscription.
		description: >
		@@ -429,6 +583,17 @@ paths:

		The subscriptions was queried successfully. The response body shall contain
		the representation of the requested subscription.
		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
		schema:
		$ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription'
		400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
		@@ -465,6 +630,12 @@ paths:

		The subscription was deleted successfully.
		The response body shall be empty.
		headers:
		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' }

src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml

+0 −2

Original line number	Diff line number	Diff line
		@@ -37,8 +37,6 @@ produces:

		paths:



		/notificationendpoint:
		post:
		summary: Notification endpoint

src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml

+43 −0

File changed.

Preview size limit exceeded, changes collapsed.

Admin message