summaryrefslogtreecommitdiffstats
path: root/a1-policy-management/api/pms-api.json
blob: 9fc8e7bbed0c48b98c887d411089f8e9928cb2cd (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
{
    "components": {"schemas": {
        "error_information": {
            "description": "Problem as defined in https://tools.ietf.org/html/rfc7807",
            "type": "object",
            "properties": {
                "detail": {
                    "description": " A human-readable explanation specific to this occurrence of the problem.",
                    "type": "string",
                    "example": "Policy type not found"
                },
                "status": {
                    "format": "int32",
                    "description": "The HTTP status code generated by the origin server for this occurrence of the problem. ",
                    "type": "integer",
                    "example": 404
                }
            }
        },
        "void": {
            "description": "Void/empty",
            "type": "object"
        },
        "status_info_v2": {
            "type": "object",
            "properties": {"status": {
                "description": "status text",
                "type": "string"
            }}
        },
        "ric_info_v2": {
            "description": "Information for a Near-RT RIC",
            "type": "object",
            "properties": {
                "ric_id": {
                    "description": "identity of the Near-RT RIC",
                    "type": "string"
                },
                "managed_element_ids": {
                    "description": "O1 identities for managed entities",
                    "type": "array",
                    "items": {
                        "description": "O1 identities for managed entities",
                        "type": "string"
                    }
                },
                "state": {
                    "description": "Represents the states for a Near-RT RIC",
                    "type": "string",
                    "enum": [
                        "UNAVAILABLE",
                        "AVAILABLE",
                        "SYNCHRONIZING",
                        "CONSISTENCY_CHECK"
                    ]
                },
                "policytype_ids": {
                    "description": "supported policy types",
                    "type": "array",
                    "items": {
                        "description": "supported policy types",
                        "type": "string"
                    }
                }
            }
        },
        "service_registration_info_v2": {
            "description": "Information for one service",
            "type": "object",
            "required": ["service_id"],
            "properties": {
                "callback_url": {
                    "description": "callback for notifying of Near-RT RIC state changes",
                    "type": "string"
                },
                "service_id": {
                    "description": "identity of the service",
                    "type": "string"
                },
                "keep_alive_interval_seconds": {
                    "format": "int64",
                    "description": "keep alive interval for the service. This is a heartbeat supervision of the service, which in regular intervals must invoke a 'keepalive' REST call. When a service does not invoke this call within the given time, it is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means no timeout supervision.",
                    "type": "integer"
                }
            }
        },
        "policy_info_list_v2": {
            "description": "List of policy information",
            "type": "object",
            "properties": {"policies": {
                "description": "List of policy information",
                "type": "array",
                "items": {"$ref": "#/components/schemas/policy_info_v2"}
            }}
        },
        "policy_status_info_v2": {
            "description": "Status for one A1-P Policy",
            "type": "object",
            "properties": {
                "last_modified": {
                    "description": "timestamp, last modification time",
                    "type": "string"
                },
                "status": {
                    "description": "the Policy status",
                    "type": "object"
                }
            }
        },
        "service_status_v2": {
            "description": "List of service information",
            "type": "object",
            "properties": {
                "callback_url": {
                    "description": "callback for notifying of RIC synchronization",
                    "type": "string"
                },
                "service_id": {
                    "description": "identity of the service",
                    "type": "string"
                },
                "keep_alive_interval_seconds": {
                    "format": "int64",
                    "description": "policy keep alive timeout",
                    "type": "integer"
                },
                "time_since_last_activity_seconds": {
                    "format": "int64",
                    "description": "time since last invocation by the service",
                    "type": "integer"
                }
            }
        },
        "ric_info_list_v2": {
            "description": "List of Near-RT RIC information",
            "type": "object",
            "properties": {"rics": {
                "description": "List of Near-RT RIC information",
                "type": "array",
                "items": {"$ref": "#/components/schemas/ric_info_v2"}
            }}
        },
        "policytype_v2": {
            "description": "Policy type",
            "type": "object",
            "properties": {"policy_schema": {
                "description": "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema",
                "type": "object"
            }}
        },
        "policytype_id_list_v2": {
            "description": "Information about policy types",
            "type": "object",
            "properties": {"policytype_ids": {
                "description": "Policy type identities",
                "type": "array",
                "items": {
                    "description": "Policy type identities",
                    "type": "string"
                }
            }}
        },
        "policy_info_v2": {
            "description": "Information for one A1-P Policy",
            "type": "object",
            "required": [
                "policy_data",
                "policy_id",
                "policytype_id",
                "ric_id",
                "service_id"
            ],
            "properties": {
                "ric_id": {
                    "description": "identity of the target Near-RT RIC",
                    "type": "string"
                },
                "policy_id": {
                    "description": "identity of the policy",
                    "type": "string"
                },
                "transient": {
                    "description": "if true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.",
                    "type": "boolean"
                },
                "service_id": {
                    "description": "the identity of the service owning the policy",
                    "type": "string"
                },
                "policy_data": {
                    "description": "the configuration of the policy",
                    "type": "object"
                },
                "status_notification_uri": {
                    "description": "Callback URI for policy status updates",
                    "type": "string"
                },
                "policytype_id": {
                    "description": "identity of the policy type",
                    "type": "string"
                }
            }
        },
        "policy_id_list_v2": {
            "description": "A list of policy identities",
            "type": "object",
            "properties": {"policy_ids": {
                "description": "Policy identities",
                "type": "array",
                "items": {
                    "description": "Policy identities",
                    "type": "string"
                }
            }}
        },
        "service_list_v2": {
            "description": "List of service information",
            "type": "object",
            "properties": {"service_list": {
                "description": "List of service information",
                "type": "array",
                "items": {"$ref": "#/components/schemas/service_status_v2"}
            }}
        },
        "service_callback_info_v2": {
            "description": "Information transferred as in Service callbacks (callback_url)",
            "type": "object",
            "required": [
                "event_type",
                "ric_id"
            ],
            "properties": {
                "ric_id": {
                    "description": "identity of a Near-RT RIC",
                    "type": "string"
                },
                "event_type": {
                    "description": "values:\nAVAILABLE: the  Near-RT RIC has become available for A1 Policy management",
                    "type": "string",
                    "enum": ["AVAILABLE"]
                }
            }
        },
        "Link": {
            "type": "object",
            "properties": {
                "templated": {"type": "boolean"},
                "href": {"type": "string"}
            }
        }
    }},
    "openapi": "3.0.1",
    "paths": {
        "/a1-policy/v2/policy-instances": {"get": {
            "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",
            "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"}}}
                }
            },
            "parameters": [
                {
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "policytype_id",
                    "description": "Select policies with a given type identity.",
                    "required": false
                },
                {
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "ric_id",
                    "description": "Select policies for a given Near-RT RIC identity.",
                    "required": false
                },
                {
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "service_id",
                    "description": "Select policies owned by a given service.",
                    "required": false
                },
                {
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "type_name",
                    "description": "Select policies of a given type name (type identity has the format <typename_version>)",
                    "required": false
                }
            ],
            "tags": ["A1 Policy Management"]
        }},
        "/actuator/threaddump": {"get": {
            "summary": "Actuator web endpoint 'threaddump'",
            "operationId": "threaddump_2",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {"type": "object"}}}
            }},
            "tags": ["Actuator"]
        }},
        "/a1-policy/v2/status": {"get": {
            "summary": "Returns status and statistics of this service",
            "operationId": "getStatus",
            "responses": {"200": {
                "description": "Service is living",
                "content": {"application/json": {"schema": {"$ref": "#/components/schemas/status_info_v2"}}}
            }},
            "tags": ["Health Check"]
        }},
        "/actuator/loggers": {"get": {
            "summary": "Actuator web endpoint 'loggers'",
            "operationId": "loggers",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {"type": "object"}}}
            }},
            "tags": ["Actuator"]
        }},
        "/actuator/health/**": {"get": {
            "summary": "Actuator web endpoint 'health-path'",
            "operationId": "health-path",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {"type": "object"}}}
            }},
            "tags": ["Actuator"]
        }},
        "/a1-policy/v2/rics/ric": {"get": {
            "summary": "Returns info for one Near-RT RIC",
            "description": "Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).",
            "operationId": "getRic",
            "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"}}}
                }
            },
            "parameters": [
                {
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "managed_element_id",
                    "description": "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.",
                    "required": false
                },
                {
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "ric_id",
                    "description": "The identity of a Near-RT RIC to get information for.",
                    "required": false
                }
            ],
            "tags": ["NearRT-RIC Repository"]
        }},
        "/a1-policy/v2/policy-types": {"get": {
            "summary": "Query policy type identities",
            "operationId": "getPolicyTypes",
            "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"}}}
                }
            },
            "parameters": [
                {
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "ric_id",
                    "description": "Select types for the given Near-RT RIC identity.",
                    "required": false
                },
                {
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "type_name",
                    "description": "Select types with the given type name (type identity has the format <typename_version>)",
                    "required": false
                },
                {
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "compatible_with_version",
                    "description": "Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.",
                    "required": false
                }
            ],
            "tags": ["A1 Policy Management"]
        }},
        "/a1-policy/v2/policies/{policy_id}": {
            "get": {
                "summary": "Returns a policy",
                "operationId": "getPolicy",
                "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"}}}
                    }
                },
                "parameters": [{
                    "schema": {"type": "string"},
                    "in": "path",
                    "name": "policy_id",
                    "required": true
                }],
                "tags": ["A1 Policy Management"]
            },
            "delete": {
                "summary": "Delete a policy",
                "operationId": "deletePolicy",
                "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"}}}
                    }
                },
                "parameters": [{
                    "schema": {"type": "string"},
                    "in": "path",
                    "name": "policy_id",
                    "required": true
                }],
                "tags": ["A1 Policy Management"]
            }
        },
        "/actuator/metrics/{requiredMetricName}": {"get": {
            "summary": "Actuator web endpoint 'metrics-requiredMetricName'",
            "operationId": "metrics-requiredMetricName",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {"type": "object"}}}
            }},
            "parameters": [{
                "schema": {"type": "string"},
                "in": "path",
                "name": "requiredMetricName",
                "required": true
            }],
            "tags": ["Actuator"]
        }},
        "/a1-policy/v2/configuration": {
            "get": {
                "summary": "Returns the contents of the application configuration file",
                "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"}}}
                    }
                },
                "tags": ["Management of configuration"]
            },
            "put": {
                "summary": "Replace the current configuration file with the given configuration",
                "requestBody": {
                    "content": {"application/json": {"schema": {"type": "object"}}},
                    "required": true
                },
                "operationId": "putConfiguration",
                "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"}}}
                    }
                },
                "tags": ["Management of configuration"]
            }
        },
        "/actuator": {"get": {
            "summary": "Actuator root web endpoint",
            "operationId": "links",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {
                    "additionalProperties": {
                        "additionalProperties": {"$ref": "#/components/schemas/Link"},
                        "type": "object"
                    },
                    "type": "object"
                }}}
            }},
            "tags": ["Actuator"]
        }},
        "/actuator/loggers/{name}": {
            "post": {
                "summary": "Actuator web endpoint 'loggers-name'",
                "operationId": "loggers-name",
                "responses": {"200": {
                    "description": "OK",
                    "content": {"*/*": {"schema": {"type": "object"}}}
                }},
                "parameters": [{
                    "schema": {"type": "string"},
                    "in": "path",
                    "name": "name",
                    "required": true
                }],
                "tags": ["Actuator"]
            },
            "get": {
                "summary": "Actuator web endpoint 'loggers-name'",
                "operationId": "loggers-name_2",
                "responses": {"200": {
                    "description": "OK",
                    "content": {"*/*": {"schema": {"type": "object"}}}
                }},
                "parameters": [{
                    "schema": {"type": "string"},
                    "in": "path",
                    "name": "name",
                    "required": true
                }],
                "tags": ["Actuator"]
            }
        },
        "/a1-policy/v2/services/{service_id}/keepalive": {"put": {
            "summary": "Heartbeat indicates that the service is running",
            "description": "A registered service must call this in regular intervals to indicate that it is in operation. Absence of this call will lead to that the service will be deregistered and all its policies are removed.",
            "operationId": "keepAliveService",
            "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"}}}
                }
            },
            "parameters": [{
                "schema": {"type": "string"},
                "in": "path",
                "name": "service_id",
                "required": true
            }],
            "tags": ["Service Registry and Supervision"]
        }},
        "/actuator/metrics": {"get": {
            "summary": "Actuator web endpoint 'metrics'",
            "operationId": "metrics",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {"type": "object"}}}
            }},
            "tags": ["Actuator"]
        }},
        "/a1-policy/v2/rics": {"get": {
            "summary": "Query Near-RT RIC information",
            "description": "The call returns all Near-RT RICs that supports a given policy type identity",
            "operationId": "getRics",
            "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"}}}
                }
            },
            "parameters": [{
                "schema": {"type": "string"},
                "in": "query",
                "name": "policytype_id",
                "description": "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned",
                "required": false
            }],
            "tags": ["NearRT-RIC Repository"]
        }},
        "/a1-policy/v2/services": {
            "get": {
                "summary": "Returns service information",
                "description": "Either information about a registered service with given identity or all registered services are returned.",
                "operationId": "getServices",
                "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"}}}
                    }
                },
                "parameters": [{
                    "schema": {"type": "string"},
                    "in": "query",
                    "name": "service_id",
                    "description": "The identity of the service",
                    "required": false
                }],
                "tags": ["Service Registry and Supervision"]
            },
            "put": {
                "summary": "Register a service",
                "requestBody": {
                    "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_registration_info_v2"}}},
                    "required": true
                },
                "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",
                "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"}}}
                    }
                },
                "tags": ["Service Registry and Supervision"]
            }
        },
        "/actuator/info": {"get": {
            "summary": "Actuator web endpoint 'info'",
            "operationId": "info",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {"type": "object"}}}
            }},
            "tags": ["Actuator"]
        }},
        "/status": {"get": {
            "summary": "Returns status and statistics of this service",
            "operationId": "getStatusV1",
            "responses": {"200": {
                "description": "Service is living",
                "content": {"*/*": {"schema": {"type": "string"}}}
            }},
            "tags": ["Health Check"]
        }},
        "/a1-policy/v2/policy-types/{policytype_id}": {"get": {
            "summary": "Returns a policy type definition",
            "operationId": "getPolicyType",
            "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"}}}
                }
            },
            "parameters": [{
                "schema": {"type": "string"},
                "in": "path",
                "name": "policytype_id",
                "required": true
            }],
            "tags": ["A1 Policy Management"]
        }},
        "/actuator/logfile": {"get": {
            "summary": "Actuator web endpoint 'logfile'",
            "operationId": "logfile",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {"type": "object"}}}
            }},
            "tags": ["Actuator"]
        }},
        "/actuator/health": {"get": {
            "summary": "Actuator web endpoint 'health'",
            "operationId": "health",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {"type": "object"}}}
            }},
            "tags": ["Actuator"]
        }},
        "/a1-policy/v2/policies": {
            "get": {
                "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",
                "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"}}}
                    }
                },
                "parameters": [
                    {
                        "schema": {"type": "string"},
                        "in": "query",
                        "name": "policytype_id",
                        "description": "Select policies of a given policy type identity.",
                        "required": false
                    },
                    {
                        "schema": {"type": "string"},
                        "in": "query",
                        "name": "ric_id",
                        "description": "Select policies of a given Near-RT RIC identity.",
                        "required": false
                    },
                    {
                        "schema": {"type": "string"},
                        "in": "query",
                        "name": "service_id",
                        "description": "Select policies owned by a given service.",
                        "required": false
                    },
                    {
                        "schema": {"type": "string"},
                        "in": "query",
                        "name": "type_name",
                        "description": "Select policies of types with the given type name (type identity has the format <typename_version>)",
                        "required": false
                    }
                ],
                "tags": ["A1 Policy Management"]
            },
            "put": {
                "summary": "Create or update a policy",
                "requestBody": {
                    "content": {"application/json": {"schema": {"$ref": "#/components/schemas/policy_info_v2"}}},
                    "required": true
                },
                "operationId": "putPolicy",
                "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"}}}
                    }
                },
                "tags": ["A1 Policy Management"]
            }
        },
        "/r-app/near-rt-ric-status": {"post": {
            "summary": "Callback for Near-RT RIC status",
            "requestBody": {
                "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_callback_info_v2"}}},
                "required": true
            },
            "description": "The URL to this call is registered at Service registration.",
            "operationId": "serviceCallback",
            "responses": {"200": {
                "description": "OK",
                "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}}
            }},
            "tags": ["Callbacks"]
        }},
        "/a1-policy/v2/services/{service_id}": {"delete": {
            "summary": "Unregister a service",
            "operationId": "deleteService",
            "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"}}}
                }
            },
            "parameters": [{
                "schema": {"type": "string"},
                "in": "path",
                "name": "service_id",
                "required": true
            }],
            "tags": ["Service Registry and Supervision"]
        }},
        "/actuator/heapdump": {"get": {
            "summary": "Actuator web endpoint 'heapdump'",
            "operationId": "heapdump",
            "responses": {"200": {
                "description": "OK",
                "content": {"*/*": {"schema": {"type": "object"}}}
            }},
            "tags": ["Actuator"]
        }},
        "/a1-policy/v2/policies/{policy_id}/status": {"get": {
            "summary": "Returns a policy status",
            "operationId": "getPolicyStatus",
            "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"}}}
                }
            },
            "parameters": [{
                "schema": {"type": "string"},
                "in": "path",
                "name": "policy_id",
                "required": true
            }],
            "tags": ["A1 Policy Management"]
        }}
    },
    "info": {
        "license": {
            "name": "Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.",
            "url": "http://www.apache.org/licenses/LICENSE-2.0"
        },
        "description": "<h2>General<\/h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies. <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 unavailable, 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 registered 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 registering services that uses PMS. Each A1 policy is owned by a service. PMS can supervise each registered service and will automatically remove policies for unavailable services.<\/p>",
        "title": "A1 Policy management service",
        "version": "1.1.0"
    },
    "tags": [
        {"name": "Service Registry and Supervision"},
        {"name": "A1 Policy Management"},
        {"name": "NearRT-RIC Repository"},
        {"name": "Callbacks"},
        {"name": "Health Check"},
        {
            "name": "Actuator",
            "description": "Monitor and interact",
            "externalDocs": {
                "description": "Spring Boot Actuator Web API Documentation",
                "url": "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/"
            }
        },
        {"name": "Management of configuration"}
    ]
}