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

info:
Giacomo Bernini's avatar
Giacomo Bernini committed
4
  version: "2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL003 - VNF Package Management Notification interface
6
  description: >
7
8
    SOL003 - VNF Package Management Notification interface

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

13
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
14
15
16
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
17
18

externalDocs:
19
20
  description: ETSI GS NFV-SOL 003 V2.8.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.08.01_60/gs_NFV-SOL003v020801p.pdf
21

22
basePath: "/callback/v2"
23
24
25
26
27
28
29
30
31
32

schemes:
  - https

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

paths:
33
34
35
  ###############################################################################
  # Notification endpoint VnfPackageOnboardingNotification                      #
  ###############################################################################
36
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageOnboardingNotification':
37
38
39
    #SOL003 location: 10.4.9
    post:
      description: >
40
41
42
43
44
        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 10.4.9.3.1-1 and 10.4.9.3.1-2
        for URI query parameters, request and response data structures, and response codes.
45
46
47
48
49
50
51
      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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
        - 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
66
67
68
69
70
71
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
72
73
      responses:
        204:
74
          description: >
75
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
76

77
            Shall be returned when the notification has been delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
78
79
80
81
82
83
84
85
86
          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
87
88
89
90
91
92
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
93
94
95
96
97
98
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
99
100
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
101
102
103
104
105
106
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
moscatelli's avatar
moscatelli committed
107

108
109
    get:
      description: >
110
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer
111
112
113
        e.g. during subscription.
        This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
114
115
116
117
118
119
120
121
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
122
123
124
125
126
127
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
128
129
      responses:
        204:
130
          description: >
131
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
132

133
            Shall be returned to indicate that the notification endpoint has been tested successfully.
134
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
135
136
137
138
139
140
141
142
143
          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
144
145
146
147
148
149
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
150
151
152
153
154
155
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
156
157
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
158
159
160
161
162
163
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
164

165
166
167
  ###############################################################################
  # Notification endpoint VnfPackageChangeNotification                          #
  ###############################################################################
168
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageChangeNotification':
169
170
171
    #SOL003 location: 10.4.9
    post:
      description: >
172
173
174
175
176
        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 10.4.9.3.1-1 and 10.4.9.3.1-2
        for URI query parameters, request and response data structures, and response codes.
177
178
179
180
181
182
183
184
      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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
        - 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
199
200
201
202
203
204
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
205
206
      responses:
        204:
207
          description: >
208
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
209

210
            Shall be returned when the notification has been delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
211
212
213
214
215
216
217
218
219
          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
220
221
222
223
224
225
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
226
227
228
229
230
231
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
232
233
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
234
235
236
237
238
239
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
moscatelli's avatar
moscatelli committed
240

241
242
    get:
      description: >
243
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer
244
245
246
         e.g. during subscription.
        This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2
        for URI query parameters, request and response data structures, and response codes.
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
      responses:
        204:
263
          description: >
264
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
265

266
            Shall be returned to indicate that the notification endpoint has been tested successfully.
267
            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
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
289
290
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
291
292
293
294
295
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
296
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"