VNFPackageManagement.yaml 53 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "1.0.0"
rameshnaraya's avatar
rameshnaraya committed
5
  title: SOL005 - VNF Package Management Interface
6
  description: >
rameshnaraya's avatar
rameshnaraya committed
7
    SOL005 - VNF Package Management Interface
8
9
10
11
12
13
14
15
    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
16
  contact:
17
18
19
20
21
22
23
24
25
26
    name: "NFV-SOL WG"
externalDocs:
  description: ETSI GS NFV-SOL 005 V2.4.1
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/vnfpkgm/v1"
schemes:
  - https
consumes:
  - "application/json"
produces:
27
  - "application/json"
28
paths:
29
30
31
  ###############################################################################
  # VNF Packages                                                                #
  ###############################################################################
32
33
34
  '/vnf_packages':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
    get:
rameshnaraya's avatar
rameshnaraya committed
35
      summary: Query VNF packages information.
36
      description: >
rameshnaraya's avatar
rameshnaraya committed
37
38
39
40
        The GET method queries the information of the VNF packages matching the filter.
        This method shall follow the provisions specified in the 
        Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
41
42
43
44
45
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
46
          description: >
47
48
49
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this parameter as part of the URI query string. The
            OSS/BSS may supply this parameter.
50
            All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
51
            be supported by the NFVO in the filter expression.
52
53
54
55
        - name: "all_fields"
          in: "query"
          required: false
          type: "string"
56
          description: >
rameshnaraya's avatar
rameshnaraya committed
57
58
            Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
            shall support this parameter.
59
60
61
62
        - name: "fields"
          in: "query"
          required: false
          type: "string"
63
          description: >
rameshnaraya's avatar
rameshnaraya committed
64
65
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.         
66
67
68
69
        - name: "exclude_fields"
          in: "query"
          required: false
          type: "string"
70
          description: >
rameshnaraya's avatar
rameshnaraya committed
71
72
            Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
73
74
75
76
        - name: "exclude_default"
          in: "query"
          required: false
          type: "string"
77
          description: >
rameshnaraya's avatar
rameshnaraya committed
78
79
80
            Indicates to exclude the following complex attributes from the response. See clause 4.3.3
            for details.
            The NFVO shall support this parameter.
81
82
83
84
85
86
            The following attributes shall be excluded from the VnfPkgInfo structure in the response
            body if this parameter is provided, or none of the parameters "all_fields," "fields",
            "exclude_fields", "exclude_default" are provided:
            - softwareImages
            - additionalArtifacts
            - userDefinedData
rameshnaraya's avatar
rameshnaraya committed
87
            - checksum
88
89
90
91
92
93
94
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
95
96
97
98
99
100
101
102
103
104
105
106
107
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
108
          type: string
109
110
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
111
          description: >
112
            200 OK
113

rameshnaraya's avatar
rameshnaraya committed
114
115
116
117
118
119
120
            Information of the selected VNF packages.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
121
            WWW-Authenticate:
122
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
123
124
              description: >
                Challenge if the corresponding HTTP request has not provided
125
126
127
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
128
              minimum: 0
129
          schema:
rameshnaraya's avatar
rameshnaraya committed
130
            type: array
131
            items:
rameshnaraya's avatar
rameshnaraya committed
132
133
              properties:
                VnfPkgInfo:
134
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
        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"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
152
          $ref: "responses/SOL005_resp.yaml#/responses/503"
153
154

    post:
rameshnaraya's avatar
rameshnaraya committed
155
      summary: Create a new individual VNF package resource.
156
      description: >
rameshnaraya's avatar
rameshnaraya committed
157
        The POST method creates a new individual VNF package resource.
158
      parameters:
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
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - 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
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "CreateVnfPkgInfoRequest"
            properties:
              CreateVnfPkgInfoRequest:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
            description: >
              IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2

193
194
      responses:
        201:
195
          description: >
196
            201 Created            
197

198
            An individual VNF package resource has been created successfully.
199
200
201
202
203
            The response body shall contain a representation of
            the new individual VNF package resource, as defined
            in clause 9.5.2.4.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the individual
204
            VNF package resource.
205
          schema:
206
207
208
            properties:
              VnfPkgInfo:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
209
          headers:
210
            Content-Type:
211
              type: "string"
212
213
214
215
216
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
              maximum: 1
217
              minimum: 1
218
219
220
221
222
223
224
225
            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
226
227
228
  ###############################################################################
  # Individual VNF Package                                                      #
  ###############################################################################
229
230
  '/vnf_packages/{vnfPkgId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
231
232
233
234
235
    parameters:
      - name: "vnfPkgId"
        description: >
          Identifier of the VNF package. The identifier is allocated by the NFVO.  
        in: "path"
236
        type: "string"
237
        required: true
238
    get:
rameshnaraya's avatar
rameshnaraya committed
239
      summary: Read information about an individual VNF package.
240
      description: >
241
        The GET method reads the information of a VNF package.
242
243
244
245
246
247
248
249
250
251
252
253
254
255
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
256
          type: string
257
258
      responses:
        200:
259
260
          description: >
            200 OK
261

262
263
264
            Information of the VNF package was read successfully.
            The response body shall contain the VNF package
            info representation defined in clause 9.5.2.5.     
265
          schema:
266
            type: "object"
rameshnaraya's avatar
rameshnaraya committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
            properties:
              VnfPkgInfo:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
          headers:
            Content-Type:
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
            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.
282
283
              maximum: 1
              minimum: 0
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
        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"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
301
          $ref: "responses/SOL005_resp.yaml#/responses/503"
302
    delete:
rameshnaraya's avatar
rameshnaraya committed
303
      summary: Delete an individual VNF package.
304
      description: >
305
        The DELETE method deletes an individual VNF Package resource.
306
307
308
309
310
311
312
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
313
          type: string
314
315
316
      responses:
        204:
          description: >
317
            204 No Content
318

rameshnaraya's avatar
rameshnaraya committed
319
320
            The VNF package was deleted successfully.
            The response body shall be empty.
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
        409:
          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/409"
        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"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
340
          $ref: "responses/SOL005_resp.yaml#/responses/503"
341
    patch:
rameshnaraya's avatar
rameshnaraya committed
342
      summary: Update information about an individual VNF package.
343
      description: >
344
        "The PATCH method updates the information of a VNF package."
345

346
347
348
349
        "This method shall follow the provisions specified in the 
        Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query parameters,
        request and response data structures, and response codes."
      parameters:
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "VnfPkgInfoModifications"
            properties:
              VnfPkgInfoModifications:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfoModifications"
            description: >
              Parameters for VNF package information modifications.
        - 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
      responses:
377
        200:
rameshnaraya's avatar
rameshnaraya committed
378
          description: >
379
            200 OK
380

rameshnaraya's avatar
rameshnaraya committed
381
            The operation was completed successfully.
382
            The response body shall contain attribute
rameshnaraya's avatar
rameshnaraya committed
383
384
            modifications for an "Individual VNF
            package" resource
385
386
387
388
389
390
391
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
392
              type: "string"
393
394
              description: >
                Challenge if the corresponding HTTP request has not provided
395
396
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
397
398
399
              maximum: 1
              minimum: 0
          schema:
rameshnaraya's avatar
rameshnaraya committed
400
            properties:
401
              VnfPkgInfoModifications:
rameshnaraya's avatar
rameshnaraya committed
402
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfoModifications"
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
        409:
          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/409"
        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"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
422
423
424
425
426
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # VNFD in an individual VNF package                                           #
  ###############################################################################
427
428
429
430
431
  '/vnf_packages/{vnfPkgId}/vnfd':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.4
    parameters:
      - name: vnfPkgId
        description: >
rameshnaraya's avatar
rameshnaraya committed
432
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
433
434
        in: path
        type: string
435
        required: true
436
    get:
rameshnaraya's avatar
rameshnaraya committed
437
      summary: Read VNFD of an on-boarded VNF package.
438
      description: >
rameshnaraya's avatar
rameshnaraya committed
439
        The GET method reads the content of the VNFD within a VNF package.
440

rameshnaraya's avatar
rameshnaraya committed
441
        The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the
442
443
444
445
446
447
448
449
450
451
452
453
454
        form of multiple files, a ZIP file embedding these files shall be returned. If the VNFD is implemented as a single file,
        either that file or a ZIP file embedding that file shall be returned.
        The selection of the format is controlled by the "Accept" HTTP header passed in the GET request.
        • If the "Accept" header contains only "text/plain" and the VNFD is implemented as a single file, the file shall
        be returned; otherwise, an error message shall be returned.
        • If the "Accept" header contains only "application/zip", the single file or the multiple files that make up the
        VNFD shall be returned embedded in a ZIP file.
        • If the "Accept" header contains both "text/plain" and "application/zip", it is up to the NFVO to choose the
        format to return for a single-file VNFD; for a multi-file VNFD, a ZIP file shall be returned.
        The default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 004 [5] where only the YAML files
        representing the VNFD, and information necessary to navigate the ZIP file and to identify the file that is the entry point
        for parsing the VNFD (such as TOSCA-meta or manifest files or naming conventions) are included.
        This method shall follow the provisions specified in the Tables 9.4.4.3.2-1 and 9.4.4.3.2-2 for URI query parameters,
rameshnaraya's avatar
rameshnaraya committed
455
        request and response data structures, and response codes.
456
      parameters:
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
473
474
      responses:
        200:
475
          description: >
476
            200 OK
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492

            On success, the content of the VNFD is returned.
            The payload body shall contain a copy of the file
            representing the VNFD or a ZIP file that contains the
            file or multiple files representing the VNFD, as
            specified above.
            The "Content-Type" HTTP header shall be set
            according to the format of the returned file, i.e. to
            "text/plain" for a YAML file or to "application/zip" for a ZIP file.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
493
              type: "string"
494
495
              description: >
                Challenge if the corresponding HTTP request has not provided
496
497
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
              maximum: 1
              minimum: 0
        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:
          description: >
            "406 Not AccepTable"
513
514

          $ref: "responses/SOL005_resp.yaml#/responses/406"
515
516
517
        409:
          description: >
            "409 Conflict"
518
519

          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/406-state-conflict"
520
521
522
523
524
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
525
526
527
528
529
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # VNF Package Content                                                         #
  ###############################################################################
530
  '/vnf_packages/{vnfPkgId}/package_content':
531
532
533
534
535
536
537
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5
    parameters:
      - name: "vnfPkgId"
        description: >
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
        in: "path"
        required: true
538
        type: "string"
539
    get:
rameshnaraya's avatar
rameshnaraya committed
540
      summary: Fetch an on-boarded VNF package.
541
      description: >
rameshnaraya's avatar
rameshnaraya committed
542
543
544
        The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.
        This method shall follow the provisions specified in the Tables 9.4.5.3.2-1 and 9.4.5.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
545
      parameters:
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - application/zip
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: "Range"
          in: "header"
          required: false
          type: "string"
          description: >
            The request may contain a "Range" HTTP header to obtain single
            range of bytes from the VNF package file. This can be used to
            continue an aborted transmission.

            If the NFVO does not support range requests, it should return the
            whole file with a 200 OK response instead.
572
573
      responses:
        200:
574
          description: >
575
            200 OK
576
577
578
579
580
581
582
583
584
585
586
587
588
589

            On success, a copy of the VNF package file is returned.
            The response body shall include a copy of the VNF package file.
            The "Content-Type" HTTP header shall be set
            according to the type of the file, i.e. to "application/zip"
            for a VNF Package as defined in ETSI
            GS NFV-SOL 004 [5].
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
590
              type: "string"
591
592
              description: >
                Challenge if the corresponding HTTP request has not provided
593
594
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
595
596
597
598
599
              maximum: 1
              minimum: 0
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        409:
600
          description: >
601
602
          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/409-state-conflict-ONBOARDING"
        416:
603
          $ref: "responses/SOL005_resp.yaml#/responses/416"
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
        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:
619
620
          $ref: "responses/SOL005_resp.yaml#/responses/503"

621
    put:
rameshnaraya's avatar
rameshnaraya committed
622
      summary: Upload a VNF package by providing the content of the VNF package.
623
      description: >
rameshnaraya's avatar
rameshnaraya committed
624
625
626
627
        The PUT method uploads the content of a VNF package.
        This method shall follow the provisions specified in the 
        Tables 9.4.5.3.3-1 and 9.4.5.3.3-2 for URI query parameters,
        request and response data structures, and response codes.
628
      consumes:
629
        - multipart/form-data
630
      parameters:
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - application/zip
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - in: formData
          name: file
          required: false
          type: file
          description: >
            The payload body contains a ZIP file that represents the VNF package.
            The "Content-Type" HTTP header shall be set according to the
            type of the file, i.e. to "application/zip" for a VNF Package as
            defined in ETSI GS NFV-SOL 004 [5].
655
656
      responses:
        202:
657
          description: >
658
            202 Accepted
659

rameshnaraya's avatar
rameshnaraya committed
660
661
662
663
            The VNF package was accepted for uploading, but the
            processing has not been completed. It is expected to
            take some time for processing.
            The response body shall be empty.
664
        409:
665
          description: >
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/409-state-conflict-ONBOARDING-NOT-CREATED"
        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:
682
          $ref: "responses/SOL005_resp.yaml#/responses/503"
683

684
685
686
  ###############################################################################
  # Upload VNF package from URI task                                            #
  ###############################################################################
687
688
689
  '/vnf_packages/{vnfPkgId}/package_content/upload_from_uri':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.6   
    post:
rameshnaraya's avatar
rameshnaraya committed
690
      summary: Upload a VNF package by providing the address information of the VNF package.
691
      description: >
692
693
694
695
        The POST method provides the information for the NFVO to get the content of a VNF package.
        This method shall follow the provisions specified in the 
        Tables 9.4.6.3.1-1 and 9.4.6.3.1-2 for URI query parameters,
        request and response data structures, and response codes.        
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - 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

        - name: "vnfPkgId"
          description: >
            Identifier of the VNF package. The identifier is allocated by the NFVO.
          in: "path"
          required: true
          type: "string"

        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "UploadVnfPkgFromUriRequest"
            properties:
              UploadVnfPkgFromUriRequest:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest"
            description: >
              The payload body contains the address information based on
              which the NFVO can obtain the content of the VNF package.

740
741
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
742
          description: >
743
            202 Accepted
744

rameshnaraya's avatar
rameshnaraya committed
745
            The information about the VNF package was received
746
747
            successfully, but the on-boarding has not been
            completed. It is expected to take some time for processing.
rameshnaraya's avatar
rameshnaraya committed
748
            The response body shall be empty.
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
        409:
          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/409-state-conflict-ONBOARDING-NOT-CREATED"
        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:
766
767
768
769
770
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # Individual VNF package artifact                                             #
  ###############################################################################
771
  '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
772
773
774
775
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.7
    parameters:
      - name: vnfPkgId
        description: >
776
          Identifier of the VNF package.
777
778
779
780
781
782
783
784
          The identifier is allocated by the NFVO.
          This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or
          VnfPackageChangeNotification.
        in: path
        type: string
        required: true
      - name: artifactPath
        description: >
785
786
787
788
789
790
791
          Sequence of one or path segments representing the path of the artifact 
          within the VNF package.
          EXAMPLE: foo/bar/run.sh
          This identifier can be retrieved from the "artifactPath" attribute of 
          the applicable "additionalArtifacts" entry in the body of the response 
          to a GET request querying the "Individual VNF package" or the 
          "VNF packages" resource.
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
        in: path
        type: string
        required: true
    get:
      summary: Fetch individual VNF package artifact.
      description: >
        The GET method fetches the content of an artifact within a VNF package.
        This method shall follow the provisions specified in the
        Tables 9.4.7.3.2-1 and 9.4.7.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.
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Range
          description: >
            The request may contain a "Range" HTTP header to obtain single
            range of bytes from the VNF package file. This can be used to
            continue an aborted transmission.
            If the NFVO does not support range requests, it should return the
            whole file with a 200 OK response instead.
          in: header
          type: string
      responses:
        200:
          description: >
            200 OK
             On success, the content of the artifact is returned.
            The payload body shall contain a copy of the artifact file from
            the VNF package, as defined by ETSI GS NFV-SOL 004.
            The "Content-Type" HTTP header shall be set according to the
            content type of the artifact file. If the content type cannot be
            determined, the header shall be set to the value
            "application/octet-stream".
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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

        206:
          description: >
            Partial Content.
            On success, if the NFVO supports range requests, a single
            consecutive byte range from the content of the VNF package file is
            returned.
            The response body shall contain the requested part of the VNF
            package file.
            The "Content-Range" HTTP header shall be provided according to
            IETF RFC 7233.
            The "Content-Type" HTTP header shall be set as defined above for
            the "200 OK" response.
          headers:
            Content-Range:
              type: string
              maximum: 1
              minimum: 1
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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
        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"
        409:
          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/409"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ##############################################################################
  # Subscriptions                                                               #
  ###############################################################################
905
  '/subscriptions':
906
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.8
907
    post:
rameshnaraya's avatar
rameshnaraya committed
908
      summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
909
      description: >
910
        The POST method creates a new subscription.
rameshnaraya's avatar
rameshnaraya committed
911
912
913
914
915
916
917
918
        This method shall follow the provisions specified in the Tables 9.4.8.3.1-1 and 9.4.8.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
        Creation of two subscription resources with the same callbackURI and the same filter can result in performance
        degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
        Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
        same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
        to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
        the existing subscription resource with the same filter and callbackUri).
919
      parameters:
920
        - name: Accept
921
          description: >
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - 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
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "PkgmSubscriptionRequest"
            properties:
              PkgmSubscriptionRequest:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
            description: >
              Representation of the created subscription resource.
              The HTTP response shall include a "Location" HTTP header that
              points to the created subscription resource.

956
957
      responses:
        201:
rameshnaraya's avatar
rameshnaraya committed
958
          description: >
959
            201 Created
960

961
            Representation of the created subscription resource.
rameshnaraya's avatar
rameshnaraya committed
962
963
            The HTTP response shall include a "Location"
            HTTP header that points to the created subscription resource.
964
965
966
967
968
969
970
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
971
              type: "string"
972
973
              description: >
                Challenge if the corresponding HTTP request has not provided
974
975
976
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
977
              minimum: 0
978
979
980
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
981
982
              properties:
                PkgmSubscription:
983
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
        303:
          $ref: "responses/SOL005_resp.yaml#/responses/303"
        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"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1004
    get:
1005
      summary: Query multiple subscriptions.
1006
      description: >
rameshnaraya's avatar
rameshnaraya committed
1007
1008
1009
1010
1011
        The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used
        e.g. for resynchronization after error situations.
        This method shall follow the provisions specified in the 
        Tables 9.4.7.8.2-1 and 9.4.8.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
1012
1013
1014
1015
1016
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
1017
          description: >
1018
1019
1020
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this filtering parameter as part of the URI query
            string. The OSS/BSS may supply this filtering parameter.
1021
            All attribute names that appear in the PkgmSubscription and in data types
1022
            referenced from it shall be supported by the NFVO in the filtering expression.
1023
1024
1025
1026
1027
1028
1029
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1044
1045
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
1046
          description: >
1047
            200 OK
1048

rameshnaraya's avatar
rameshnaraya committed
1049
            Active subscriptions of the functional block that invokes the method.
1050
1051
1052
1053
1054
1055
1056
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
1057
              type: "string"
1058
1059
              description: >
                Challenge if the corresponding HTTP request has not provided
1060
1061
1062
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1063
              minimum: 0
1064
1065
1066
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
1067
1068
              properties:
                PkgmSubscription:
1069
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
        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"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1088
1089
1090
1091

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
1092
  '/subscriptions/{subscriptionId}':
1093
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.9
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
    parameters:
      - name: subscriptionId
        description: >
          Identifier of this subscription.
          This identifier can be retrieved from the resource referenced by
          the "Location" HTTP header in the response to a POST request
          creating a new subscription resource. It can also be retrieved from
          the "id" attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
1106
      summary: Read an individual subscription resource.
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
      description: >
        Query Subscription Information
        The GET method reads an individual subscription.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
1127
          description: >
1128
            200 OK
1129

1130
1131
1132
1133
1134
1135
1136
1137
            Representation of the subscription resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
1138
              type: "string"
1139
1140
              description: >
                Challenge if the corresponding HTTP request has not provided
1141
1142
1143
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1144
              minimum: 0
1145
          schema:
rameshnaraya's avatar
rameshnaraya committed
1146
            properties:
1147
              PkgmSubscription:
1148
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
        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"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
    delete:
1168
      summary: Terminate a subscription.
1169
      description: >
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
        The DELETE method terminates an individual subscription.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        204:
1181
          description: >
1182
            No Content
1183
1184
1185
1186

            The subscription resource was deleted successfully.
          headers:
            WWW-Authenticate:
1187
              type: "string"
1188
1189
              description: >
                Challenge if the corresponding HTTP request has not provided
1190
1191
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
              maximum: 1
              minimum: 0
        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"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
rameshnaraya's avatar
rameshnaraya committed
1210
1211
1212
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

1213
1214
1215
1216
1217
  ##################################################################################
  # Notification endpoint                                                          #
  # Dummy URI is used for testing.                                                 #
  # In real, resource URI is provided by the client when creating the subscription.#
  ##################################################################################
1218
1219
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageOnboardingNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.10
rameshnaraya's avatar
rameshnaraya committed
1220
    post:
1221
      summary: Notify about VNF package onboarding or change
rameshnaraya's avatar
rameshnaraya committed
1222
1223
1224
1225
      description: >
        The POST method delivers a notification from the server to the client.
        This method shall follow the provisions specified in the 
        Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters,
1226
        request and response data structures, and response codes.        
rameshnaraya's avatar
rameshnaraya committed
1227
1228
1229
      parameters:
        - name: VnfPackageOnboardingNotification
          description: >
1230
            A notification about on-boarding of a VNF package.
rameshnaraya's avatar
rameshnaraya committed
1231
1232
1233
1234
1235
          in: body
          required: true
          schema:
            properties:
              VnfPackageOnboardingNotification:
1236
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPackageOnboardingNotification"
rameshnaraya's avatar
rameshnaraya committed
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - 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
      responses:
        204:
          description: >
1261
            204 No Content
1262

1263
1264
1265
1266
1267
1268
1269
1270
1271
            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
1272
              minimum: 0
rameshnaraya's avatar
rameshnaraya committed
1273
1274
1275
1276
1277
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
1278
          $ref: "responses/SOL005_resp.yaml#/responses/403"
rameshnaraya's avatar
rameshnaraya committed
1279
1280
1281
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
1282
1283
          $ref: "responses/SOL005_resp.yaml#/responses/503"

1284
1285
1286
1287
1288
1289
1290
1291
1292
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageChangeNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.10  
    post:
      summary: Notify about VNF package onboarding or change
      description: >
        The POST method delivers a notification from the server to the client.
        This method shall follow the provisions specified in the 
        Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters,
        request and response data structures, and response codes.        
1293
      parameters:
1294
1295
1296
1297
1298
1299
1300
1301
        - name: VnfPackageChangeNotification
          description: >
            A notification about changes of status in a VNF package.
          in: body
          required: true
          schema:
            properties:
              VnfPackageChangeNotification:
1302
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPackageChangeNotification"
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - 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
      responses:
        204:
          description: >
            204 No Content
1328

1329
1330
1331
1332
1333
1334
1335
1336
1337
            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
1338
              minimum: 0
1339
1340
1341
1342
1343
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
1344
          $ref: "responses/SOL005_resp.yaml#/responses/403"
1345
1346
1347
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
1348
1349
          $ref: "responses/SOL005_resp.yaml#/responses/503"

rameshnaraya's avatar
rameshnaraya committed
1350
    get:
1351
      summary: Test the notification endpoint
rameshnaraya's avatar
rameshnaraya committed
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
      description: >
        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 Tables 9.4.10.3.2-1 and 9.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
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        204:
          description: >
1375
            204 No Content