VNF Fault Management interface (07a7fa25) · Commits · Miguel Angel Reina Ortega / SOL002-SOL003

src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml

0 → 100644

+514 −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: "/vnffm/v1"

		schemes:
		- https

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

		paths:
		###############################################################################
		# Alarms #
		###############################################################################
		'/alarms':
		#SOL003 location: 7.4.2
		get:
		description: >
		The client can use this method to retrieve information about the alarm
		list.
		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 request has succeeded.
		The response body shall contain the list of related alarms.
		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/SOL003_def.yaml#/definitions/Alarm"
		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 alarm #
		###############################################################################
		'/alarms/{alarmId}':
		#SOL003 location: 7.4.3
		parameters:
		- name: alarmId
		description: >
		Identifier of the alarm.
		This identifier can be retrieved from the "id" attribute of the
		"alarm" attribute in the AlarmNotification or
		AlarmClearedNotification. It can also be retrieved from the "id"
		attribute of the applicable array element in the payload body of the
		response to a GET request to the "Alarms" resource.
		in: path
		type: string
		required: true
		get:
		description: >
		The client can use this method to read an individual alarm.
		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: >
		Information about an individual alarm was read successfully.
		The response body shall contain a representation of the individual
		alarm.
		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/SOL003_def.yaml#/definitions/Alarm"
		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"
		patch:
		description: >
		This method modifies an individual alarm resource.
		parameters:
		- name: AlarmModifications
		description: The VNF creation parameters
		in: body
		required: true
		schema:
		$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
		- 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 request was accepted and completed. The response body shall
		contain attribute modifications for an ‘Individual alarm’
		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/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
		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"
		409:
		$ref: "responses/VNFFaultManagement_resp.yaml#/responses/409-alarm-state-conflict"
		412:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		###############################################################################
		# Subscriptions #
		###############################################################################
		'/alarms/subscriptions':
		#SOL003 location: 7.4.4
		post:
		description: >
		The POST method creates a new subscription.
		parameters:
		- name: FmSubscriptionRequest
		description: The VNF creation parameters
		in: body
		required: true
		schema:
		$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
		- 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 subscription resource.
		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:
		$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
		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 client can use this method to retrieve the list of active
		subscriptions for VNF alarms subscribed by the client. 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.
		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/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
		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"
		412:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		###############################################################################
		# Individual subscription #
		###############################################################################
		'/subscriptions/{subscriptionId}':
		#SOL003 location: 7.4.5
		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 client can use this method for reading an individual subscription
		for VNF alarms subscribed by the client.
		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/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
		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: >
		This 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:
		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
		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/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml

0 → 100644

+26 −0

Original line number	Diff line number	Diff line
		responses:
		409-alarm-state-conflict:
		description: >
		The operation cannot be executed currently, due to a conflict with the
		state of the "Individual alarm" resource.
		Typically, this is due to the fact that the alarm is already in the
		state that is requested to be set (such as trying to acknowledge an
		already-acknowledged alarm).
		The response body shall contain a ProblemDetails structure, in which the
		"detail" attribute should convey more information about the error.
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		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/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

0 → 100644

+253 −0

File added.

Preview size limit exceeded, changes collapsed.

src/SOL003/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml

+734 −10

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL003/definitions/SOL003_def.yaml

0 → 100644

+164 −0

File added.

Preview size limit exceeded, changes collapsed.