Newer
Older
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Configuration and Information Management Notification Interface
description: >
SOL009 - NFV-MANO Configuration and Information 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 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
contact:
name: NFV-SOL WG
externalDocs:
description: ETSI GS NFV-SOL 009 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
servers:
- url: http://0.0.0.0/callback/v1
description: >
API HTTP Server
- url: https://0.0.0.0/callback/v1
description: >
API HTTPS Server
paths:
/URI-is-provided-by-the-client-when-creating-the-subscription-ConfigurationAndInformationNotification:
description: >
This resource represents a notification endpoint. The API producer can use this
resource to send notifications related to NFV-MANO configuration and information
management to a subscribed API consumer, which has provided the URI of this
resource during the subscription process.
post:
description: >
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.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreateConfigurationAnfInformationNotificationRequest"
responses:
"204":
$ref: "#/components/responses/notification.post.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
get:
description: >
TThe GET method allows the API producer to test the notification endpoint that
is provided by the API consumer, e.g., during the subscription process.
parameters:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
responses:
"204":
$ref: "#/components/responses/notification.get.204"
"400":
$ref: ../components/SOL009_resp.yaml#/components/responses/400
$ref: ../components/SOL009_resp.yaml#/components/responses/401
$ref: ../components/SOL009_resp.yaml#/components/responses/403
$ref: ../components/SOL009_resp.yaml#/components/responses/404
$ref: ../components/SOL009_resp.yaml#/components/responses/405
$ref: ../components/SOL009_resp.yaml#/components/responses/406
$ref: ../components/SOL009_resp.yaml#/components/responses/422
$ref: ../components/SOL009_resp.yaml#/components/responses/500
$ref: ../components/SOL009_resp.yaml#/components/responses/503
$ref: ../components/SOL009_resp.yaml#/components/responses/504
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
154
155
156
157
158
159
160
161
components:
responses:
notification.post.204:
description: >
204 NO CONTENT
Shall be returned when the notification has been delivered successfully.
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.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
notification.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.
schema:
type: string
Version:
description: >
Version of the API used in the response.
schema:
type: string
requestBodies:
CreateConfigurationAnfInformationNotificationRequest:
description: >
A notification about configuration and information data changes of the
NFV-MANO functional entity, or state changes of the NFV-MANO functional
entity and its managed objects.
content:
application/json:
schema:
oneOf:
- $ref: "../NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml#/components/schemas/InformationChangedNotification"
- $ref: "../NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml#/components/schemas/ChangeStateNotification"
required: true