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

info:
  version: "2.4.1"
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
16
17
18
19
20
21
22
23
24
25
26
27
28
29
    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
    Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact: 
    name: "NFV-SOL WG"
externalDocs:
  description: ETSI GS NFV-SOL 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:
  - "application/json"
30
  
31
paths:
32
33
34
35
36
37
###############################################################################
# VNF Packages                                                                #
###############################################################################
  '/vnf_packages':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
    get:
rameshnaraya's avatar
rameshnaraya committed
38
      summary: Query VNF packages information.
39
      description: > 
rameshnaraya's avatar
rameshnaraya committed
40
41
42
43
        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.
44
45
46
47
48
49
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
50
            Attribute-based filtering parameters according to clause 4.3.2.
51
52
53
            The NFVO shall support receiving filtering parameters as part of the URI query string. The
            OSS/BSS may supply filtering parameters.
            All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
rameshnaraya's avatar
rameshnaraya committed
54
            be supported in attribute-based filtering parameters.
55
56
57
58
59
        - name: "all_fields"
          in: "query"
          required: false
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
60
61
            Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
            shall support this parameter.
62
63
64
65
66
        - name: "fields"
          in: "query"
          required: false
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
67
68
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.         
69
70
71
72
73
        - name: "exclude_fields"
          in: "query"
          required: false
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
74
75
            Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
76
77
78
79
80
        - name: "exclude_default"
          in: "query"
          required: false
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
81
82
83
            Indicates to exclude the following complex attributes from the response. See clause 4.3.3
            for details.
            The NFVO shall support this parameter.
84
85
86
87
88
89
            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
90
            - checksum
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
        - 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
          description: >
            200 OK.
            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
            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.              
122
          schema:
rameshnaraya's avatar
rameshnaraya committed
123
            type: array
124
            items:
rameshnaraya's avatar
rameshnaraya committed
125
126
127
              properties:
                VnfPkgInfo:
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo" 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
        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"          

    post:
rameshnaraya's avatar
rameshnaraya committed
148
      summary: Create a new individual VNF package resource.
149
      description: >  
rameshnaraya's avatar
rameshnaraya committed
150
        The POST method creates a new individual VNF package resource.
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
      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
rameshnaraya's avatar
rameshnaraya committed
172
173
174
175
176
177
178
179
180
181
182
183
184
185
        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
            
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
      responses:
        201:
          description: >  
            "Status 201 - Created"
            
            
            "An individual VNF package resource has been created successfully.
            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
            VNF package resource."
          schema:
            $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
          headers:
            Location:
              type: "string"
              description: >  
                "The HTTP response shall include a "Location" HTTP header
                that contains the resource URI of the new NS descriptor resource."
###############################################################################
# Individual VNF Package                                                      #
###############################################################################                
  '/vnf_packages/{vnfPkgId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
    get:
rameshnaraya's avatar
rameshnaraya committed
213
      summary: Read information about an individual VNF package.
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
      description: >  
        "This resource represents an individual VNF package. 
        The client can use this resource to read information of the VNF
        package, update information of the VNF package, or delete a VNF package."
      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
235
          description: 200 OK.
236
          schema:
rameshnaraya's avatar
rameshnaraya committed
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
            type: "object"
            description: >                
              Information of the VNF package.
            properties:
              VnfPkgInfo:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
          headers:
            Location:
              type: "string"
              description: >
                The HTTP response shall include a Location HTTP header
                that contains the resource URI of the new NS descriptor resource.
            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.
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
        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:
rameshnaraya's avatar
rameshnaraya committed
279
      summary: Delete an individual VNF package.
280
281
282
283
284
285
286
287
288
289
290
291
292
      description: >  
        "The DELETE method deletes an individual NS descriptor resource.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string          
      responses:
        204:
          description: >
rameshnaraya's avatar
rameshnaraya committed
293
294
295
296
            204 No Content.
            
            The VNF package was deleted successfully.
            The response body shall be empty.
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
        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:
          $ref: "responses/SOL005_resp.yaml#/responses/503"           
    patch:
rameshnaraya's avatar
rameshnaraya committed
318
      summary: Update information about an individual VNF package.
319
320
321
322
323
324
325
      description: >  
        "The PATCH method updates the information of a VNF package."
        
        "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:
rameshnaraya's avatar
rameshnaraya committed
326
      - name: "body"
327
328
329
330
331
332
333
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "VnfPkgInfoModifications"
          properties:
rameshnaraya's avatar
rameshnaraya committed
334
            VnfPkgInfoModifications:
335
336
              $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfoModifications"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
337
            Parameters for VNF package information modifications.
338
339
340
341
342
343
344
345
346
347
348
349
350
351
      - 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                    
rameshnaraya's avatar
rameshnaraya committed
352
                
353
354
      responses:          
        200:
rameshnaraya's avatar
rameshnaraya committed
355
356
357
358
          description: >
            200 OK.
            
            The operation was completed successfully.
359
            The response body shall contain attribute
rameshnaraya's avatar
rameshnaraya committed
360
361
            modifications for an "Individual VNF
            package" resource
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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
          schema:
rameshnaraya's avatar
rameshnaraya committed
377
378
379
            properties:
              VnfPkgInfoModifications:            
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfoModifications"
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
        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:
          $ref: "responses/SOL005_resp.yaml#/responses/503"             
          
    parameters:
    - name: "vnfPkgId"
      description: >
rameshnaraya's avatar
rameshnaraya committed
404
        Identifier of the VNF package. The identifier is allocated by the NFVO.  
405
406
407
408
409
410
411
412
413
414
415
416
      in: "path"
      required: true
      type: "string"
     
###############################################################################
# VNFD in an individual VNF package                                           #
###############################################################################         
  '/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
417
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
418
419
420
421
        in: path
        type: string
        required: true   
    get:
rameshnaraya's avatar
rameshnaraya committed
422
      summary: Read VNFD of an on-boarded VNF package.
423
      description: >  
rameshnaraya's avatar
rameshnaraya committed
424
        The GET method reads the content of the VNFD within a VNF package.
425
        
rameshnaraya's avatar
rameshnaraya committed
426
        The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the
427
428
429
430
431
432
433
434
435
436
437
438
439
        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
440
        request and response data structures, and response codes.
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
      parameters:
      - 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
      responses:
        200:
          description: > 
rameshnaraya's avatar
rameshnaraya committed
461
            200 OK.
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517

            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:
              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
        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"
            
          $ref: "responses/SOL005_resp.yaml#/responses/406"       
        409:
          description: >
            "409 Conflict"
            
          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/406-state-conflict"          
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"            
          
###############################################################################
# VNF Package Content                                                         #
###############################################################################         
  '/vnf_packages/{vnfPkgId}/package_content':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5   
    get:
rameshnaraya's avatar
rameshnaraya committed
518
      summary: Fetch an on-boarded VNF package.
519
      description: >  
rameshnaraya's avatar
rameshnaraya committed
520
521
522
        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.
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
      parameters:
      - 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
      - name: "Range"
        in: "header"
        required: false
        type: "string"
        description: >  
          The request may contain a "Range" HTTP header to obtain single
rameshnaraya's avatar
rameshnaraya committed
546
547
          range of bytes from the VNF package file. This can be used to
          continue an aborted transmission.
548
549
550
551
552
553
           
          If the NFVO does not support range requests, it should return the
          whole file with a 200 OK response instead.
      responses:
        200:
          description: > 
rameshnaraya's avatar
rameshnaraya committed
554
            200 OK.
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578

            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:
              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
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        409:
rameshnaraya's avatar
rameshnaraya committed
579
          description: >   
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/409-state-conflict-ONBOARDING"
        416:
          description: >
            "416 Range Not Satisfiable"        
          $ref: "responses/SOL005_resp.yaml#/responses/416-range-not-satisfiable"
        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"            
              
    put:
rameshnaraya's avatar
rameshnaraya committed
603
      summary: Upload a VNF package by providing the content of the VNF package.
604
      description: >  
rameshnaraya's avatar
rameshnaraya committed
605
606
607
608
        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.
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
      consumes:
        - multipart/form-data        
      parameters:         
      - 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].      
      responses:
        202:
          description: > 
rameshnaraya's avatar
rameshnaraya committed
624
            202 Accepted.
625
            
rameshnaraya's avatar
rameshnaraya committed
626
627
628
629
            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.
630
        409:
rameshnaraya's avatar
rameshnaraya committed
631
          description: >         
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
          $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:
          $ref: "responses/SOL005_resp.yaml#/responses/503"          
    parameters:
    - name: "vnfPkgId"
rameshnaraya's avatar
rameshnaraya committed
651
652
      description: >
        Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
653
654
655
656
657
658
659
660
661
662
      in: "path"
      required: true
      type: "string"

###############################################################################
# Upload VNF package from URI task                                            #
###############################################################################         
  '/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
663
      summary: Upload a VNF package by providing the address information of the VNF package.
664
      description: >  
rameshnaraya's avatar
rameshnaraya committed
665
        This task resource represents the "Upload VNF package from URI" operation. The client can use this resource to
666
        request the uploading of a VNF package by providing address information to the NFVO for retrieving the content of the
rameshnaraya's avatar
rameshnaraya committed
667
        VNF package.       
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
      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   
rameshnaraya's avatar
rameshnaraya committed
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
        
      - 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.         
          
712
713
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
714
715
          description: >
            202 Accepted.
716
            
rameshnaraya's avatar
rameshnaraya committed
717
            The information about the VNF package was received
718
719
            successfully, but the on-boarding has not been
            completed. It is expected to take some time for processing.
rameshnaraya's avatar
rameshnaraya committed
720
            The response body shall be empty.
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
        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:
          $ref: "responses/SOL005_resp.yaml#/responses/503"          
          
###############################################################################          
# Individual VNF package artifact                                             #     
###############################################################################
  '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
   #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.6   
    parameters:
rameshnaraya's avatar
rameshnaraya committed
746
    - name: vnfPkgId
747
      description: >
rameshnaraya's avatar
rameshnaraya committed
748
749
750
        Identifier of the on-boarded VNF package. 
        This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or
        VnfPackageChangeNotification.
751
752
      in: path
      type: string
rameshnaraya's avatar
rameshnaraya committed
753
754
      required: true    
    - name: artifactPath
755
      description: >
rameshnaraya's avatar
rameshnaraya committed
756
757
758
759
        Path of the artifact within the VNF package. 
        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.
760
761
762
763
      in: path
      type: string
      required: true
    get:
rameshnaraya's avatar
rameshnaraya committed
764
765
766
767
768
769
      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.
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
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
      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:
            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.
        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:
            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.         
        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                                                               #
###############################################################################
  '/subscriptions':
    post:
rameshnaraya's avatar
rameshnaraya committed
858
859
      summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
      description: >   
860
        The POST method creates a new subscription.
rameshnaraya's avatar
rameshnaraya committed
861
862
863
864
865
866
867
868
        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).
869
      parameters:
rameshnaraya's avatar
rameshnaraya committed
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
      - 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:
          - "PkgmSubscriptionRequest"
          properties:
            PkgmSubscriptionRequest:
              $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
901
902
903
904
          description: >
            Representation of the created subscription resource.
            The HTTP response shall include a "Location" HTTP header that
            points to the created subscription resource.
rameshnaraya's avatar
rameshnaraya committed
905
            
906
907
      responses:
        201:
rameshnaraya's avatar
rameshnaraya committed
908
909
910
          description: >
            201 Created.
            
911
            Representation of the created subscription resource.
rameshnaraya's avatar
rameshnaraya committed
912
913
            The HTTP response shall include a "Location"
            HTTP header that points to the created subscription resource.
914
915
916
917
918
919
920
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
921
              type: string            
922
923
924
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
rameshnaraya's avatar
rameshnaraya committed
925
                request has provided an invalid authorization token.              
926
927
928
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
929
930
931
              properties:
                PkgmSubscription:
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription" 
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
        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"
952
    get:
953
      summary: >
rameshnaraya's avatar
rameshnaraya committed
954
955
956
957
958
959
960
        Query multiple subscriptions.
      description: >   
        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.
961
962
963
964
965
966
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
967
            Attribute-based filtering parameters according to clause 4.3.2.
968
969
970
            The NFVO shall support receiving filtering parameters as part of the URI query
            string. The OSS/BSS may supply filtering parameters.
            All attribute names that appear in the PkgmSubscription and in data types
rameshnaraya's avatar
rameshnaraya committed
971
            referenced from it shall be supported in attribute-based filtering parameters            
972
973
974
975
976
977
978
979
980
981
982
983
984
985
        - 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
986
987
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
988
989
990
991
          description: >
            200 OK.
            
            Active subscriptions of the functional block that invokes the method.
992
993
994
995
996
997
998
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
999
              type: string            
1000
1001
1002
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
rameshnaraya's avatar
rameshnaraya committed
1003
                request has provided an invalid authorization token.              
1004
1005
1006
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
1007
1008
1009
              properties:
                PkgmSubscription:
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"  
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
        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"
          
###############################################################################
# Individual subscription                                                     #
###############################################################################
  '/subscriptions/{subscriptionId}':
    #SOL003 location: 10.4.8
    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:
      summary: >
rameshnaraya's avatar
rameshnaraya committed
1047
        Read an individual subscription resource.  
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
      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
1068
1069
1070
          description: >
            200 OK.
            
1071
1072
1073
1074
1075
1076
1077
1078
            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:
rameshnaraya's avatar
rameshnaraya committed
1079
              type: string            
1080
1081
1082
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
rameshnaraya's avatar
rameshnaraya committed
1083
                request has provided an invalid authorization token.              
1084
          schema:
rameshnaraya's avatar
rameshnaraya committed
1085
1086
1087
            properties:
              NsdInfo:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"   
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
        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:
      summary: >
rameshnaraya's avatar
rameshnaraya committed
1108
1109
        Terminate a subscription.
      description: >      
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
        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:
          description: > 
rameshnaraya's avatar
rameshnaraya committed
1122
            No Content.
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149

            The subscription resource was deleted successfully.
          headers:
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              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
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

###############################################################################
# Notification endpoint                                                       #
# "/notification_endpoint" is the                                             #
# is the dummy URI used for testing, in real case endpoint URI has to         #
# provided by client.                                                         #
###############################################################################
  '/notification_endpoint':
    #SOL005 location: 8.2-1
    post:
      summary: >
        Notify about VNF package on boarding 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.
        
      # Don't know how to pass multiple body parameters in the POST request. 
      # Jenkin build is failing if enable more than one body parameters, So commented body parameters.
      parameters:
        - name: VnfPackageOnboardingNotification
          description: >
            Notification about performance information availability. 
          in: body
          required: true
          schema:
            properties:
              VnfPackageOnboardingNotification:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPackageOnboardingNotification"                
        #- name: VnfPackageChangeNotification
        #  description: >
        #    Notification about threshold crossing.
        #  in: body
        #  required: true
        #  schema:
        #    properties:
        #      VnfPackageChangeNotification:
        #        $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPackageChangeNotification"                
        - 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.
            
            The notification was delivered successfully.         
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"                        
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503" 
    get:
      summary: Test the notification endpoint.
      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: >
            The notification endpoint was tested successfully.
            The response body shall be empty. 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"                        
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
1263
1264
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"