Newer
Older
rameshnaraya
committed
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
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 the representations of
all active subscriptions of the functional block that
invokes the method, as defined in clause 7.5.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:
moscatelli
committed
type: string
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:
properties:
PmSubscription:
$ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscription"
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
###############################################################################
# Individual subscription #
###############################################################################
rameshnaraya
committed
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.8
parameters:
- name: subscriptionId
description: >
Identifier of the 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.
rameshnaraya
committed
in: path
type: string
required: true
get:
rameshnaraya
committed
description: >
The client can use this method for reading an individual subscription about Performance management notifications
subscribed by the client.
This method shall follow the provisions specified in the Tables 7.4.8.3.2-1 and 7.4.8.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
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: 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:
moscatelli
committed
The subscription was read successfully.
The response body shall contain a representation of
the subscription resource, as defined in clause 7.5.2.3.
moscatelli
committed
type: object
properties:
PmSubscription:
$ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PmSubscription"
rameshnaraya
committed
headers:
Content-Type:
moscatelli
committed
type: string
rameshnaraya
committed
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:
moscatelli
committed
type: string
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.
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"
delete:
moscatelli
committed
summary: Terminate a subscription.
rameshnaraya
committed
description: >
This method terminates an individual subscription.
This method shall follow the provisions specified in the
Tables 7.4.8.3.5-1 and 7.4.8.3.5-2 for URI query parameters,
request and response data structures, and response codes
rameshnaraya
committed
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: 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:
moscatelli
committed
description: >
moscatelli
committed
rameshnaraya
committed
The subscription resource was deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
moscatelli
committed
type: string
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-PerformanceInformationAvailableNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.9
rameshnaraya
committed
post:
summary: Notify about PM related events
rameshnaraya
committed
description: >
The POST method delivers a notification regarding a performance management event from the server to the client.
This method shall follow the provisions specified in the
Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters,
rameshnaraya
committed
parameters:
- name: PerformanceInformationAvailableNotification
rameshnaraya
committed
description: >
Notification about performance information availability.
rameshnaraya
committed
in: body
required: true
schema:
properties:
PerformanceInformationAvailableNotification:
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
$ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification"
- 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.
headers:
WWW-Authenticate:
moscatelli
committed
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-ThresholdCrossedNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.9
post:
summary: Notify about PM related events
description: >
The POST method delivers a notification regarding a performance management event from the server to the client.
This method shall follow the provisions specified in the
Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters,
moscatelli
committed
parameters:
- name: ThresholdCrossedNotification
description: >
Notification about threshold crossing.
in: body
required: true
schema:
properties:
ThresholdCrossedNotification:
moscatelli
committed
$ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/ThresholdCrossedNotification"
rameshnaraya
committed
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
- 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
The notification was delivered successfully.
headers:
WWW-Authenticate:
moscatelli
committed
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"
403:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
get:
summary: Test the notification endpoint
rameshnaraya
committed
description: >
The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during
subscription.
This method shall follow the provisions specified in the
Tables 7.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
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
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 endpoint was tested successfully.
The response body shall be empty.
moscatelli
committed
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"
403:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"