summaryrefslogtreecommitdiffstats
path: root/a1-policy-management/api/pms-api.yaml
blob: b106d11c987f073f6e164e9d3be5553ab0a10e1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
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
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
openapi: 3.0.1
info:
  title: A1 Policy management service
  description: <h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides
    a REST API for management of A1 policices. <br/>The main tasks of the service
    are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring
    and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining
    a view of supported Near-RT RIC policy types</li><li>Supervision of using services
    (R-APPs). When a service is unavailble, its policies are removed.</li></ul><h2>APIs
    provided by the service</h2><h3>A1 Policy Management</h3><p>This is an API for
    management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification
    and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval
    of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API
    for updating and retrieval of the component configuration. Note that there other
    ways to maintain the configuration.</p><h3>Callbacks</h3><p>These are endpoints
    that are invoked by this service. The callbacks are registerred in this service
    at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that
    provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one
    Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service
    Registry and Supervision</h3><p>API used for registerring services that uses PMS.
    Each A1 policy is owned by a service. PMS can supervise each registerred service
    and will automatically remove policies for unavailable services.</p>
  license:
    name: Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.
    url: http://www.apache.org/licenses/LICENSE-2.0
  version: 1.1.0
servers:
- url: /
tags:
- name: A1 Policy Management V1.0
  description: (deprecated primitves)
- name: Management of configuration
- name: A1 Policy Management
- name: NearRT-RIC Repository
- name: Service Registry and Supervision
- name: Health Check
- name: Callbacks
paths:
  /policy_types:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Query policy type names
      operationId: getPolicyTypes
      parameters:
      - name: ric
        in: query
        description: The name of the Near-RT RIC to get types for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policy type names
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
        404:
          description: Near-RT RIC is not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
  /a1-policy/v2/policy-instances:
    get:
      tags:
      - A1 Policy Management
      summary: Query for A1 policy instances
      description: Returns a list of A1 policies matching given search criteria. <br>If
        several query parameters are defined, the policies matching all conditions
        are returned.
      operationId: getPolicyInstances
      parameters:
      - name: policytype_id
        in: query
        description: The identity of the policy type to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: ric_id
        in: query
        description: The identity of the Near-RT RIC to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: service_id
        in: query
        description: The identity of the service to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policy_info_list_v2'
        404:
          description: Near-RT RIC, policy type or service not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
  /a1-policy/v2/status:
    get:
      tags:
      - Health Check
      summary: Returns status and statistics of this service
      operationId: getStatus_1
      responses:
        200:
          description: Service is living
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/status_info_v2'
  /services:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Returns service information
      operationId: getServices
      parameters:
      - name: name
        in: query
        description: The name of the service
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/service_status_v1'
        404:
          description: Service is not found
          content:
            '*/*':
              schema:
                type: string
    delete:
      tags:
      - A1 Policy Management V1.0
      summary: Unregister a service
      operationId: deleteService
      parameters:
      - name: name
        in: query
        description: The name of the service
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        204:
          description: Service unregistered
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/void'
        404:
          description: Service not found
          content:
            '*/*':
              schema:
                type: string
  /a1-policy/v2/rics/ric:
    get:
      tags:
      - NearRT-RIC Repository
      summary: Returns info for one Near-RT RIC
      description: Either a Near-RT RIC identity or a Mananged Element identity can
        be specified.<br>The intention with Mananged Element identity is the ID used
        in O1 for accessing the traffical element (such as the ID of CU).
      operationId: getRic_1
      parameters:
      - name: managed_element_id
        in: query
        description: The identity of a Managed Element. If given, the Near-RT RIC
          managing the ME is returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: ric_id
        in: query
        description: The identity of a Near-RT RIC to get information for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Near-RT RIC is found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ric_info_v2'
        404:
          description: Near-RT RIC is not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
  /a1-policy/v2/policy-types:
    get:
      tags:
      - A1 Policy Management
      summary: Query policy type identities
      operationId: getPolicyTypes_1
      parameters:
      - name: ric_id
        in: query
        description: The identity of the Near-RT RIC to get types for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policy type IDs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policytype_id_list_v2'
        404:
          description: Near-RT RIC is not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
  /a1-policy/v2/policies/{policy_id}:
    get:
      tags:
      - A1 Policy Management
      summary: Returns a policy
      operationId: getPolicy_1
      parameters:
      - name: policy_id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        200:
          description: Policy found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policy_info_v2'
        404:
          description: Policy is not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
    delete:
      tags:
      - A1 Policy Management
      summary: Delete a policy
      operationId: deletePolicy_1
      parameters:
      - name: policy_id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        200:
          description: Not used
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/void'
        423:
          description: Near-RT RIC is not operational
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
        204:
          description: Policy deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/void'
        404:
          description: Policy is not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
  /a1-policy/v2/configuration:
    get:
      tags:
      - Management of configuration
      summary: Returns the contents of the configuration file
      description: Note that the file contents is not relevant if the Consul is used.
      operationId: getConfiguration
      responses:
        200:
          description: Configuration
          content:
            application/json:
              schema:
                type: object
        404:
          description: File is not found or readable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
    put:
      tags:
      - Management of configuration
      summary: Replace the current configuration file with the given configuration
      description: Note that the file is ignored if the Consul is used.
      operationId: putConfiguration
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        200:
          description: Configuration updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/void'
        400:
          description: Invalid configuration provided
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
        500:
          description: Something went wrong when replacing the configuration. Try
            again.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
  /policy:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Returns a policy configuration
      operationId: getPolicy
      parameters:
      - name: id
        in: query
        description: The identity of the policy instance.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policy found
          content:
            '*/*':
              schema:
                type: object
        404:
          description: Policy is not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
    put:
      tags:
      - A1 Policy Management V1.0
      summary: Put a policy
      operationId: putPolicy
      parameters:
      - name: type
        in: query
        description: The name of the policy type.
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: ""
      - name: id
        in: query
        description: The identity of the policy instance.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: ric
        in: query
        description: The name of the Near-RT RIC where the policy will be created.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: service
        in: query
        description: The name of the service creating the policy.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: transient
        in: query
        description: If the policy is transient or not (boolean defaulted to false).
          A policy is transient if it will be forgotten when the service needs to
          reconnect to the Near-RT RIC.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
      responses:
        200:
          description: Policy updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/void'
        201:
          description: Policy created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/void'
        423:
          description: Near-RT RIC is not operational
          content:
            '*/*':
              schema:
                type: string
        404:
          description: Near-RT RIC or policy type is not found
          content:
            '*/*':
              schema:
                type: string
    delete:
      tags:
      - A1 Policy Management V1.0
      summary: Delete a policy
      operationId: deletePolicy
      parameters:
      - name: id
        in: query
        description: The identity of the policy instance.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Not used
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/void'
        423:
          description: Near-RT RIC is not operational
          content:
            '*/*':
              schema:
                type: string
        204:
          description: Policy deleted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/void'
        404:
          description: Policy is not found
          content:
            '*/*':
              schema:
                type: string
  /policies:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Query policies
      operationId: getPolicies
      parameters:
      - name: type
        in: query
        description: The name of the policy type to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: ric
        in: query
        description: The name of the Near-RT RIC to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: service
        in: query
        description: The name of the service to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policies
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/policy_info_v1'
        404:
          description: Near-RT RIC or type not found
          content:
            '*/*':
              schema:
                type: string
  /a1-policy/v2/services/{service_id}/keepalive:
    put:
      tags:
      - Service Registry and Supervision
      summary: Heartbeat indicates that the service is running
      description: A registerred service must call this in regular intervals to indicate
        that it is in operation. Absence of this call will lead to that teh service
        will be deregisterred and all its policies are removed.
      operationId: keepAliveService_1
      parameters:
      - name: service_id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        200:
          description: Service supervision timer refreshed, OK
          content:
            '*/*':
              schema:
                type: object
        404:
          description: The service is not found, needs re-registration
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
  /rics:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Query Near-RT RIC information
      operationId: getRics
      parameters:
      - name: policyType
        in: query
        description: The name of the policy type
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ric_info_v1'
        404:
          description: Policy type is not found
          content:
            '*/*':
              schema:
                type: string
  /policy_schema:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Returns one policy type schema definition
      operationId: getPolicySchema
      parameters:
      - name: id
        in: query
        description: The identity of the policy type to get the definition for.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policy schema
          content:
            '*/*':
              schema:
                type: object
        404:
          description: The policy type is not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
  /policy_status:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Returns a policy status
      operationId: getPolicyStatus
      parameters:
      - name: id
        in: query
        description: The identity of the policy.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policy status
          content:
            '*/*':
              schema:
                type: object
        404:
          description: Policy is not found
          content:
            '*/*':
              schema:
                type: string
  /a1-policy/v2/rics:
    get:
      tags:
      - NearRT-RIC Repository
      summary: Query Near-RT RIC information
      description: The call returns all Near-RT RICs that supports a given policy
        type identity
      operationId: getRics_1
      parameters:
      - name: policytype_id
        in: query
        description: The identity of a policy type. If given, all Near-RT RICs supporteing
          the policy type are returned
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ric_info_list_v2'
        404:
          description: Policy type is not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
  /policy_schemas:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Returns policy type schema definitions
      operationId: getPolicySchemas
      parameters:
      - name: ric
        in: query
        description: The name of the Near-RT RIC to get the definitions for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policy schemas
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: object
        404:
          description: Near-RT RIC is not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
  /policy_ids:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Query policies, only policy identities returned
      operationId: getPolicyIds
      parameters:
      - name: type
        in: query
        description: The name of the policy type to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: ric
        in: query
        description: The name of the Near-RT RIC to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: service
        in: query
        description: The name of the service to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policy identitiess
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
        404:
          description: Near-RT RIC or type not found
          content:
            '*/*':
              schema:
                type: string
  /a1-policy/v2/services:
    get:
      tags:
      - Service Registry and Supervision
      summary: Returns service information
      description: Either information about a registered service with given identity
        or all registered services are returned.
      operationId: getServices_1
      parameters:
      - name: service_id
        in: query
        description: The identity of the service
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service_list_v2'
        404:
          description: Service is not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
    put:
      tags:
      - Service Registry and Supervision
      summary: Register a service
      description: Registering a service is needed to:<ul><li>Get callbacks.</li><li>Activate
        supervision of the service. If a service is inactive, its policies will be
        deleted.</li></ul>
      operationId: putService_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/service_registration_info_v2'
        required: true
      responses:
        200:
          description: Service updated
          content:
            '*/*':
              schema:
                type: object
        201:
          description: Service created
          content:
            '*/*':
              schema:
                type: object
        400:
          description: The ServiceRegistrationInfo is not accepted
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
  /ric:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Returns the name of a RIC managing one Mananged Element
      operationId: getRic
      parameters:
      - name: managedElementId
        in: query
        description: The identity of the Managed Element
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Near-RT RIC is found
          content:
            '*/*':
              schema:
                type: string
        404:
          description: Near-RT RIC is not found
          content:
            '*/*':
              schema:
                type: string
  /services/keepalive:
    put:
      tags:
      - A1 Policy Management V1.0
      summary: Heartbeat from a service
      operationId: keepAliveService
      parameters:
      - name: name
        in: query
        description: The name of the service
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Service supervision timer refreshed, OK
          content:
            '*/*':
              schema:
                type: string
        404:
          description: The service is not found, needs re-registration
          content:
            '*/*':
              schema:
                type: string
  /status:
    get:
      tags:
      - A1 Policy Management V1.0
      summary: Returns status and statistics of this service
      operationId: getStatus
      responses:
        200:
          description: Service is living
          content:
            '*/*':
              schema:
                type: string
  /a1-policy/v2/policy-types/{policytype_id}:
    get:
      tags:
      - A1 Policy Management
      summary: Returns a policy type definition
      operationId: getPolicyType
      parameters:
      - name: policytype_id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        200:
          description: Policy type
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/policytype_v2'
        404:
          description: Policy type is not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
  /a1-policy/v2/policies:
    get:
      tags:
      - A1 Policy Management
      summary: Query policy identities
      description: Returns a list of A1 policies matching given search criteria. <br>If
        several query parameters are defined, the policies matching all conditions
        are returned.
      operationId: getPolicyIds_1
      parameters:
      - name: policytype_id
        in: query
        description: The identity of the policy type to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: ric_id
        in: query
        description: The identity of the Near-RT RIC to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: service_id
        in: query
        description: The identity of the service to get policies for.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        200:
          description: Policy identities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policy_id_list_v2'
        404:
          description: Near-RT RIC or type not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
    put:
      tags:
      - A1 Policy Management
      summary: Create or update a policy
      operationId: putPolicy_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/policy_info_v2'
        required: true
      responses:
        200:
          description: Policy updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/void'
        201:
          description: Policy created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/void'
        423:
          description: Near-RT RIC is not operational
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
        404:
          description: Near-RT RIC or policy type is not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
  /r-app/near-rt-ric-status:
    post:
      tags:
      - Callbacks
      summary: Callback for Near-RT RIC status
      description: The URL to this call is registerred at Service registration.
      operationId: jobStatusCallback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/service_callback_info_v2'
        required: true
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/void'
  /service:
    put:
      tags:
      - A1 Policy Management V1.0
      summary: Register a service
      operationId: putService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/service_registration_info_v1'
        required: true
      responses:
        200:
          description: Service updated
          content:
            '*/*':
              schema:
                type: string
        201:
          description: Service created
          content:
            '*/*':
              schema:
                type: string
        400:
          description: The ServiceRegistrationInfo is not accepted
          content:
            '*/*':
              schema:
                type: string
  /a1-policy/v2/services/{service_id}:
    delete:
      tags:
      - Service Registry and Supervision
      summary: Unregister a service
      operationId: deleteService_1
      parameters:
      - name: service_id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        200:
          description: Not used
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/void'
        204:
          description: Service unregistered
          content:
            '*/*':
              schema:
                type: object
        404:
          description: Service not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/error_information'
  /a1-policy/v2/policies/{policy_id}/status:
    get:
      tags:
      - A1 Policy Management
      summary: Returns a policy status
      operationId: getPolicyStatus_1
      parameters:
      - name: policy_id
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        200:
          description: Policy status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policy_status_info_v2'
        404:
          description: Policy is not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_information'
components:
  schemas:
    error_information:
      type: object
      properties:
        detail:
          type: string
          description: ' A human-readable explanation specific to this occurrence
            of the problem.'
          example: Policy type not found
        status:
          type: integer
          description: 'The HTTP status code generated by the origin server for this
            occurrence of the problem. '
          format: int32
          example: 503
      description: Problem as defined in https://tools.ietf.org/html/rfc7807
    void:
      type: object
      description: Void/empty
    status_info_v2:
      type: object
      properties:
        status:
          type: string
          description: status text
    policy_info_v1:
      type: object
      properties:
        service:
          type: string
          description: the name of the service owning the policy
        json:
          type: object
          description: the configuration of the policy
        id:
          type: string
          description: identity of the policy
        lastModified:
          type: string
          description: timestamp, last modification time
        type:
          type: string
          description: name of the policy type
        ric:
          type: string
          description: identity of the target Near-RT RIC
    service_registration_info_v1:
      type: object
      properties:
        keepAliveIntervalSeconds:
          type: integer
          description: keep alive interval for the service. This is a heartbeat supervision
            of the service, which in regular intevals must invoke a 'keepAlive' REST
            call. When a service does not invoke this call within the given time,
            it is considered unavailble. An unavailable service will be automatically
            deregistered and its policies will be deleted. Value 0 means no timeout
            supervision.
          format: int64
        callbackUrl:
          type: string
          description: callback for notifying of RIC synchronization
        serviceName:
          type: string
    ric_info_v2:
      type: object
      properties:
        ric_id:
          type: string
          description: identity of the Near-RT RIC
        managed_element_ids:
          type: array
          description: O1 identities for managed entities
          items:
            type: string
            description: O1 identities for managed entities
        state:
          type: string
          description: Represents the states for a Near-RT RIC
          enum:
          - UNAVAILABLE
          - AVAILABLE
          - SYNCHRONIZING
          - CONSISTENCY_CHECK
        policytype_ids:
          type: array
          description: supported policy types
          items:
            type: string
            description: supported policy types
      description: Information for a Near-RT RIC
    service_registration_info_v2:
      required:
      - service_id
      type: object
      properties:
        callback_url:
          type: string
          description: callback for notifying of Near-RT RIC state changes
        service_id:
          type: string
          description: identity of the service
        keep_alive_interval_seconds:
          type: integer
          description: keep alive interval for the service. This is a heartbeat supervision
            of the service, which in regular intevals must invoke a 'keepalive' REST
            call. When a service does not invoke this call within the given time,
            it is considered unavailble. An unavailable service will be automatically
            deregistered and its policies will be deleted. Value 0 means no timeout
            supervision.
          format: int64
      description: Information for one service
    policy_info_list_v2:
      type: object
      properties:
        policies:
          type: array
          description: List of policy information
          items:
            $ref: '#/components/schemas/policy_info_v2'
      description: List of policy information
    ric_info_v1:
      type: object
      properties:
        managedElementIds:
          type: array
          description: O1 identities for managed entities
          items:
            type: string
            description: O1 identities for managed entities
        policyTypes:
          type: array
          description: supported policy types
          items:
            type: string
            description: supported policy types
        state:
          type: string
          description: state info
        ricName:
          type: string
          description: identity of the Near-RT RIC
    service_status_v1:
      type: object
      properties:
        keepAliveIntervalSeconds:
          type: integer
          description: policy keep alive timeout
          format: int64
        timeSinceLastActivitySeconds:
          type: integer
          description: time since last invocation by the service
          format: int64
        callbackUrl:
          type: string
          description: callback for notifying of RIC synchronization
        serviceName:
          type: string
          description: identity of the service
    policy_status_info_v2:
      type: object
      properties:
        last_modified:
          type: string
          description: timestamp, last modification time
        status:
          type: object
          description: the Policy status
      description: Status for one A1-P Policy
    service_status_v2:
      type: object
      properties:
        callback_url:
          type: string
          description: callback for notifying of RIC synchronization
        service_id:
          type: string
          description: identity of the service
        keep_alive_interval_seconds:
          type: integer
          description: policy keep alive timeout
          format: int64
        time_since_last_activity_seconds:
          type: integer
          description: time since last invocation by the service
          format: int64
      description: List of service information
    ric_info_list_v2:
      type: object
      properties:
        rics:
          type: array
          description: List of Near-RT RIC information
          items:
            $ref: '#/components/schemas/ric_info_v2'
      description: List of Near-RT RIC information
    policytype_v2:
      type: object
      properties:
        policy_schema:
          type: object
          description: Policy type json scema. The schema is a json object following
            http://json-schema.org/draft-07/schema
      description: Policy type
    policytype_id_list_v2:
      type: object
      properties:
        policytype_ids:
          type: array
          description: Policy type identities
          items:
            type: string
            description: Policy type identities
      description: Information about policy types
    policy_info_v2:
      required:
      - policy_data
      - policy_id
      - policytype_id
      - ric_id
      - service_id
      type: object
      properties:
        ric_id:
          type: string
          description: identity of the target Near-RT RIC
        policy_id:
          type: string
          description: identity of the policy
        transient:
          type: boolean
          description: if true, the policy is deleted at RIC restart. If false, its
            value is maintained by this service until explicitly deleted. Default
            false.
        service_id:
          type: string
          description: the name of the service owning the policy
        policy_data:
          type: object
          description: the configuration of the policy
        status_notification_uri:
          type: string
          description: Callback URI for policy status updates
        policytype_id:
          type: string
          description: identity of the policy type
      description: Information for one A1-P Policy
    policy_id_list_v2:
      type: object
      properties:
        policy_ids:
          type: array
          description: Policy identities
          items:
            type: string
            description: Policy identities
      description: A list of policy identities
    service_list_v2:
      type: object
      properties:
        service_list:
          type: array
          description: List of service information
          items:
            $ref: '#/components/schemas/service_status_v2'
      description: List of service information
    service_callback_info_v2:
      required:
      - event_type
      - ric_id
      type: object
      properties:
        ric_id:
          type: string
          description: identity of a Near-RT RIC
        event_type:
          type: string
          description: |-
            values:
            AVAILABLE: the  Near-RT RIC has become available for A1 Policy management
          enum:
          - AVAILABLE
      description: Information transferred as in Service callbacks (callback_url)