SOL002: VNF Fault mgmt interface consolidation (a382051f) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+168 −89

Original line number	Diff line number	Diff line
		@@ -2,18 +2,15 @@ swagger: "2.0"

		info:
		version: "1.2.0"
		title: SOL002 - VNF Configuration interface
		title: SOL002 - VNF Fault Management interface
		description: >
		VNF Configuration interface of ETSI NFV SOL002

		VNF Fault Management interface of ETSI NFV SOL002

		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=---

		license:
		name: "ETSI Forge copyright notice"
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		@@ -34,7 +31,6 @@ consumes:
		produces:
		- application/json


		paths:
		###############################################################################
		# API Versions #
		@@ -54,6 +50,13 @@ paths:
		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:
		description: >
		The client can use this method to retrieve information about the alarm
		@@ -73,13 +76,6 @@ paths:
		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
		- name: filter
		description: >
		Attribute-based filtering expression according to clause 4.3.2.
		@@ -126,7 +122,7 @@ paths:
		responses:
		200:
		description: >
		OK
		200 OK

		Information about zero or more alarms was queried successfully.
		The response body shall contain in an array the representations of zero or more alarms
		@@ -166,14 +162,25 @@ paths:
		$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"
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		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"

		###############################################################################
		# Individual alarm #
		###############################################################################
		@@ -197,6 +204,13 @@ paths:
		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:
		description: >
		The client can use this method to read an individual alarm.
		@@ -215,17 +229,10 @@ paths:
		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: >
		OK
		200 OK

		Information about an individual alarm was read successfully.
		The response body shall contain a representation of the individual
		@@ -257,14 +264,24 @@ paths:
		$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"
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		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:
		description: >
		This method modifies an individual alarm resource.
		@@ -289,17 +306,10 @@ paths:
		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: >
		OK
		200 OK

		The request was accepted and completed. The response body shall
		contain attribute modifications for an ‘Individual alarm’
		@@ -331,18 +341,38 @@ paths:
		$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"
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		409:
		$ref: "responses/VNFFaultManagement_resp.yaml#/responses/409-alarm-state-conflict"
		description: >
		409 CONFLICT

		Error: 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 shall
		convey more information about the error.
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
		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"

		###############################################################################
		# Escalate Perceived Severity task #
		###############################################################################
		@@ -355,6 +385,13 @@ paths:
		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
		post:
		description: >
		The POST method enables the consumer to escalate the perceived severity
		@@ -379,7 +416,7 @@ paths:
		responses:
		200:
		description: >
		OK
		200 OK

		The VNFM has received the proposed "escalated perceived severity" value
		successfully. The response body shall be empty.
		@@ -395,16 +432,24 @@ paths:
		$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"
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		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"

		###############################################################################
		# Subscriptions #
		@@ -418,6 +463,13 @@ paths:
		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
		post:
		description: >
		The POST method creates a new subscription.
		@@ -442,17 +494,10 @@ paths:
		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: >
		Created
		201 CREATED

		The subscription was created successfully. The response body shall
		contain a representation of the created subscription resource.
		@@ -484,20 +529,40 @@ paths:
		minimum: 0
		schema:
		$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
		303:
		description: >
		303 SEE OTHER

		A subscription with the same callbackURI and the same filter already exists and the policy of
		the VNFM is to not create redundant subscriptions.
		The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
		existing subscription resource.
		The response body shall be empty.
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
		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"
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		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"
		get:
		description: >
		The client can use this method to retrieve the list of active
		@@ -518,13 +583,6 @@ paths:
		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
		- name: filter
		description: >
		Attribute-based filtering expression according to clause 4.3.2.
		@@ -569,7 +627,7 @@ paths:
		responses:
		200:
		description: >
		OK
		200 OK

		The list of subscriptions was queried successfully. The response
		body shall contain the representations of all active
		@@ -610,16 +668,25 @@ paths:
		$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"
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		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"

		###############################################################################
		# Individual subscription #
		###############################################################################
		@@ -642,6 +709,13 @@ paths:
		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:
		description: >
		The client can use this method for reading an individual subscription
		@@ -661,17 +735,10 @@ paths:
		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: >
		OK
		200 OK

		The operation has completed successfully.
		The response body shall contain a representation of the
		@@ -703,29 +770,31 @@ paths:
		$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"
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		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"
		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: >
		No Content
		204 NO CONTENT

		The subscription resource was deleted successfully.
		The response body shall be empty.
		@@ -749,11 +818,21 @@ paths:
		$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"
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		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"
		No newline at end of file

src/SOL002/VNFPerformanceManagement/definitions/VNFPerformanceManagement_def.yaml

deleted100644 → 0

+0 −4

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

		definitions:
		No newline at end of file

src/SOL002/VNFPerformanceManagement/responses/VNFPerformanceManagement_resp.yaml

deleted100644 → 0

+0 −2

Original line number	Diff line number	Diff line
		responses: