Newer
Older
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
moscatelli
committed
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/nsfm/v1"
schemes:
- https
consumes:
- "application/json"
produces:
- "application/json"
paths:
moscatelli
committed
###############################################################################
Samir Medjiah
committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# 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: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_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/SOL005_resp.yaml#/responses/400' }
401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
###############################################################################
moscatelli
committed
# Alarms #
###############################################################################
rameshnaraya
committed
'/alarms':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.2
rameshnaraya
committed
get:
summary: Query alarms related to NS instances.
rameshnaraya
committed
description: >
rameshnaraya
committed
The client can use this method to retrieve information about the alarm list.
parameters:
- name: "filter"
in: "query"
required: false
type: "string"
moscatelli
committed
description: >
Attribute-based filtering expression according to clause 4.3.2.
The NFVO shall support receiving this parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
The following attribute names shall be supported by the NFVO in the filter
expression:
rameshnaraya
committed
- id
- nsInstanceId
- rootCauseFaultyComponent.faultyNestedNsInstanceId
- rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId
- rootCauseFaultyComponent.faultyVnfInstanceId
- rootCauseFaultyResource.faultyResourceType
- eventType
- perceivedSeverity
- probableCause
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
required: false
type: string
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
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: false
type: string
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
responses:
200:
moscatelli
committed
Information about zero or more alarms was queried successfully.
rameshnaraya
committed
The response body shall contain the list of related alarms.
If the NFVO 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
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
rameshnaraya
committed
schema:
moscatelli
committed
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual alarm #
###############################################################################
rameshnaraya
committed
'/alarms/{alarmId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.3
rameshnaraya
committed
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.
rameshnaraya
committed
in: path
type: string
required: true
rameshnaraya
committed
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: false
type: string
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
responses:
moscatelli
committed
rameshnaraya
committed
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 response.
rameshnaraya
committed
type: string
maximum: 1
minimum: 1
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
moscatelli
committed
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
patch:
summary: Acknowledge individual alarm.
rameshnaraya
committed
description: >
Acknowledge Alarm
moscatelli
committed
rameshnaraya
committed
This method modifies an individual alarm resource.
parameters:
moscatelli
committed
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "AlarmModifications"
properties:
AlarmModifications:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
description: >
The parameter for the alarm modification, as defined in clause 8.5.2.8.
- name: Accept
description: >
Content-Types that are acceptable for the response.
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: false
type: string
- name: Content-Type
description: >
The Content-Type header shall be set to
"application/merge-patch+json" according to
IETF RFC 7396.
in: header
required: true
type: string
enum: ["application/merge-patch+json"]
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
responses:
200:
moscatelli
committed
rameshnaraya
committed
The request was accepted and completed.
The response body shall contain attribute modifications
for an 'Individual alarm' resource (see clause 8.5.2.4).
headers:
Content-Type:
description: The MIME type of the body of the response.
rameshnaraya
committed
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
properties:
AlarmModifications:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSFManagement_resp.yaml#/responses/409-alarm-state-conflict"
412:
$ref: "responses/SOL005_resp.yaml#/responses/412"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
##############################################################################
#Subscriptions #
##############################################################################
rameshnaraya
committed
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.4
rameshnaraya
committed
post:
summary: Subscribe to alarms related to NSs.
moscatelli
committed
description: >
rameshnaraya
committed
The POST method creates a new subscription.
This method shall follow the provisions specified in the Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query parameters,
request and response data structures, and response codes.
Creation of two subscription resources with the same callbackURI and the same filter can result in performance
degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
the existing subscription resource with the same filter and callbackUri).
moscatelli
committed
parameters:
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
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: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
moscatelli
committed
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
moscatelli
committed
- "FmSubscriptionRequest"
properties:
FmSubscriptionRequest:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
description: >
Details of the subscription to be created, as defined in clause 8.5.2.2.
moscatelli
committed
rameshnaraya
committed
responses:
201:
moscatelli
committed
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.
schema:
type: "object"
properties:
FmSubscription:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
rameshnaraya
committed
headers:
Content-Type:
type: "string"
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
rameshnaraya
committed
WWW-Authenticate:
rameshnaraya
committed
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
303:
$ref: "responses/SOL005_resp.yaml#/responses/303"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
get:
summary: Query multiple subscriptions.
rameshnaraya
committed
description: >
Query Subscription Information
moscatelli
committed
rameshnaraya
committed
The client can use this method to retrieve the list of active subscriptions
for alarms related to a NS subscribed by the client.
It can be used e.g. for resynchronization after error situations.
moscatelli
committed
rameshnaraya
committed
This method shall follow the provisions specified in the Tables 8.4.4.3.2-1 and 8.4.4.3.2-2 for URI query parameters,
request and response data structures, and response codes.
Table 8.4.4.3.2-1: URI query parameters supported.
parameters:
- name: "filter"
in: "query"
required: false
type: "string"
moscatelli
committed
description: >
Samir Medjiah
committed
Attribute-based filtering expression according to clause 4.3.2.
The NFVO shall support receiving this parameter as part of the URI
query string. The OSS/BSS may supply this parameter.
rameshnaraya
committed
All attribute names that appear in the FmSubscription and in data types
Samir Medjiah
committed
referenced from it shall be supported by the NFVO in the filter expression.
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
required: false
type: string
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
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: false
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
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
responses:
200:
moscatelli
committed
rameshnaraya
committed
The list of subscriptions was queried successfully.
The response body shall contain in an array the representations
of all active subscriptions of the functional block that invokes
the method, i.e. zero or more representations of FM subscriptions,
as defined in clause 8.5.2.3.
If the NFVO 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.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
rameshnaraya
committed
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
rameshnaraya
committed
schema:
type: array
items:
moscatelli
committed
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-based-filtering-error"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
412:
$ref: "responses/SOL005_resp.yaml#/responses/412"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Individual subscription #
###############################################################################
rameshnaraya
committed
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.5
rameshnaraya
committed
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:
summary: Read an individual subscription.
rameshnaraya
committed
description: >
Query Subscription Information
moscatelli
committed
rameshnaraya
committed
The client can use this method for reading an individual subscription for alarms related to NSs subscribed by the client.
This method shall follow the provisions specified in the Tables 8.4.5.3.2-1 and 8.4.5.3.2-2 for URI query parameters,
request and response data structures, and response codes
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
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: false
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
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
responses:
200:
moscatelli
committed
rameshnaraya
committed
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:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
properties:
FmSubscription:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
delete:
rameshnaraya
committed
description: >
Terminate Subscription
moscatelli
committed
rameshnaraya
committed
This method terminates an individual subscription.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
responses:
204:
moscatelli
committed
description: >
moscatelli
committed
rameshnaraya
committed
The subscription resource was deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
##################################################################################
# Notification endpoint #
# Dummy URI is used for testing. #
# In real, resource URI is provided by the client when creating the subscription.#
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6
rameshnaraya
committed
post:
rameshnaraya
committed
description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
rameshnaraya
committed
parameters:
- name: alarmNotification
description: >
Information of a NS alarm.
in: body
required: true
schema:
moscatelli
committed
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
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: false
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
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
204:
description: >
204 No Content
moscatelli
committed
The notification was delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: "string"
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/403"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6
post:
summary: Notify about NS alarms
description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
parameters:
- name: alarmClearedNotification
description: >
Information of the clearance of a NS alarm.
in: body
required: true
schema:
properties:
moscatelli
committed
AlarmClearedNotification:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
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: false
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
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
204:
description: >
204 No Content
moscatelli
committed
The notification was delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: "string"
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/403"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6
post:
summary: Notify about NS alarms
description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
parameters:
- name: AlarmListRebuiltNotification
description: >
Information that the alarm list has been rebuilt by the NFVO.
in: body
required: true
schema:
properties:
moscatelli
committed
AlarmListRebuiltNotification:
$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
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: false
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
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
responses:
204:
description: >
moscatelli
committed
rameshnaraya
committed
The notification was delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: "string"
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"