Newer
Older
Giacomo Bernini
committed
title: SOL003 - VNF Indicator interface
Giacomo Bernini
committed
SOL003 - VNF Indicator 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.
In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
filtering mechanism is defined. This mechanism is currently not
included in the corresponding OpenAPI design for this GS version. Changes
to the attribute-based filtering mechanism are being considered in v2.5.1
of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
design.
Michele Carignani
committed
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
contact:
name: NFV-SOL WG
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
Michele Carignani
committed
externalDocs:
description: ETSI GS NFV-SOL 003 V3.3.1
Giacomo Bernini
committed
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf
servers:
- url: http://127.0.0.1/callback/v1
- url: https://127.0.0.1/callback/v1
###############################################################################
# Notification endpoint VnfIndicatorValueChangeNotification #
###############################################################################
/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIndicatorValueChangeNotification:
Notify.
The POST method delivers a notification from the API producer to an API consumer.
The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
This method shall follow the provisions specified in the tables 8.4.7.3.1-1 and 8.4.7.3.1-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
requestBody:
$ref: '#/components/requestBodies/AlarmListRebuiltNotification'
$ref: '#/components/responses/VNFINDNotification.Post.204'
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
The GET method allows the API producer to test the notification endpoint that is provided by
the API consumer, e.g. during subscription.
This method shall follow the provisions specified in the tables 8.4.7.3.2-1 and 8.4.7.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/VNFINDNotification.Get.204'
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
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
145
146
147
148
149
150
151
152
153
$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
components:
requestBodies:
AlarmListRebuiltNotification:
description: Information that the alarm list has been rebuilt by the VNFM.
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification
required: true
responses:
VNFINDNotification.Post.204:
description: |
204 NO CONTENT
Shall be returned when the notification has been delivered successfully.
The response body shall be empty.
headers:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
VNFINDNotification.Get.204:
description: |
204 NO CONTENT
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string