Newer
Older
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Performance Management Notification interface"
description: >
SOL005 - NS Performance Management Notification interface
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
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
basePath: /callback/v1
schemes:
- http
- https
consumes:
- application/json
paths:
##################################################################################
# Notification endpoint NS Performance Management #
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-PerformanceInformationAvailableNotification':
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
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,
parameters:
- name: PerformanceInformationAvailableNotification
description: >
Notification about performance information availability.
in: body
schema:
$ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/PerformanceInformationAvailableNotification"
- name: ThresholdCrossedNotification
description: >
Notification about threshold crossing.
in: body
schema:
$ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/ThresholdCrossedNotification"
- 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.
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
in: header
required: true
type: string
responses:
204:
description: >
204 NO CONTENT
The notification was delivered successfully.
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
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:
$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"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
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.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231.
in: header
required: true
type: string
responses:
204:
description: >
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
The notification endpoint was tested 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
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:
$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"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"