VNF Indicator interface (c62cb215) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFIndicator/VNFIndicator.yaml

0 → 100644

+533 −0

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

		info:
		version: "2.3.0"
		title: SOL003
		license:
		name: "ETSI Forge copyright notice"
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

		basePath: "/vnfind/v1"

		schemes:
		- https

		consumes:
		- "application/json"
		produces:
		- "application/json"

		paths:
		###############################################################################
		# VNF indicators #
		###############################################################################
		'/indicators':
		#SOL003 location: 8.4.2
		get:
		description: >
		The GET method queries multiple VNF indicators.
		parameters:
		- name: Accept
		description: >
		Content-Types that are acceptable for the response.
		Reference: IETF RFC 7231
		in: header
		required: true
		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: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: true
		type: string
		responses:
		200:
		description: >
		The list of VNF indicators was queried successfully.
		The response body shall contain the representations of all VNF
		indicators that match the attribute filter.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		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
		schema:
		type: array
		items:
		$ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator"
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-based-filtering-error"
		401:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		###############################################################################
		# VNF indicators related to a VNF instance #
		###############################################################################
		'/indicators/{vnfInstanceId}':
		#SOL003 location: 8.4.3
		parameters:
		- name: vnfInstanceId
		description: >
		Identifier of the VNF instance to which the VNF indicator applies.
		This identifier can be retrieved from the resource referenced by the
		"Location" HTTP header in the response to a POST request creating a
		new VNF instance resource. It can also be retrieved from the "id"
		attribute in the payload body of that response.
		in: path
		type: string
		required: true
		get:
		description: >
		The GET method queries multiple VNF indicators related to a VNF
		instance.
		parameters:
		- name: Accept
		description: >
		Content-Types that are acceptable for the response.
		Reference: IETF RFC 7231
		in: header
		required: true
		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: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: true
		type: string
		responses:
		200:
		description: >
		The list of VNF indicators was queried successfully.
		The response body shall contain the representations of all VNF
		indicators that are related to the particular VNF instance and
		that match the attribute filter.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		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
		schema:
		type: array
		items:
		$ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator"
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-based-filtering-error"
		401:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		###############################################################################
		# Individual VNF indicator #
		###############################################################################
		'/indicators/{vnfInstanceId}/{indicatorId}':
		#SOL003 location: 8.4.4
		parameters:
		- name: indicatorId
		description: >
		Identifier of the VNF indicator.
		This identifier can be retrieved from the resource referenced by the
		payload body in the response to a POST request creating a new VNF
		instance resource.
		in: path
		type: string
		required: true
		- name: vnfInstanceId
		description: >
		Identifier of the VNF instance to which the VNF indicator applies.
		This identifier can be retrieved from the resource referenced by the
		"Location" HTTP header in the response to a POST request creating a
		new VNF instance resource. It can also be retrieved from the "id"
		attribute in the payload body of that response.
		in: path
		type: string
		required: true
		get:
		description: >
		The GET method reads a VNF indicator.
		parameters:
		- name: Accept
		description: >
		Content-Types that are acceptable for the response.
		Reference: IETF RFC 7231
		in: header
		required: true
		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: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: true
		type: string
		responses:
		200:
		description: >
		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 request.
		Reference: IETF RFC 7231
		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
		schema:
		$ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator"
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
		401:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		###############################################################################
		# Subscriptions #
		###############################################################################
		'/subscriptions':
		#SOL003 location: 8.4.5
		post:
		description: >
		The POST method creates a new subscription.
		parameters:
		- name: VnfIndicatorSubscriptionRequest
		description: Details of the subscription to be created.
		in: body
		required: true
		schema:
		$ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest"
		- name: Accept
		description: >
		Content-Types that are acceptable for the response.
		Reference: IETF RFC 7231
		in: header
		required: true
		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: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: true
		type: string
		responses:
		201:
		description: >
		The subscription was created successfully.
		The response body shall contain a representation of the created
		subscription resource.
		The HTTP response shall include a "Location" HTTP header that
		points to the created subscription resource.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		type: string
		maximum: 1
		minimum: 1
		Location:
		description: The resource URI of the created VNF instance
		type: string
		format: url
		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
		schema:
		type: array
		items:
		$ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription"
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
		401:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		get:
		description: >
		The GET method queries the list of active subscriptions of the
		functional block that invokes the method. It can be used e.g. for
		resynchronization after error situations.
		parameters:
		- name: Accept
		description: >
		Content-Types that are acceptable for the response.
		Reference: IETF RFC 7231
		in: header
		required: true
		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: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: true
		type: string
		responses:
		200:
		description: >
		The list of subscriptions was queried successfully.
		The response body shall contain the representations of all active
		subscriptions of the functional block that invokes the method
		which match the attribute filter.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		type: string
		maximum: 1
		minimum: 1
		Location:
		description: The resource URI of the created VNF instance
		type: string
		format: url
		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
		schema:
		type: array
		items:
		$ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription"
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-based-filtering-error"
		401:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		###############################################################################
		# Individual subscription #
		###############################################################################
		'/indicators/subscriptions/{subscriptionId}':
		#SOL003 location: 8.4.6
		parameters:
		- name: subscriptionId
		description: >
		Identifier of this subscription.
		This identifier can be retrieved from the resource referenced by the
		"Location" HTTP header in the response to a POST request creating a
		new subscription resource. It can also be retrieved from the "id"
		attribute in the payload body of that response.
		in: path
		type: string
		required: true
		get:
		description: >
		The GET method reads an individual subscription.
		parameters:
		- name: Accept
		description: >
		Content-Types that are acceptable for the response.
		Reference: IETF RFC 7231
		in: header
		required: true
		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: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: true
		type: string
		responses:
		200:
		description: >
		The operation has completed successfully.
		The response body shall contain a representation of the
		subscription resource.
		headers:
		Content-Type:
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		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
		schema:
		$ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription"
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
		401:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		delete:
		description: >
		The DELETE method terminates an individual subscription.
		parameters:
		- name: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: true
		type: string
		responses:
		204:
		description: >
		The subscription resource was deleted successfully.
		The response body shall be empty.
		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.
		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"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml

0 → 100644

+99 −0

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

		info:
		version: "2.3.0"
		title: SOL003 - VNF Lifecycle Management Notification interface
		license:
		name: "ETSI Forge copyright notice"
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		contact:
		name: "NFV-SOL WG"

		basePath: "/callback/v1"

		schemes:
		- https

		consumes:
		- "application/json"
		produces:
		- "application/json"

		paths:
		###############################################################################
		# Notification endpoint VnfIndicatorValueChangeNotification #
		###############################################################################
		'/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIndicatorValueChangeNotification':
		#SOL003 location: 8.4.7
		post:
		description: >
		The POST method notifies a VNF alarm or that the alarm list has been
		rebuilt.
		parameters:
		- name: AlarmListRebuiltNotification
		description: >
		Information that the alarm list has been rebuilt by the VNFM
		in: body
		required: true
		schema:
		$ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification"
		responses:
		204:
		description: >
		The notification was delivered successfully.
		The response body shall be empty.
		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.
		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"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		get:
		description: >
		The GET method allows the server to test the notification endpoint
		that is provided by the client, e.g. during subscription.
		responses:
		204:
		description: >
		The notification endpoint was tested successfully.
		The response body shall be empty.
		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.
		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"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

src/definitions/SOL002SOL003VNFIndicator_def.yaml

0 → 100644

+210 −0

File added.

Preview size limit exceeded, changes collapsed.

Admin message