MEC010-2_AppGrant.yaml 30.8 KB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
1
2
3
4
5
6
7
info:
  title: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management"
  version: 2.1.1
  description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI."
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
Elian Kraja's avatar
Elian Kraja committed
8
9
  contact:
    url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api
Elian Kraja's avatar
Elian Kraja committed
10
11
12
13
externalDocs:
  description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1"
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf'
servers:
14
  - url: 'https://localhost/granting/v1'
Elian Kraja's avatar
Elian Kraja committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
openapi: 3.0.0
tags:
  - name: granting
    description: Grant operations
paths:
  /grants:     
    post:
      tags:
      - 'granting'
      summary: 'requests a grant for a particular application lifecycle operation'
      description: 'requests a grant for a particular application lifecycle operation'
      operationId: grantPOST
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GrantRequest'
      responses:
        '201':
          description: grant was created successfully (synchronous mode)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Grant'
        '202':
          description: the request was accepted for processing      
        '400':
          $ref: '#/components/responses/400'      
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'  
        '429':
          $ref: '#/components/responses/429'
  /grants/{grantId}: 
    parameters:
    - in: path
      name: grantId
Elian Kraja's avatar
Elian Kraja committed
58
      description: 'Identifier of the individual grant.'
Elian Kraja's avatar
Elian Kraja committed
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
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
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
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
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
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
      schema:
        type: string
      required: true     
    get:
      tags:
      - 'granting'
      summary: 'read the grant'
      description: 'read the grant'
      operationId: GrantGET
      responses:
        '200':
          description: 'IA representation of the "individual grant" resource '
          content:
            application/json:
              schema:
                  $ref: '#/components/schemas/Grant'
        '202':
          description: 'returned when the process of creating the grant is ongoing, no grant is available yet'          
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'  

components:
  schemas:
    AppExtCpConfig:
      properties:
        cpInstanceId:
          description: "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created. "
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        cpProtocolData:
          description: Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note.
          items:
            $ref: '#/components/schemas/CpProtocolData'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: CpProtocolData
        linkPortId:
          description: Identifier of a pre-configured link port to which the external CP will be associated. See note.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      type: object
      x-etsi-notes: "NOTE:\tThe following conditions apply to the attributes \"linkPortId\" and \" cpProtocolData\": \nThe \"linkPortId\" and \"cpProtocolData\" attributes shall both be absent for the deletion of an existing external CP instance addressed by cpInstanceId. \nAt least one of these attributes shall be present for a to-be-created external CP instance or an existing external CP instance.\nIf the \"linkPortId\" attribute is absent, the MEPM shall create a link port.\nIf the \"cpProtocolData\" attribute is absent, the \"linkPortId\" attribute shall be provided referencing a pre-created link port, and the MEPM can use means outside the scope of the present document to obtain the pre-configured address information for the connection point from the resource representing the link port.\nIf both \"cpProtocolData\" and \"linkportId\" are provided, the API consumer shall ensure that the cpProtocolData can be used with the pre-created link port referenced by \"linkPortId\"."
      x-etsi-ref: 6.2.4.13
    AppExtCpData:
      properties:
        cpConfig:
          description: List of instance data that need to be configured on the CP instances created from the respective CPD.
          items:
            $ref: '#/components/schemas/AppExtCpConfig'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: AppExtCpConfig
        cpdId:
          description: The identifier of the CPD in the AppD.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - cpdId
      - cpConfig
      type: object
      x-etsi-ref: 6.2.4.12
    AppInstanceId:
      description: >-
        Identifier of application instance.
      type: string
    AppDId:
      description: 'Identifier of this MEC application descriptor. This attribute shall be globally unique.'
      type: string
    AppLcmOpOccId:
      description: >-
        Identifier of application lifecycle management operation occurrence.
      type: string
    KeyValuePairs:
      description: >-
        'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'
      type: object
      additionalProperties: true
    ResourceDefinition.Type:
      description: >-
        Type of the resource definition referenced.
      type: string
      format: enum
      enum:
        - COMPUTE
        - VL
        - STORAGE
        - LINKPORT
    CpProtocolData:
      properties:
        ipOverEthernet:
          # description': Network address data for IP over Ethernet to assign to the extCP instance. Shall be present if layerProtocol is equal to "IP_OVER_ETHERNET", and shall be absent otherwise.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': IpOverEthernetAddressData
          $ref: '#/components/schemas/IpOverEthernetAddressData'
        layerProtocol:
          #description: "Identifier of layer(s) and protocol(s). \n\nPermitted values: IP_OVER_ETHERNET.\n\nSee note."
          #type: string
          #x-etsi-mec-cardinality: '1'
          $ref: '#/components/schemas/IpOverEthernetAddressData'
      required:
      - layerProtocol
      type: object
      x-etsi-notes: "NOTE:\tThis attribute allows to signal the addition of further types of layer and protocol in future versions of the present document in a backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported."
      x-etsi-ref: 6.2.4.14
    ExtLinkPortData:
      properties:
        id:
          description: Identifier of this link port as provided by the entity that has created the link port.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        resourceHandle:
          # description': Reference to the virtualised resource realizing this link port.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': ResourceHandle
          $ref: '#/components/schemas/ResourceHandle'
      required:
      - id
      - resourceHandle
      type: object
      x-etsi-ref: 6.2.4.9
    ExtVirtualLinkData:
      properties:
        extCps:
          description: External CPs of the application instance to be connected to this external VL.
          items:
            $ref: '#/components/schemas/AppExtCpData'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: AppExtCpData
        extLinkPorts:
          description: Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL.
          items:
            $ref: '#/components/schemas/ExtLinkPortData'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: ExtLinkPortData
        id:
          description: The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        resourceId:
          description: The identifier of the resource in the scope of the VIM.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        vimConnectionId:
          description: 'Identifier of the VIM connection to manage this resource. '
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      required:
      - id
      - resourceId
      - extCps
      type: object
      x-etsi-ref: 6.2.4.8
    Grant:
      description: >-
        'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 '
      type: object
      required:
        - id
        - appInstanceId
        - appLcmOpOccId
        - _links
      properties:
        id:
          $ref: '#/components/schemas/Grant.Id'
        appInstanceId:
          $ref: '#/components/schemas/AppInstanceId'
        appLcmOpOccId:
          $ref: '#/components/schemas/AppLcmOpOccId'
        vimConnections:
          type: array
          items:
            $ref: '#/components/schemas/VimConnectionInfo'
        zones:
          type: array
          items:
            $ref: '#/components/schemas/ZoneInfo'
        zoneGroups:
          type: array
          items:
            $ref: '#/components/schemas/ZoneGroupInfo'
        addResources:
          type: array
          items:
            $ref: '#/components/schemas/GrantInfo'
        tempResources:
          type: array
          items:
            $ref: '#/components/schemas/GrantInfo'
        removeResources:
          type: array
          items:
            $ref: '#/components/schemas/GrantInfo'
        updateResources:
          type: array
          items:
            $ref: '#/components/schemas/GrantInfo'
        vimAssets:
          $ref: '#/components/schemas/VimAssets'
        extVirtualLinks:
          type: array
          items:
            $ref: '#/components/schemas/ExtVirtualLinkData'
        additionalParams:
          $ref: '#/components/schemas/KeyValuePairs'
        _links:
          $ref: '#/components/schemas/Grant.links'
    Grant.Id:
      type: string
    VimAssets:
      description: >-
        Information about assets for the application that are managed by the MEO in the VIM, such as software images.
      type: object
      properties:
        softwareImages:
          type: array
          items:
            $ref: '#/components/schemas/SoftwareImages'
    SoftwareImages:
      $ref: '#/components/schemas/VimSoftwareImage'          
    Grant.links:
      description: >- 
        Links to resources related to this resource.
      type: object
      required:
        - appLcmOpOcc
        - appInstance
      properties:
        appLcmOpOcc:
          $ref: '#/components/schemas/LinkType'
        appInstance:
          $ref: '#/components/schemas/LinkType'          
    GrantInfo:
      properties:
        resourceDefinitionId:
          description: Identifier of the related "ResourceDefinition" structure from the related "GrantRequest" structure.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        resourceGroupId:
          description: 'Identifier of the "infrastructure resource group", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by "vimConnectionId" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by "vimConnectionId" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated.'
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        vimConnectionId:
          description: Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        zoneId:
          description: Reference to the identifier of the "ZoneInfo" structure in the "Grant" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      required:
      - resourceDefinitionId
      type: object
      x-etsi-ref: 6.2.4.5
    GrantRequest:
      description: >-
        'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003'
      type: object
      required:
        - appInstanceId
        - appLcmOpOccId
        - appDId
        - operation
        - _links
      properties:
        appInstanceId:
          $ref: '#/components/schemas/AppInstanceId'
        appLcmOpOccId:
          $ref: '#/components/schemas/AppLcmOpOccId'
        appDId:
          $ref: '#/components/schemas/AppDId'
        operation:
          $ref: '#/components/schemas/GrantRequest.Operation'
        addResources:
         type: array
         items:
          $ref: '#/components/schemas/ResourceDefinition'
        tempResources:
         type: array
         items:
          $ref: '#/components/schemas/ResourceDefinition'
        removeResources:
         type: array
         items:
          $ref: '#/components/schemas/ResourceDefinition'
        updateResources:
         type: array
         items:
          $ref: '#/components/schemas/ResourceDefinition'
        additionalParams:
          $ref: '#/components/schemas/KeyValuePairs'
        _links:
          $ref: '#/components/schemas/GrantRequest.links'
    GrantRequest.Operation:
      description: >-
        'The lifecycle management operation for which granting is requested'
      type: string
      enum:
        - INSTANTIATE
        - OPERATE
        - TERMINATE    
    GrantRequest.links:
      description: >- 
        Links to resources related to this resource.
      type: object
      required:
        - appLcmOpOcc
        - appInstance
      properties:
        appLcmOpOcc:
          $ref: '#/components/schemas/LinkType'
        appInstance:
          $ref: '#/components/schemas/LinkType'
    IpOverEthernetAddressData:
      description: >-
        'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003'
      type: object
      properties:
        macAddress:
          $ref: '#/components/schemas/MacAddress'
        ipAddresses:
          $ref: '#/components/schemas/IpAddresses'
    MacAddress:
      description: >-
        'MAC address. If this attribute is not present, it shall be chosen by the VIM'
      type: string
    IpAddresses:
      description: >-
        List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.
      type: array
      items:
        $ref: '#/components/schemas/IpAddress'      
    IpAddress:
      description: >-
        'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.'
      type: object
      required:
        - type
      properties:
        type:
          $ref: '#/components/schemas/IpAddress.Type'
        fixedAddresses:
          $ref: '#/components/schemas/FixedAddresses'
        numDynamicAddresses:
          $ref: '#/components/schemas/NumDynamicAddresses'
        addressRange:
          $ref: '#/components/schemas/AddressRange'
        subnetId:
          $ref: '#/components/schemas/SubnetId'   
    IpAddress.Type:
      description: The type of the IP addresses.
      type: string
      enum:
        - IPV4
        - IPV6
    FixedAddresses:
      description: 'Fixed addresses to assign (from the subnet defined by subnetId if provided).'
      type: array
      items:
        $ref: '#/components/schemas/FixedAddress'
    NumDynamicAddresses:
      description: 'Number of dynamic addresses to assign (from the subnet defined by subnetId if provided)'
      type: integer
    AddressRange:
      description: >-
        An IP address range to be used, e.g. in case of egress connections.
      type: object
      required:
        - minAddress
        - maxAddress
      properties:
        minAddress:
          $ref: '#/components/schemas/MinAddress'
        maxAddress:
          $ref: '#/components/schemas/MaxAddress'
    MinAddress:
      description: Lowest IP address belonging to the range.
      type: string
    MaxAddress:
      description: Highest IP address belonging to the range.
      type: string          
    FixedAddress:
      description: >-
        Fixed addresses to assign (from the subnet defined by subnetId if provided)
      type: string             
    SubnetId:
      description: Subnet defined by the identifier of the subnet resource in the VIM.
      type: string
    LinkType:
      properties:
        href:
          description: URI referring to a resource
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
      required:
      - href
      type: object
      x-etsi-ref: 6.5.2
    ProblemDetails:
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          description: A URI reference that identifies the specific occurrence of the problem
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object
    ResourceDefinition:
      description: >-
        'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 '
      type: object
      required:
        - id
        - type
        - resourceTemplateId
        - resource
      properties:
        id:
          $ref: '#/components/schemas/ResourceDefinitionId'
        type:
          $ref: '#/components/schemas/ResourceDefinition.Type'
        vduId:
          $ref: '#/components/schemas/VduId'
        resourceTemplateId:
          $ref: '#/components/schemas/ResourceTemplateId'
        resource:
          $ref: '#/components/schemas/Resource'
    ResourceDefinitionId:
      description: >-
        Identifier of the related ResourceDefinition structure from the related GrantRequest structure.
      type: string
    VduId:
      description: >-
        Reference to the related VDU in the AppD applicable to this resource.
      type: string
    ResourceTemplateId:
      description: >-
        Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD.
      type: string 
    Resource:
      description: >-
        Resource information for an existing resource
      type: object
      required:
        - vimConnectionInfo
        - resourceId
      properties:
        vimConnectionInfo:
          $ref: '#/components/schemas/VimConnectionInfo'
        resourceId:
          $ref: '#/components/schemas/ResourceId'
    ResourceId:
      description: >-
        Identifier of the resource in the scope of the VIM.
      type: string          
    ResourceHandle:
      properties:
        resourceId:
          description: Identifier of the resource in the scope of the VIM.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        vimConnectionId:
          description: 'Identifier of the VIM connection to manage the resource.The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "AppInstance" structure.'
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        vimLevelResourceType:
          description: Type of the resource in the scope of the VIM. See note.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      required:
      - resourceId
      type: object
      x-etsi-notes: "NOTE:\tThe value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM and can be used as information that complements the ResourceHandle. This value set is different from the value set of the \"type\" attribute in the ResourceDefinition."
      x-etsi-ref: 6.2.4.10
    VimConnectionInfo:
      properties:
        accessInfo:
          #description: 'Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note). The applicable keys are dependent on the content of vimType.If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included.If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band.'
          $ref: '#/components/schemas/KeyValuePairs'
          #x-etsi-mec-cardinality: 0..1
          #x-etsi-mec-origin-type: KeyValuePairs
        extra:
          #description: VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType.
          $ref: '#/components/schemas/KeyValuePairs'
          #x-etsi-mec-cardinality: 0..1
          #x-etsi-mec-origin-type: KeyValuePairs
        id:
          description: The identifier of the VIM Connection. This identifier is managed by the MEO.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        interfaceInfo:
          #description: 'Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType.Alternatively, such information may have been configured into the VNFM and bound to the vimId.'
          $ref: '#/components/schemas/KeyValuePairs'
          #x-etsi-mec-cardinality: 0..1
          #x-etsi-mec-origin-type: KeyValuePairs
        vimId:
          description: 'The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.'
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        vimType:
          description: 'Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. '
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - id
      - vimType
      type: object
      x-etsi-ref: 6.2.2.18
    VimSoftwareImage:
      properties:
        appDSoftwareImageId:
          description: Identifier which references the software image descriptor in the AppD.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        vimConnectionId:
          description: 'Identifier of the VIM connection to access the software image referenced in this structure. '
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        vimSoftwareImageId:
          description: Identifier of the software image in the resource management layer (i.e. VIM).
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - appDSoftwareImageId
      - vimSoftwareImageId
      type: object
      x-etsi-ref: 6.2.4.11
    ZoneGroupInfo:
      properties:
        zoneId:
          description: References of identifiers of "ZoneInfo" structures, each of which provides information about a resource zone that belongs to this group.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
      required:
      - zoneId
      type: object
      x-etsi-ref: 6.2.4.7
    ZoneInfo:
      properties:
        id:
          description: The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the "Grant" structure.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        vimConnectionId:
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        zoneId:
          description: The identifier of the resource zone, as managed by the resource management layer (typically, the VIM).
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - id
      - zoneId
      type: object
      x-etsi-ref: 6.2.4.6f
      
  responses:
    204:
      description: No Content
    206:
      description: Partial content    
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    406:
      description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    409:
      description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    412:
      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    414:
      description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is  longer than the server is willing or able to process.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
    415:
      description: 'Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
                
    416:
      description: 'Range Not Satisfiable .'               
    422:
      description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
      content:
        application/json:
          schema:
                $ref: '#/components/schemas/ProblemDetails'
          example:
            application/problem+json:
              problemDetails:
                type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
                title: Too many targets
                status: '422'
                detail: The target area for the request is considered too large
                instance: /meAppClient.example.com/77777/msgs/abc
    429:
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/json:
          schema:
Elian Kraja's avatar
Elian Kraja committed
762
                $ref: '#/components/schemas/ProblemDetails'