VNFPackageManagementNotification.yaml 10.4 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "1.1.1"
5
  title: SOL003 - VNF Package Management Notification interface
6
  description: >
7
8
    SOL003 - VNF Package Management Notification interface

9

10
    IMPORTANT: Please note that this file might be not aligned to the current
11
12
13
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

14
15
16
17
18
19
20
    
    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.
21

22
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
23
24
25
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
26
27
28
29

externalDocs:
  description: ETSI GS NFV-SOL 003 V2.4.1
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.04.01_60/gs_NFV-SOL003v020401p.pdf
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

basePath: "/callback/v1"

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
###############################################################################
# Notification endpoint VnfPackageOnboardingNotification                      #
###############################################################################
  '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification':
    #SOL003 location: 10.4.9
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
49
50
51
        Notify


52
53
54
55
56
57
58
59
        The POST method delivers a notification from the server to the client.
      parameters:
        - name: VnfPackageOnboardingNotification
          description: A notification about on-boarding of a VNF package.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification"
Gergely Csatari's avatar
Gergely Csatari committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
        - 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
74
75
76
77
78
79
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
80
81
82
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
83
84
            No Content

85
            The notification was delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
86
87
88
89
90
91
92
93
94
          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.
              type: string
              maximum: 1
              minimum: 0
95
96
97
98
99
100
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    get:
      description: >
        The GET method allows the server to test the notification endpoint
        that is provided by the client, e.g. during subscription.
Gergely Csatari's avatar
Gergely Csatari committed
119
120
121
122
123
124
125
126
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
127
128
129
130
131
132
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
133
134
135
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
136
137
            No Content

138
139
            The notification endpoint was tested successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
140
141
142
143
144
145
146
147
148
          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.
              type: string
              maximum: 1
              minimum: 0
149
150
151
152
153
154
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Notification endpoint VnfPackageChangeNotification                          #
###############################################################################
  '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification':
    #SOL003 location: 10.4.9
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
176
177
178
        Notify

        
179
180
181
182
183
184
185
186
187
        The POST method delivers a notification from the server to the client.
      parameters:
        - name: VnfPackageChangeNotification
          description: >
            A notification about changes of status in a VNF package.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification"
Gergely Csatari's avatar
Gergely Csatari committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201
        - 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
202
203
204
205
206
207
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
208
209
210
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
211
212
            No Content

213
            The notification was delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
214
215
216
217
218
219
220
221
222
          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.
              type: string
              maximum: 1
              minimum: 0
223
224
225
226
227
228
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    get:
      description: >
        The GET method allows the server to test the notification endpoint
        that is provided by the client, e.g. during subscription.
Gergely Csatari's avatar
Gergely Csatari committed
247
248
249
250
251
252
253
254
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
255
256
257
258
259
260
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
261
262
263
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
264
265
            No Content

266
267
            The notification endpoint was tested successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
268
269
270
271
272
273
274
275
276
          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.
              type: string
              maximum: 1
              minimum: 0
277
278
279
280
281
282
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"