VNFPackageManagement.yaml 62.2 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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
    get:
      summary: Retrieve API version information
      description: >
        The GET method reads API version information. This method shall follow the provisions specified in
        table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
        supported.
      parameters:
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK
            
            API version information was read successfully.
            The response body shall contain API version information, as defined in clause 4.4.1.7.
          schema:
            $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
        401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
        403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
        404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
        406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
        413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
        414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
        416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
        422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
        429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
        500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
        503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
        504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
  ###############################################################################
81
82
  # VNF Packages                                                                #
  ###############################################################################
83
84
85
  '/vnf_packages':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
    get:
rameshnaraya's avatar
rameshnaraya committed
86
      summary: Query VNF packages information.
87
      description: >
rameshnaraya's avatar
rameshnaraya committed
88
89
90
91
        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.
92
93
94
95
96
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
97
          description: >
98
99
100
            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.
101
            All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
102
            be supported by the NFVO in the filter expression.
103
104
105
106
        - name: "all_fields"
          in: "query"
          required: false
          type: "string"
107
          description: >
rameshnaraya's avatar
rameshnaraya committed
108
109
            Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
            shall support this parameter.
110
111
112
113
        - name: "fields"
          in: "query"
          required: false
          type: "string"
114
          description: >
rameshnaraya's avatar
rameshnaraya committed
115
116
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.         
117
118
119
120
        - name: "exclude_fields"
          in: "query"
          required: false
          type: "string"
121
          description: >
rameshnaraya's avatar
rameshnaraya committed
122
123
            Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
124
125
126
127
        - name: "exclude_default"
          in: "query"
          required: false
          type: "string"
128
          description: >
rameshnaraya's avatar
rameshnaraya committed
129
130
131
            Indicates to exclude the following complex attributes from the response. See clause 4.3.3
            for details.
            The NFVO shall support this parameter.
132
133
134
135
136
137
            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
138
            - checksum
139
140
141
142
143
144
145
        - 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
146
147
148
149
150
151
152
153
154
155
156
157
158
        - 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
159
          type: string
160
161
162
163
164
165
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
166
167
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
168
          description: >
169
            200 OK
170

171
172
173
174
175
176
177
            Information about zero or more VNF packages was successfully queried.
            The response body shall contain in an array the VNF package info 
            representations that match the attribute filter, i.e., zero or more 
            VNF package info representations as defined in clause 9.5.2.5.
            If the NFVO supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 4.7.2.3.
rameshnaraya's avatar
rameshnaraya committed
178
179
180
181
182
183
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
184
            WWW-Authenticate:
185
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
186
187
              description: >
                Challenge if the corresponding HTTP request has not provided
188
189
190
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
191
              minimum: 0
192
193
194
195
196
197
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
198
199
200
201
202
203
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
204
          schema:
rameshnaraya's avatar
rameshnaraya committed
205
            type: array
206
            items:
rameshnaraya's avatar
rameshnaraya committed
207
208
              properties:
                VnfPkgInfo:
209
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
        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:
227
          $ref: "responses/SOL005_resp.yaml#/responses/503"
228
229

    post:
rameshnaraya's avatar
rameshnaraya committed
230
      summary: Create a new individual VNF package resource.
231
      description: >
rameshnaraya's avatar
rameshnaraya committed
232
        The POST method creates a new individual VNF package resource.
233
      parameters:
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
        - 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
255
256
257
258
259
260
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
261
262
263
264
265
266
267
268
269
270
271
272
273
        - 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

274
275
      responses:
        201:
276
          description: >
277
            201 Created            
278

279
            An individual VNF package resource has been created successfully.
280
281
282
283
284
            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
285
            VNF package resource.
286
          schema:
287
288
289
            properties:
              VnfPkgInfo:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
290
          headers:
291
            Content-Type:
292
              type: "string"
293
294
295
296
297
              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
298
              minimum: 1
299
300
301
302
303
304
305
306
            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
307
308
309
310
311
312
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
313
314
315
  ###############################################################################
  # Individual VNF Package                                                      #
  ###############################################################################
316
317
  '/vnf_packages/{vnfPkgId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
318
319
320
321
322
    parameters:
      - name: "vnfPkgId"
        description: >
          Identifier of the VNF package. The identifier is allocated by the NFVO.  
        in: "path"
323
        type: "string"
324
        required: true
325
    get:
rameshnaraya's avatar
rameshnaraya committed
326
      summary: Read information about an individual VNF package.
327
      description: >
328
        The GET method reads the information of a VNF package.
329
330
331
332
333
334
335
336
337
338
339
340
341
342
      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
343
          type: string
344
345
346
347
348
349
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
350
351
      responses:
        200:
352
353
          description: >
            200 OK
354

355
356
357
            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.     
358
          schema:
359
            type: "object"
rameshnaraya's avatar
rameshnaraya committed
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
            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.
375
376
              maximum: 1
              minimum: 0
377
378
379
380
381
382
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
        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:
400
          $ref: "responses/SOL005_resp.yaml#/responses/503"
401
    delete:
rameshnaraya's avatar
rameshnaraya committed
402
      summary: Delete an individual VNF package.
403
      description: >
404
        The DELETE method deletes an individual VNF Package resource.
405
406
407
408
409
410
411
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
412
          type: string
413
414
415
416
417
418
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
419
420
421
      responses:
        204:
          description: >
422
            204 No Content
423

rameshnaraya's avatar
rameshnaraya committed
424
425
            The VNF package was deleted successfully.
            The response body shall be empty.
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
        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:
445
          $ref: "responses/SOL005_resp.yaml#/responses/503"
446
    patch:
rameshnaraya's avatar
rameshnaraya committed
447
      summary: Update information about an individual VNF package.
448
      description: >
449
        "The PATCH method updates the information of a VNF package."
450

451
452
453
454
        "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:
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
        - 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
481
482
483
484
485
486
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
487
      responses:
488
        200:
rameshnaraya's avatar
rameshnaraya committed
489
          description: >
490
            200 OK
491

rameshnaraya's avatar
rameshnaraya committed
492
            The operation was completed successfully.
493
            The response body shall contain attribute
rameshnaraya's avatar
rameshnaraya committed
494
495
            modifications for an "Individual VNF
            package" resource
496
497
498
499
500
501
502
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
503
              type: "string"
504
505
              description: >
                Challenge if the corresponding HTTP request has not provided
506
507
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
508
509
              maximum: 1
              minimum: 0
510
511
512
513
514
515
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
516
          schema:
rameshnaraya's avatar
rameshnaraya committed
517
            properties:
518
              VnfPkgInfoModifications:
rameshnaraya's avatar
rameshnaraya committed
519
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfoModifications"
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
        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:
539
540
541
542
543
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # VNFD in an individual VNF package                                           #
  ###############################################################################
544
545
546
547
548
  '/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
549
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
550
551
        in: path
        type: string
552
        required: true
553
    get:
rameshnaraya's avatar
rameshnaraya committed
554
      summary: Read VNFD of an on-boarded VNF package.
555
      description: >
rameshnaraya's avatar
rameshnaraya committed
556
        The GET method reads the content of the VNFD within a VNF package.
557

rameshnaraya's avatar
rameshnaraya committed
558
        The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the
559
560
561
562
563
564
565
566
567
568
569
570
571
        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
572
        request and response data structures, and response codes.
573
      parameters:
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
        - 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
590
591
592
593
594
595
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
596
597
      responses:
        200:
598
          description: >
599
            200 OK
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615

            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:
616
              type: "string"
617
618
              description: >
                Challenge if the corresponding HTTP request has not provided
619
620
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
621
622
              maximum: 1
              minimum: 0
623
624
625
626
627
628
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
629
630
631
632
633
634
635
636
637
638
639
640
641
        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"
642
643

          $ref: "responses/SOL005_resp.yaml#/responses/406"
644
645
646
        409:
          description: >
            "409 Conflict"
647
648

          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/406-state-conflict"
649
650
651
652
653
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
654
655
656
657
658
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # VNF Package Content                                                         #
  ###############################################################################
659
  '/vnf_packages/{vnfPkgId}/package_content':
660
661
662
663
664
665
666
    #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
667
        type: "string"
668
    get:
rameshnaraya's avatar
rameshnaraya committed
669
      summary: Fetch an on-boarded VNF package.
670
      description: >
rameshnaraya's avatar
rameshnaraya committed
671
672
673
        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.
674
      parameters:
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
        - 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.
701
702
703
704
705
706
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
707
708
      responses:
        200:
709
          description: >
710
            200 OK
711
712
713
714
715
716
717
718
719
720
721
722
723
724

            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:
725
              type: "string"
726
727
              description: >
                Challenge if the corresponding HTTP request has not provided
728
729
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
730
731
              maximum: 1
              minimum: 0
732
733
734
735
736
737
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
738
739
740
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        409:
741
          description: >
742
743
          $ref: "responses/VNFPackageManagement_resp.yaml#/responses/409-state-conflict-ONBOARDING"
        416:
744
          $ref: "responses/SOL005_resp.yaml#/responses/416"
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
        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:
760
761
          $ref: "responses/SOL005_resp.yaml#/responses/503"

762
    put:
rameshnaraya's avatar
rameshnaraya committed
763
      summary: Upload a VNF package by providing the content of the VNF package.
764
      description: >
rameshnaraya's avatar
rameshnaraya committed
765
766
767
768
        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.
769
      consumes:
770
        - multipart/form-data
771
      parameters:
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
        - 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].
796
797
798
799
800
801
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
802
803
      responses:
        202:
804
          description: >
805
            202 Accepted
806

rameshnaraya's avatar
rameshnaraya committed
807
808
809
810
            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.
811
        409:
812
          description: >
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
          $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:
829
          $ref: "responses/SOL005_resp.yaml#/responses/503"
830

831
832
833
  ###############################################################################
  # Upload VNF package from URI task                                            #
  ###############################################################################
834
835
836
  '/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
837
      summary: Upload a VNF package by providing the address information of the VNF package.
838
      description: >
839
840
841
842
        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.        
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
      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.
886
887
888
889
890
891
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
892

893
894
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
895
          description: >
896
            202 Accepted
897

rameshnaraya's avatar
rameshnaraya committed
898
            The information about the VNF package was received
899
900
            successfully, but the on-boarding has not been
            completed. It is expected to take some time for processing.
rameshnaraya's avatar
rameshnaraya committed
901
            The response body shall be empty.
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
        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:
919
920
921
922
923
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # Individual VNF package artifact                                             #
  ###############################################################################
924
  '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
925
926
927
928
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.7
    parameters:
      - name: vnfPkgId
        description: >
929
          Identifier of the VNF package.
930
931
932
933
934
935
936
937
          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: >
938
939
940
941
942
943
944
          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.
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
        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
978
979
980
981
982
983
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
      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
1009
1010
1011
1012
1013
1014
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
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

        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
1046
1047
1048
1049
1050
1051
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
        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                                                               #
  ###############################################################################
1076
  '/subscriptions':
1077
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.8
1078
    post:
rameshnaraya's avatar
rameshnaraya committed
1079
      summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
1080
      description: >
1081
        The POST method creates a new subscription.
rameshnaraya's avatar
rameshnaraya committed
1082
1083
1084
1085
1086
1087
1088
1089
        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).
1090
      parameters:
1091
        - name: Accept
1092
          description: >
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
            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
1112
1113
1114
1115
1116
1117
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
        - 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.

1133
1134
      responses:
        201:
rameshnaraya's avatar
rameshnaraya committed
1135
          description: >
1136
            201 Created
1137

1138
            Representation of the created subscription resource.
rameshnaraya's avatar
rameshnaraya committed
1139
1140
            The HTTP response shall include a "Location"
            HTTP header that points to the created subscription resource.
1141
1142
1143
1144
1145
1146
1147
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
1148
              type: "string"
1149
1150
              description: >
                Challenge if the corresponding HTTP request has not provided
1151
1152
1153
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1154
              minimum: 0
1155
1156
1157
1158
1159
1160
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
1161
1162
1163
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
1164
1165
              properties:
                PkgmSubscription:
1166
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
        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"
1187
    get:
1188
      summary: Query multiple subscriptions.
1189
      description: >
rameshnaraya's avatar
rameshnaraya committed
1190
1191
1192
1193
1194
        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.
1195
1196
1197
1198
1199
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
1200
          description: >
1201
1202
1203
            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.
1204
            All attribute names that appear in the PkgmSubscription and in data types
1205
            referenced from it shall be supported by the NFVO in the filtering expression.
1206
1207
1208
1209
1210
1211
1212
        - 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
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
        - 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
1227
1228
1229
1230
1231
1232
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1233
1234
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
1235
          description: >
1236
            200 OK
1237

rameshnaraya's avatar
rameshnaraya committed
1238
            Active subscriptions of the functional block that invokes the method.
1239
1240
1241
1242
1243
1244
1245
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
1246
              type: "string"
1247
1248
              description: >
                Challenge if the corresponding HTTP request has not provided
1249
1250
1251
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1252
              minimum: 0
1253
1254
1255
1256
1257
1258
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
1259
1260
1261
1262
1263
1264
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
1265
1266
1267
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
1268
1269
              properties:
                PkgmSubscription:
1270
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
        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"
1289
1290
1291
1292

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
1293
  '/subscriptions/{subscriptionId}':
1294
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.9
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
    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:
1307
      summary: Read an individual subscription resource.
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
      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
1326
1327
1328
1329
1330
1331
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1332
1333
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
1334
          description: >
1335
            200 OK
1336

1337
1338
1339
1340
1341
1342
1343
1344
            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:
1345
              type: "string"
1346
1347
              description: >
                Challenge if the corresponding HTTP request has not provided
1348
1349
1350
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1351
              minimum: 0
1352
1353
1354
1355
1356
1357
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
1358
          schema:
rameshnaraya's avatar
rameshnaraya committed
1359
            properties:
1360
              PkgmSubscription:
1361
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
        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:
1381
      summary: Terminate a subscription.