MEC030_V2XInformationService.yaml 45 KB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
1
2
3
4
info:
  title: "ETSI GS MEC 030 V2X Information Service API"
  version: 2.1.1
  description: "ETSI GS MEC 030 V2X Information Service API described using OpenAPI."
Elian Kraja's avatar
Elian Kraja committed
5
  contact:
Elian Kraja's avatar
Elian Kraja committed
6
7
    name: ETSI Forge
    email: cti_support@etsi.org
Elian Kraja's avatar
Elian Kraja committed
8
    url: https://forge.etsi.org/rep/mec/gs030-vis-api
Elian Kraja's avatar
Elian Kraja committed
9
10
11
12
13
14
15
16
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'  
externalDocs:
  description: "ETSI GS MEC 030 V2X Information Service API, v2.1.1"
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.01.01_60/gs_mec030v020101p.pdf' 
openapi: 3.0.0
servers:
Elian Kraja's avatar
Elian Kraja committed
17
  - url: 'https://localhost/vis/v1'
Elian Kraja's avatar
Elian Kraja committed
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
58
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
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
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
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
tags:
  - name: queries
    description: Queries
  - name: subscription
    description: Subscription
    
paths:
 /queries/uu_unicast_provisioning_info:   
  get:
   tags:
    - 'queries'
   summary: 'Used to query provisioning information for V2X communication over Uu unicast.'
   description: 'Used to query provisioning information for V2X communication over Uu unicast.'
   operationId: prov_info_uu_unicastGET  
   parameters:
        - in: query
          name: location_info
          schema:
           type: string
          required: true
          description: 'Comma separated list of locations to identify a cell of a base station or a particular geographical area'

   responses:
        '200':
          description: 'A response body containing the Uu unicast provisioning information. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UuUnicastProvisioningInfo'        
        '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'       
 /queries/uu_mbms_provisioning_info: 
  get:
   tags:
    - 'queries'
   summary: 'retrieve information required for V2X communication over Uu MBMS.'
   description: 'retrieve information required for V2X communication over Uu MBMS.'
   operationId: prov_info_uu_mbmsGET  
   parameters:
        - in: query
          name: location_info
          schema:
           type: string
          required: true
          description: 'omma separated list of locations to identify a cell of a base station or a particular geographical area'

   responses:
        '200':
          description: 'A response body containing the Uu unicast provisioning information. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UuMbmsProvisioningInfo'        
        '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'         
  #/queries/pc5_provisioning_info:
    #get: 
  #/provide_predicted_qos:
   #post:  
  #/publish_v2x_message:
   #post:    
  #/subscriptions:
   #get: 
   #post: 
  #/subscriptions/{subscriptionId}:
   #get: 
   #put:
   #delete: 
  # /notifitication_end_point_provided_by_client
   #post: 
   
components:
  schemas:
    CellId:
      properties:
        cellId:
          description: E-UTRAN Cell Identity as a bit string (size (28)).
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - cellId
      type: object
      x-etsi-ref: 6.6.2
    Earfcn:
      properties:
        earfcn:
          description: E-UTRA Absolute Radio Frequency Channel Number, range (0... 65535)
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
      required:
      - earfcn
      type: object
      x-etsi-ref: 6.6.3
    Ecgi:
      properties:
        cellId:
          # description': The E-UTRAN Cell Identity.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': CellId
          $ref: '#/components/schemas/CellId'
        plmn:
          # description': Public Land Mobile Network Identity.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Plmn
          $ref: '#/components/schemas/Plmn'
      required:
      - plmn
      - cellId
      type: object
      x-etsi-ref: 6.5.5
    FddInfo:
      properties:
        dlEarfcn:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Earfcn
          $ref: '#/components/schemas/Earfcn'
        dlTransmissionBandwidth:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TransmissionBandwidth
          $ref: '#/components/schemas/TransmissionBandwidth'
        ulEarfcn:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Earfcn
          $ref: '#/components/schemas/Earfcn'
        ulTransmissionBandwidth:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TransmissionBandwidth
          $ref: '#/components/schemas/TransmissionBandwidth'
      required:
      - ulEarfcn
      - dlEarfcn
      - ulTransmissionBandwidth
      - dlTransmissionBandwidth
      type: object
      x-etsi-ref: 6.5.6
    LocalityTypes:
      type: string
      
    LocationInfo.geoArea:
          description: Information of a geographical area.
          properties:
            latitude:
              description: 'Latitude (DATUM = WGS84) -90 to 90 in decimal degree format DDD.ddd'
              format: Float
              type: number
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Float
            longitude:
              description: 'Longitude (DATUM = WGS84)-180 to 180 in decimal degree format DDD.ddd'
              format: Float
              type: number
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Float
          required:
          - latitude
          - longitude
          type: object
          x-etsi-mec-cardinality: 0..1
          
    LocationInfo:
      properties:
        ecgi:
          # description': E-UTRAN CelI Global Identifier of the serving cell.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': Ecgi
          $ref: '#/components/schemas/Ecgi'
        geoArea:
          $ref: '#/components/schemas/LocationInfo.geoArea'
      type: object
      x-etsi-notes: "NOTE:\tEither ecgi or geoArea shall be present, but not both."
      x-etsi-ref: 6.5.3
    Pc5NeighbourCellInfo:
      properties:
        ecgi:
          # description': E-UTRAN CelI Global Identifier.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Ecgi
          $ref: '#/components/schemas/Ecgi'
        plmn:
          # description': Public Land Mobile Network Identity.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Plmn
          $ref: '#/components/schemas/Plmn'
        siV2xConfig:
          description: V2X sidelink communication configuration, as defined in ETSI TS 136 331 [i.11].
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': SystemInformationBlockType21 (as defined in ETSI TS 136 331 [i.11])
          type: string
      required:
      - plmn
      - ecgi
      - siV2xConfig
      type: object
      x-etsi-ref: 6.5.12
    
    
    Pc5ProvisioningInfo.proInfoPc5:
            description: The provisioning information per location as defined below.
            items:
              type: object
            minItems: 1
            properties:
              dstLayer2Id:
                description: "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS\_136\_321 [i.12].\nPLMN operators coordinate to make sure Destination Layer-2 ID(s) for different V2X services are configured in a consistent manner."
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: String
              locationInfo:
                # description': Location information to identify a cell of a base station or a particular geographical area.
                # x-etsi-mec-cardinality': '1'
                # x-etsi-mec-origin-type': LocationInfo
                $ref: '#/components/schemas/LocationInfo'
              neighbourCellInfo:
                description: The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.
                items:
                  $ref: '#/components/schemas/Pc5NeighbourCellInfo'
                minItems: 0
                type: array
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: Pc5NeighbourCellInfo
            required:
            - locationInfo
            - dstLayer2Id
            
    Pc5ProvisioningInfo:
      properties:
          proInfoPc5:
            $ref: '#/components/schemas/Pc5ProvisioningInfo.proInfoPc5'
          timeStamp:
            # description': Time stamp.
            # x-etsi-mec-cardinality': 0..1
            # x-etsi-mec-origin-type': TimeStamp
            $ref: '#/components/schemas/TimeStamp'
      required:
      - proInfoPc5
      type: object
      x-etsi-ref: 6.2.4
      
    Plmn:
      properties:
        mcc:
          description: The Mobile Country Code part of PLMN Identity.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        mnc:
          description: The Mobile Network Code part of PLMN Identity.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - mcc
      - mnc
      type: object
      x-etsi-ref: 6.5.4
    ProvChgPc5Notification:
      properties:
        dstLayer2Id:
          description: For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        locationInfo:
          # description': Location information to identify a cell of a base station or a particular geographical area.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LocationInfo
          $ref: '#/components/schemas/LocationInfo'
        neighbourCellInfo:
          description: The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.
          items:
            $ref: '#/components/schemas/Pc5NeighbourCellInfo'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Pc5NeighbourCellInfo
        notificationType:
          description: Shall be set to "ProvChgPc5Notification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
      required:
      - notificationType
      - locationInfo
      type: object
      x-etsi-ref: 6.4.4
      
    ProvChgPc5Subscription.links:
          description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              # description': Self-referring URI. The URI shall be unique within the VIS API as it acts as an ID for the subscription.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LinkType
              $ref: '#/components/schemas/LinkType'
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1 
    
    ProvChgPc5Subscription.filterCriteria:
          description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
          properties:
            dstLayer2Id:
              description: For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            locationInfo:
              # description': Location information to identify a cell of a base station or a particular geographical area.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LocationInfo
              $ref: '#/components/schemas/LocationInfo'
            neighbourCellInfo:
              description: The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.
              items:
                $ref: '#/components/schemas/Pc5NeighbourCellInfo'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Pc5NeighbourCellInfo
          required:
          - locationInfo
          - dstLayer2Id
          type: object
          x-etsi-mec-cardinality: '1' 
    ProvChgPc5Subscription:
      properties:
        _links:
          $ref: '#/components/schemas/ProvChgPc5Subscription.links'
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed VIS information. This shall be included both in the request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        filterCriteria:
          $ref: '#/components/schemas/ProvChgPc5Subscription.filterCriteria'
        subscriptionType:
          description: Shall be set to "ProvChgPc5Subscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
      - filterCriteria
      type: object
      x-etsi-ref: 6.3.4
    ProvChgUuMbmsNotification:
      properties:
        locationInfo:
          # description': Location information to identify a cell of a base station or a particular geographical area.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LocationInfo
          $ref: '#/components/schemas/LocationInfo'
        neighbourCellInfo:
          description: The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.
          items:
            $ref: '#/components/schemas/UuMbmsNeighbourCellInfo'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: UuMbmsNeighbourCellInfo
        notificationType:
          description: Shall be set to "ProvChgUuMbmsNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        v2xServerUsd:
          # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': V2xServerUsd
          $ref: '#/components/schemas/V2xServerUsd'
      required:
      - notificationType
      - locationInfo
      type: object
      x-etsi-ref: 6.4.3
    ProvChgUuMbmsSubscription.links:
          description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              # description': Self-referring URI. The URI shall be unique within the VIS API as it acts as an ID for the subscription.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LinkType
              $ref: '#/components/schemas/LinkType'
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
    
    ProvChgUuMbmsSubscription.filterCriteria:
          description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
          properties:
            locationInfo:
              # description': Location information to identify a cell of a base station or a particular geographical area.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LocationInfo
              $ref: '#/components/schemas/LocationInfo'
            neighbourCellInfo:
              description: The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.
              items:
                $ref: '#/components/schemas/UuMbmsNeighbourCellInfo'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: UuMbmsNeighbourCellInfo
            v2xServerUsd:
              # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': V2xServerUsd
              $ref: '#/components/schemas/V2xServerUsd'
          required:
          - locationInfo
          - v2xServerUsd
          type: object
          x-etsi-mec-cardinality: '1'
          
    ProvChgUuMbmsSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/ProvChgUuMbmsSubscription.links'
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed VIS information. This shall be included both in the request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        filterCriteria:
          $ref: '#/components/schemas/ProvChgUuMbmsSubscription.filterCriteria'
        subscriptionType:
          description: Shall be set to "ProvChgUuMbmsSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
      - filterCriteria
      type: object
      x-etsi-ref: 6.3.3
    ProvChgUuUniNotification:
      properties:
        locationInfo:
          # description': Location information to identify a cell of a base station or a particular geographical area.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': LocationInfo
          $ref: '#/components/schemas/LocationInfo'
        neighbourCellInfo:
          description: The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.
          items:
            $ref: '#/components/schemas/UuUniNeighbourCellInfo'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: UuUniNeighbourCellInfo
        notificationType:
          description: Shall be set to "ProvChgUuUniNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        v2xApplicationServer:
          # description': V2X Application Server address (consisting of IP address and UDP port) for unicast.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': V2xApplicationServer
          $ref: '#/components/schemas/V2xApplicationServer'
      required:
      - notificationType
      - locationInfo
      type: object
      x-etsi-ref: 6.4.2
    ProvChgUuUniSubscription.links:
          description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              # description': Self-referring URI. The URI shall be unique within the VIS API as it acts as an ID for the subscription.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LinkType
              $ref: '#/components/schemas/LinkType'
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
    
    ProvChgUuUniSubscription.filterCriteria:
          description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
          properties:
            locationInfo:
              # description': Location information to identify a cell of a base station or a particular geographical area.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LocationInfo
              $ref: '#/components/schemas/LocationInfo'
            neighbourCellInfo:
              description: The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.
              items:
                $ref: '#/components/schemas/UuUniNeighbourCellInfo'
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: UuUniNeighbourCellInfo
            v2xApplicationServer:
              # description': V2X Application Server address (consisting of IP address and UDP port) for unicast.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': V2xApplicationServer
              $ref: '#/components/schemas/V2xApplicationServer'
          required:
          - locationInfo
          - v2xApplicationServer
          type: object
          x-etsi-mec-cardinality: '1'
          
    ProvChgUuUniSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/ProvChgUuUniSubscription.links'
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed VIS information. This shall be included both in the request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        filterCriteria:
          $ref: '#/components/schemas/ProvChgUuUniSubscription.filterCriteria'
        subscriptionType:
          description: Shall be set to "ProvChgUuUniSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
      - filterCriteria
      type: object
      x-etsi-ref: 6.3.2
    SerializerTypes:
      type: string
      
    SubscriptionLinkList.links.subscriptions:
                description: "The service consumer\u2019s subscriptions."
                properties:
                  href:
                    description: The URI referring to the subscription.
                    format: uri
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: URI
                  subscriptionType:
                    description: Type of the subscription. The values are as defined in the \"subscriptionType\" attribute for each different V2X information event subscription data type.
                    type: string
                    x-etsi-mec-cardinality: '1'
                    x-etsi-mec-origin-type: String
                required:
                - href
                - subscriptionType
                x-etsi-mec-cardinality: 0..N   
    
    SubscriptionLinkList.links:
          description: List of hyperlinks related to the resource.
          properties:
              self:
                # description': URI of this resource.
                # x-etsi-mec-cardinality': '1'
                # x-etsi-mec-origin-type': LinkType
                $ref: '#/components/schemas/LinkType'
              subscriptions:
               type: array
               items:
                $ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions'
          type: object
          required:
          - self
          x-etsi-mec-cardinality: '1'
          
    SubscriptionLinkList:
      properties:
        _links:
          $ref: '#/components/schemas/SubscriptionLinkList.links'
      required:
      - _links
      type: object
      x-etsi-ref: 6.3.6
      
    TddInfo:
      properties:
        earfcn:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Earfcn
          $ref: '#/components/schemas/Earfcn'
        subframeAssignment:
          description: Uplink-downlink subframe configuration information.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        transmissionBandwidth:
          # description': ''
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TransmissionBandwidth
          $ref: '#/components/schemas/TransmissionBandwidth'
      required:
      - earfcn
      - transmissionBandwidth
      - subframeAssignment
      type: object
      x-etsi-ref: 6.5.7
    TimeStamp:
      properties:
        nanoSeconds:
          description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          format: Uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        seconds:
          description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
          format: Uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
      required:
      - seconds
      - nanoSeconds
      type: object
      x-etsi-ref: 6.5.2
    TransmissionBandwidth.transmissionBandwidth:
          description: 'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows:1 = bw6 (6 resource blocks)2 = bw15 (15 resource blocks) 3 = bw25 (25 resource blocks) 4 = bw50 (50 resource blocks) 5 = bw75 (75 resource blocks) 6 = bw100 (100 resource blocks)'
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Enum    
    
    TransmissionBandwidth:
      properties:
        transmissionBandwidth:
          $ref: '#/components/schemas/TransmissionBandwidth.transmissionBandwidth'
      required:
      - transmissionBandwidth
      type: object
      x-etsi-ref: 6.6.4
    TransportTypes:
      type: string
    Uint32:
      type: number
    UnsignedInt:
      type: number
    UuMbmsNeighbourCellInfo:
      properties:
        ecgi:
          # description': E-UTRAN CelI Global Identifier.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Ecgi
          $ref: '#/components/schemas/Ecgi'
        fddInfo:
          # description': Information for FDD operation.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': FddInfo
          $ref: '#/components/schemas/FddInfo'
        mbmsServiceAreaIdentity:
          description: Supported MBMS Service Area Identities in the cell.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        pci:
          description: Physical Cell Identifier.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        plmn:
          # description': Public Land Mobile Network Identity.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Plmn
          $ref: '#/components/schemas/Plmn'
        tddInfo:
          # description': Information for TDD operation.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TddInfo
          $ref: '#/components/schemas/TddInfo'
      required:
      - plmn
      - ecgi
      - pci
      - fddInfo
      - tddInfo
      - mbmsServiceAreaIdentity
      type: object
      x-etsi-ref: 6.5.11
      
    UuMbmsProvisioningInfo.proInfoUuMbms:
            description: The provisioning information per location as defined below.
            properties:
              locationInfo:
                # description': Location information to identify a cell of a base station or a particular geographical area.
                # x-etsi-mec-cardinality': '1'
                # x-etsi-mec-origin-type': LocationInfo
                $ref: '#/components/schemas/LocationInfo'
              neighbourCellInfo:
                description: The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.
                type: array
                items:
                  $ref: '#/components/schemas/UuMbmsNeighbourCellInfo'
                minItems: 0
                
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: UuMbmsNeighbourCellInfo
              v2xServerUsd:
                # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS.
                # x-etsi-mec-cardinality': '1'
                # x-etsi-mec-origin-type': V2xServerUsd
                $ref: '#/components/schemas/V2xServerUsd'
            required:
            - locationInfo
            - v2xServerUsd
            
    UuMbmsProvisioningInfo:
        properties:
          proInfoUuMbms:
            $ref: '#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms'
          timeStamp:
            # description': Time stamp.
            # x-etsi-mec-cardinality': 0..1
            # x-etsi-mec-origin-type': TimeStamp
            $ref: '#/components/schemas/TimeStamp'
        required:
        - proInfoUuMbms
        type: object
        x-etsi-ref: 6.2.3
        
    UuUniNeighbourCellInfo:
      properties:
        ecgi:
          # description': E-UTRAN CelI Global Identifier.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Ecgi
          $ref: '#/components/schemas/Ecgi'
        fddInfo:
          # description': Information for FDD operation.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': FddInfo
          $ref: '#/components/schemas/FddInfo'
        pci:
          description: Physical Cell Identifier.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        plmn:
          # description': Public Land Mobile Network Identity.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Plmn
          $ref: '#/components/schemas/Plmn'
        tddInfo:
          # description': Information for TDD operation.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TddInfo
          $ref: '#/components/schemas/TddInfo'
      required:
      - plmn
      - ecgi
      - pci
      - fddInfo
      - tddInfo
      type: object
      x-etsi-ref: 6.5.9
      
    UuUnicastProvisioningInfo.proInfoUuUnicast:
            description: The provisioning information per location as defined below.
            properties:
              locationInfo:
                # description': Location information to identify a cell of a base station or a particular geographical area.
                # x-etsi-mec-cardinality': '1'
                # x-etsi-mec-origin-type': LocationInfo
                $ref: '#/components/schemas/LocationInfo'
              neighbourCellInfo:
                description: The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.
                items:
                  $ref: '#/components/schemas/UuUniNeighbourCellInfo'
                minItems: 0
                type: array
                x-etsi-mec-cardinality: 0..N
                x-etsi-mec-origin-type: UuUniNeighbourCellInfo
              v2xApplicationServer:
                # description': V2X Application Server address (consisting of IP address and UDP port) for unicast.
                # x-etsi-mec-cardinality': '1'
                # x-etsi-mec-origin-type': V2xApplicationServer
                $ref: '#/components/schemas/V2xApplicationServer'
            required:
            - locationInfo
            - v2xApplicationServer
            x-etsi-mec-cardinality: 1..N
    UuUnicastProvisioningInfo:
        properties:
          proInfoUuUnicast:
           type: array
           items:
            $ref: '#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast'
          timeStamp:
            # description': Time stamp.
            # x-etsi-mec-cardinality': 0..1
            # x-etsi-mec-origin-type': TimeStamp
            $ref: '#/components/schemas/TimeStamp'
        required:
        - proInfoUuUnicast
        type: object
        x-etsi-ref: 6.2.2
    V2xApplicationServer:
      properties:
        ipAddress:
          description: ''
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        udpPort:
          description: ''
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - ipAddress
      - udpPort
      type: object
      x-etsi-ref: 6.5.8
      
    
    V2xMsgPublication:
      properties:
        msgContent:
          description: Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        msgEncodeFormat:
          description: The encode format of the V2X message, for example base64.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        msgType:
          description: Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.
          enum:
          - SEE_DESCRIPTION
          type: string
          x-etsi-mec-cardinality: '1'
          #x-etsi-mec-origin-type: Enum
        stdOrganization:
          description: "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 1."
          enum:
          - SEE_DESCRIPTION
          type: string
          x-etsi-mec-cardinality: '1'
          #-etsi-mec-origin-type: Enum
      required:
      - stdOrganization
      - msgType
      - msgEncodeFormat
      - msgContent
      type: object
      x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114."
      x-etsi-ref: 6.2.6
      
    V2xMsgSubscription.links:
          description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              # description': Self-referring URI. The URI shall be unique within the VIS API as it acts as an ID for the subscription.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LinkType
              $ref: '#/components/schemas/LinkType'
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
    V2xMsgSubscription.filterCriteria:
          description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.
          properties:
            msgType:
              description: Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.
              items:
                type: string
              minItems: 0
              type: array
              x-etsi-mec-cardinality: 0..N
              x-etsi-mec-origin-type: Enum
            stdOrganization:
              description: "Standardization organization which defines the subscribed V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 1."
              enum:
              - SEE_DESCRIPTION
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Enum
          required:
          - stdOrganization
          type: object
          x-etsi-mec-cardinality: '1'
          
    V2xMsgSubscription:
      properties:
        _links:
          $ref: '#/components/schemas/V2xMsgSubscription.links'
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed V2X message. This shall be included both in the request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        filterCriteria:
          $ref: '#/components/schemas/V2xMsgSubscription.filterCriteria'
        subscriptionType:
          description: Shall be set to "V2xMsgSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
      - filterCriteria
      type: object
      x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114."
      x-etsi-ref: 6.3.5
      
    V2xServerUsd.sdpInfo:
          description: SDP with IP multicast address and port number used for V2X communication via MBMS.
          properties:
            ipMulticastAddress:
              description: ''
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            portNumber:
              description: ''
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
          required:
          - ipMulticastAddress
          - portNumber
          type: object
          x-etsi-mec-cardinality: '1'
    V2xServerUsd.tmgi:
          description: Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services.
          properties:
            mbmsServiceId:
              description: MBMS Service ID consisting of three octets.
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            mcc:
              description: The Mobile Country Code part of PLMN Identity.
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
            mnc:
              description: The Mobile Network Code part of PLMN Identity.
              type: string
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: String
          required:
          - mbmsServiceId
          - mcc
          - mnc
          type: object
          x-etsi-mec-cardinality: ''
          
    V2xServerUsd:
      properties:
        sdpInfo:
          $ref: '#/components/schemas/V2xServerUsd.sdpInfo'
        serviceAreaIdentifier:
          description: A list of service area identifier for the applicable MBMS broadcast area.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        tmgi:
          $ref: '#/components/schemas/V2xServerUsd.tmgi'
      required:
      - tmgi
      - serviceAreaIdentifier
      - sdpInfo
      type: object
      x-etsi-ref: 6.5.10
    VirtualNetworkInterfaceRequirements:
      type: string
      
    LinkType:
      description: >-
        'This data type represents a type of link'
      type: object
      required:
        - href
      properties:
        href:
          $ref: '#/components/schemas/Href' 
    Href:
      description: >-
        The URI referring to the subscription.
      type: string
      format: uri        
    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            
  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'
    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'             
    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'
    429:
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'