NSDManagementNotification.yaml 8.24 KB
Newer Older
1
2
3
swagger: "2.0"

info:
moscatelli's avatar
moscatelli committed
4
  version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
6
7
8
9
10
  title: SOL005 - NSD Management Notification interface
  description: >
    SOL005 - NSD 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.
11
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
  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
produces:
  - application/json

paths:
  ###############################################################################
moscatelli's avatar
moscatelli committed
33
  # Notification endpoint                                                       #
34
  ###############################################################################
moscatelli's avatar
moscatelli committed
35
  '/URI_is_provided_by_the_client_when_creating_the_subscription':
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
    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 NSD and PNFD changes
      description: >
        This resource represents a notification endpoint. The server can use
        this resource to send notifications to a subscribed
        client, which has provided the URI of this resource during the subscription process.

        The POST method delivers a notification from the server to the client.
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as
        specified in the Table 5.4.10.3.1-2.
      parameters:
        - name: NsdOnBoardingNotification
          description: >
            A notification about the successful on-boarding of an NSD.
          in: body
moscatelli's avatar
moscatelli committed
67
68
69
70
          required: false
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdOnBoardingNotification"
        - name: NsdOnBoardingFailureNotification
71
          description: >
moscatelli's avatar
moscatelli committed
72
73
74
75
76
77
            A notification about the failure of on-boarding an NSD.
          in: body
          required: false
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdOnBoardingFailureNotification"
        - name: NsdChangeNotification
78
          description: >
moscatelli's avatar
moscatelli committed
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
            A notification about the state change of an on-boarded NSD.
          in: body
          required: false
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdChangeNotification"
        - name: NsdDeletionNotification
          description: >
            A notification about the deletion of an on-boarded NSD.
          in: body
          required: false
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdDeletionNotification"
        - name: PnfdOnBoardingNotification
          description: >
            A notification about the successful on-boarding of a PNFD.
          in: body
          required: false
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdOnBoardingNotification"
98
99
100
101
        - name: PnfdOnBoardingFailureNotification
          description: >
            A notification about the failure of on-boarding a PNFD.
          in: body
moscatelli's avatar
moscatelli committed
102
          required: false
103
104
105
106
107
108
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdOnBoardingFailureNotification"
        - name: PnfdDeletionNotification
          description: >
            A notification about the deletion of an on-boarded PNFD.
          in: body
moscatelli's avatar
moscatelli committed
109
          required: false
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
          schema:
            $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdDeletionNotification"
        - 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
      responses:
        204:
          description: >
moscatelli's avatar
moscatelli committed
129
            204 NO CONTENT
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

            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: >
        This resource represents a notification endpoint. The server can use
        this resource to send notifications to a subscribed
        client, which has provided the URI of this resource during the subscription process.

        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 Table 5.4.10.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: >
            204 NO CONTENT

            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:
moscatelli's avatar
moscatelli committed
220
          $ref: "../responses/SOL005_resp.yaml#/responses/503"