1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2020-2023 Nordix Foundation. All rights reserved.
3 # Copyright (C) 2023-2025 OpenInfra Foundation Europe. All rights reserved.
4 # ================================================================================
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # SPDX-License-Identifier: Apache-2.0
18 # ============LICENSE_END=========================================================
23 email: discuss-list@onap.com
24 name: ONAP CCSDK Project
25 url: https://www.onap.org/
26 description: "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides\
27 \ a REST API for managing A1 policies. <br/>This document describes an older pre-spec\
28 \ API set to perform tasks for: </p><ul><li>A1 Policy creation, modification\
29 \ and deletion.</li><li>Monitoring and maintaining consistency of the SMO view\
30 \ of A1 Policies and the Near-RT RICs</li><li>Maintaining a view of each Near-RT\
31 \ RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps).\
32 \ When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs\
33 \ provided or defined by the service</h2><h3>A1 Policy Management (Older pre-spec\
34 \ version) </h3> <p>This is an older API for managing A1 Policies:</p><ul><li>A1\
35 \ Policy retrieval, creation, modification and deletion.</li><li>Retrieval of\
36 \ supported A1 Policy Types for a Near-RT RIC</li><li>Retrieval of status for\
37 \ existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for\
38 \ updating and retrieval of the component configuration. Note that there other\
39 \ ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These are\
40 \ endpoints that are invoked by this service. The callbacks are registered in\
41 \ this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3>\
42 \ <p>This is an API that provides support for looking up a NearRT-RIC. Each A1\
43 \ policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used\
44 \ for supervision of the A1 Policy Management Service .</p><h3>Service Registry\
45 \ and Supervision</h3> <p>API used for registering services/clients/rApps. Each\
46 \ A1 Policy can be tagged with an owner. If the owner service is registered, then\
47 \ the service can be monitored by a heart-beat supervision mechanism, and if the\
48 \ registered service becomes unavailable, then its A1 Policies are removed. Note\
49 \ that services do not need to be registered to create A1 Policies, but unregistered\
50 \ services are not supervised. This is a feature that is optional to use.</p><h3>Authorization\
51 \ API</h3><p>API used for access control of A1 Policy access. If configured, an\
52 \ external authorization provider is requested to grant access to the A1 Policy\
53 \ Type.</p><h3>Spring Boot Actuator</h3><p>Provides built-in functions used to\
54 \ monitor and configure the Spring web application hosting the service.</p>"
56 name: "Copyright (C) 2020-2023 Nordix Foundation, and Copyright (C) 2024-2025\
57 \ OpenInfra Foundation Europe. \nAll rights reserved. Licensed under the Apache\
59 url: http://www.apache.org/licenses/LICENSE-2.0
60 title: ONAP CCSDK - Pre-Spec A1 Policy Management API
62 x-api-id: a31c510b-20e6-4a08-af16-368c44d7fba8
63 x-audience: external-public
68 Older pre-spec API used to get, create, update and delete A1 Policy Instances. Also used to query A1 Policy Types.
69 name: A1 Policy Management
71 Older API used to get information about registered Near-RT RICs.
72 name: NearRT-RIC Repository
74 Older API used to manage registered services, and control their keep-alive status via heart-beat messages.
75 name: Service Registry and Supervision
77 API used to get the health status and statistics of this service
80 Callout to registered services to indicate a status changes for a Near-RT RIC. Note that these operations are called by the A1 Policy Management Service, not provided.
81 name: Service Callbacks
83 API used for authorization of information A1 policy access (this is provided by an authorization producer such as OPA). Note that these operations are called by the A1 Policy Management Service, not provided.
84 name: Authorization API
86 API used to create or fetch the application configuration.
89 API used to monitor and configure the A1-PMS Springboot Service.
91 description: Spring Boot Actuator Web API Documentation
92 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
97 description: Returns status and statistics of this service
98 operationId: getStatusV1
105 description: OK - Service is living
106 summary: Get Status (getStatusV1)
109 /a1-policy/v2/status:
111 description: Returns status and statistics of this service
112 operationId: getStatus
119 $ref: '#/components/examples/status_info'
121 $ref: '#/components/schemas/status_info'
122 description: OK- Service is living Ok
123 summary: Get Status (getStatus)
126 /a1-policy/v2/rics/ric:
129 Query information about a Near-RT RIC. Either a Near-RT RIC identity or a Managed Element identity can be specified. The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).
133 The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
136 name: managed_element_id
141 - description: The identity of a Near-RT RIC to get information for.
155 $ref: '#/components/examples/ric_info'
157 $ref: '#/components/schemas/ric_info'
158 description: OK - Near-RT RIC is found
161 application/problem+json:
163 description: Not Found
164 summary: Get a Near-RT RIC (getRic)
166 - NearRT-RIC Repository
167 /a1-policy/v2/policy-types:
169 description: Query A1 Policy Type identities using query parameters
170 operationId: getPolicyTypes
172 - description: Select types for the given Near-RT RIC identity.
180 - description: Select types compatible with the given type name (type identity
181 has the format 'typename_version')
189 - description: Select types that are compatible with the given version. This
190 parameter is only applicable in conjunction with type_name. As an example
191 version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching
192 types will be returned sorted in ascending order.
195 name: compatible_with_version
206 $ref: '#/components/examples/policy_type_id_list'
208 $ref: '#/components/schemas/policy_type_id_list'
209 description: OK - Policy Type IDs Found
212 application/problem+json:
214 description: Not Found
215 summary: Get A1 Policy Types (getPolicyTypes)
217 - A1 Policy Management
218 /a1-policy/v2/policies/{policy_id}:
220 description: Delete an A1 Policy instance using its policy ID.
221 operationId: deletePolicy
235 $ref: '#/components/schemas/void'
236 description: OK - Policy deleted
239 application/problem+json:
243 detail: Requested resource is in a locked state.
245 $ref: '#/components/schemas/error_information'
246 description: Locked - HTTP Status code which can be used when the state
248 summary: Delete an A1 Policy instance (deletePolicy)
250 - A1 Policy Management
252 description: Get an A1 Policy instance using its policy ID
253 operationId: getPolicy
268 $ref: '#/components/examples/policy_info'
270 $ref: '#/components/schemas/policy_info'
271 description: OK - Policy found
274 application/problem+json:
276 description: Not Found
277 summary: Get an A1 Policy instance (getPolicy)
279 - A1 Policy Management
280 /a1-policy/v2/services/{service_id}/keepalive:
282 description: "A registered service should invoke this operation regularly to\
283 \ indicate that it is still alive. If a registered service fails to invoke\
284 \ some operation, or this operation, before the end of a timeout period the\
285 \ service will be deregistered and all its A1 policies wil be removed. This\
286 \ operation is only intended for registered services. (This timeout can be\
287 \ set or disabled when each service is initially registered)"
288 operationId: keepAliveService
303 description: "OK - Service supervision timer refreshed, OK"
306 application/problem+json:
308 description: Not Found
309 summary: Heartbeat message from a service (keepAliveService)
311 - Service Registry and Supervision
314 description: Get all Near-RT RICs that supports a given A1 Policy Type ID
318 The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.
332 $ref: '#/components/examples/ric_info_list'
334 $ref: '#/components/schemas/ric_info_list'
338 application/problem+json:
340 description: Not Found
341 summary: Get Near-RT RICs for A1 Policy Type (getRics)
343 - NearRT-RIC Repository
344 /a1-policy/v2/services:
347 Get information about all registered services, or a single registered service. If the service ID of a registered service is included in the query, information about that service is returned. Otherwise Information about all registered is returned. This operation does not retrieve information about unregistered services.
348 operationId: getServices
350 - description: The identity of the registered service
364 $ref: '#/components/examples/service_status_list'
366 $ref: '#/components/schemas/service_status_list'
370 application/problem+json:
372 description: Not Found
373 summary: Get Services (getServices)
375 - Service Registry and Supervision
379 '{$request.body#/callback_url}':
381 description: "Callouts to indicate Near-RT RIC status changes relevant\
382 \ for Services. \nThe URL invoked by this callback is provided at\
383 \ Service registration.\n"
384 operationId: serviceCallback
389 $ref: '#/components/schemas/service_callback_info_v2'
396 $ref: '#/components/schemas/void'
400 application/problem+json:
402 description: Not Found
403 summary: Callback for Near-RT RIC status (serviceCallback)
405 - Service Registry and Supervision
407 x-callback-request: true
409 Register a single service, or update a previous registtration. Service registration is required to get callbacks about available NearRT RICs and to enable supervision of the service's active status. If a registered service becomes inactive, its policies can be automatically deleted. A1 Policy instances can also be created for unregistered services. If an unregistered service is later registered, the service's policies are retained when the service becomes registered. This feature is optional to use.
410 operationId: putService
415 $ref: '#/components/schemas/service_registration_info'
423 description: OK - Service updated
429 description: Created - Service created
432 application/problem+json:
436 detail: The provided request is not valid.
438 $ref: '#/components/schemas/error_information'
439 description: Bad Request
440 summary: Register or update a Service (putService)
442 - Service Registry and Supervision
443 /a1-policy/v2/policy-types/{policytype_id}:
445 description: Get an A1 Policy Type definition using its policy type ID
446 operationId: getPolicyTypeDefinition
460 policy_type_definition:
461 $ref: '#/components/examples/policy_type_definition'
463 $ref: '#/components/schemas/policy_type_definition'
464 description: OK - schema of the requested A1 Policy Type
467 application/problem+json:
469 description: Not Found
470 summary: Get an A1 Policy Type definition (getPolicyTypeDefinition)
472 - A1 Policy Management
473 /a1-policy/v2/policies:
476 Retrieve a list of A1 Policy Instance IDs for policies that match given search criteria. If multiple query parameters are given, the policies matching all conditions are returned.
477 operationId: getPolicyIds
479 - description: Select policies of a given A1 Policy Type ID.
487 - description: Select policies of a given Near-RT RIC identity.
495 - description: Select policies owned by a given service. (Both registered and
496 unregistered services)
505 Select policies of types with the given A1 Policy Type name (type names have the format 'typename_version')
519 $ref: '#/components/examples/policy_id_list'
521 $ref: '#/components/schemas/policy_id_list'
522 description: OK - Policy identities
525 application/problem+json:
527 description: Not Found
528 summary: Query A1 Policy Instances (getPolicyIds)
530 - A1 Policy Management
532 description: Create or Update an A1 Policy Instance
533 operationId: putPolicy
538 $ref: '#/components/schemas/policy_info'
545 $ref: '#/components/schemas/void'
546 description: OK - Policy updated
551 $ref: '#/components/schemas/void'
552 description: Created - Policy created
555 application/problem+json:
559 detail: Requested resource is in a locked state.
561 $ref: '#/components/schemas/error_information'
562 description: Locked - HTTP Status code which can be used when the state
564 summary: Create or Update an A1 Policy Instance (putPolicy)
566 - A1 Policy Management
567 /a1-policy/v2/policy-instances:
570 Returns a collection of A1 Policy Instance information for policies that match given search criteria. If several query parameters are defined, the policies matching all conditions are returned.
571 operationId: getPolicyInstances
573 - description: Select policies with a given A1 Policy Type ID.
581 - description: Select policies for a given Near-RT RIC identity.
589 - description: Select policies owned by a given service (registered or unregistered).
597 - description: Select policies of a given A1 Policy Type name (type identity
598 has the format 'typename_version').
612 $ref: '#/components/examples/policy_info_list'
614 $ref: '#/components/schemas/policy_info_list'
615 description: OK - Returns A1 Policy Instances which match the criteria
620 $ref: '#/components/schemas/error_information'
621 description: "Not Found - Near-RT RIC, A1 Policy Type or service was not\
623 summary: Query for A1 Policy instances (getPolicyInstances)
625 - A1 Policy Management
626 /a1-policy/v2/services/{service_id}:
629 Unregister a registered Service using its service ID. Only registered services can be unregistered. All A1 Policy Instances for the previously registered service will be removed.
630 operationId: deleteService
645 description: No Content - Service unregistered
648 application/problem+json:
650 description: Not Found
651 summary: Unregister a Service (deleteService)
653 - Service Registry and Supervision
654 /a1-policy/v2/policies/{policy_id}/status:
656 description: Retrieve the status information for an A1 Policy Instance.
657 operationId: getPolicyStatus
672 $ref: '#/components/examples/policy_status_info'
674 $ref: '#/components/schemas/policy_status_info'
675 description: OK - Policy status
678 application/problem+json:
680 description: Not Found
681 summary: Get an A1 Policy Instance's status (getPolicyStatus)
683 - A1 Policy Management
684 /a1-policy/v2/configuration:
686 description: Returns the entire contents of the Application Configuration.
687 operationId: getConfiguration
694 description: OK - Configuration
697 application/problem+json:
699 description: Not Found
700 summary: Get the Application Configuration (getConfiguration)
705 Replace the current Application Configuration with a new configuration. The new configuration, if accepted, will take effect after a short delay. The new configuration must comply with the Application Configuration schema, which can be found from the the Application Documentation (Developer Guide)
706 operationId: putConfiguration
718 $ref: '#/components/schemas/void'
719 description: OK - Configuration updated
722 application/problem+json:
726 detail: The provided request is not valid.
728 $ref: '#/components/schemas/error_information'
729 description: Bad Request
730 summary: Set/Replace the Application Configuration (putConfiguration)
733 /example-authz-check:
736 A template endpoint for callout requests to an external authorization function. The authorization function, if enabled, decides if individual operations are permitted.
737 operationId: performAccessControl
742 $ref: '#/components/schemas/policy_authorization'
749 $ref: '#/components/schemas/authorization_result'
753 application/problem+json:
757 detail: Your role does not allow to perform this action. Contact System
758 Administrator to change your access rights.
760 $ref: '#/components/schemas/error_information'
761 description: Forbidden
762 summary: Callout request for access authorization (performAccessControl)
768 A1-PMS Springboot Service Actuator web endpoint. Returns a set of links to available/enabled actuator endpoints.
770 description: Spring Boot Actuator Web API Documentation
771 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
772 operationId: actuatorLinks
776 application/vnd.spring-boot.actuator.v3+json:
778 additionalProperties:
779 additionalProperties:
780 $ref: '#/components/schemas/Link'
785 additionalProperties:
786 additionalProperties:
787 $ref: '#/components/schemas/Link'
790 application/vnd.spring-boot.actuator.v2+json:
792 additionalProperties:
793 additionalProperties:
794 $ref: '#/components/schemas/Link'
798 summary: Actuator endpoint - Root (actuatorLinks)
805 A1-PMS Springboot Service Actuator web endpoint - HeapDump.
807 description: Spring Boot Actuator Web API Documentation
808 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
809 operationId: actuatorHeapdump
813 application/octet-stream:
817 summary: Actuator endpoint - Heapdump (actuatorHeapdump)
824 A1-PMS Springboot Service Actuator web endpoint - Info.
826 description: Spring Boot Actuator Web API Documentation
827 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
828 operationId: actuatorInfo
832 application/vnd.spring-boot.actuator.v3+json:
838 application/vnd.spring-boot.actuator.v2+json:
842 summary: Actuator endpoint - Info (actuatorInfo)
846 /actuator/threaddump:
849 A1-PMS Springboot Service Actuator web endpoint - ThreadDump.
851 description: Spring Boot Actuator Web API Documentation
852 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
853 operationId: actuatorThreaddump
857 text/plain;charset=UTF-8:
860 application/vnd.spring-boot.actuator.v3+json:
866 application/vnd.spring-boot.actuator.v2+json:
870 summary: Actuator endpoint - Threaddump (actuatorThreaddump)
877 A1-PMS Springboot Service Actuator web endpoint - Get a list of Loggers.
879 description: Spring Boot Actuator Web API Documentation
880 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
881 operationId: actuatorLoggers
885 application/vnd.spring-boot.actuator.v3+json:
891 application/vnd.spring-boot.actuator.v2+json:
895 summary: Actuator endpoint - Get Loggers (actuatorLoggers)
899 /actuator/loggers/{name}:
902 A1-PMS Springboot Service Actuator web endpoint - Get a single named Logger.
904 description: Spring Boot Actuator Web API Documentation
905 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
906 operationId: actuatorGetLogger
918 application/vnd.spring-boot.actuator.v3+json:
924 application/vnd.spring-boot.actuator.v2+json:
928 summary: Actuator endpoint - Get Logger (actuatorGetLogger)
934 A1-PMS Springboot Service Actuator web endpoint - Create or Update single named Logger.
936 description: Spring Boot Actuator Web API Documentation
937 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
938 operationId: actuatorSetlogger
967 summary: Actuator endpoint - Set Logger (actuatorSetlogger)
974 A1-PMS Springboot Service Actuator web endpoint - Get the Log file.
976 description: Spring Boot Actuator Web API Documentation
977 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
978 operationId: actuatorGetLogFile
982 text/plain;charset=UTF-8:
986 summary: Actuator endpoint - Log File (actuatorGetLogFile)
993 A1-PMS Springboot Service Actuator web endpoint - Health Check.
995 description: Spring Boot Actuator Web API Documentation
996 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
997 operationId: actuatorHealth
1001 application/vnd.spring-boot.actuator.v3+json:
1007 application/vnd.spring-boot.actuator.v2+json:
1011 summary: Actuator endpoint - Health (actuatorHealth)
1015 /actuator/health/**:
1018 A1-PMS Springboot Service Actuator web endpoint - Health Status for an Application Component.
1020 description: Spring Boot Actuator Web API Documentation
1021 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
1022 operationId: actuatorHealthComponent
1026 application/vnd.spring-boot.actuator.v3+json:
1032 application/vnd.spring-boot.actuator.v2+json:
1036 summary: Actuator endpoint - Component Health (actuatorHealthComponent)
1043 A1-PMS Springboot Service Actuator web endpoint - Shutdown the Application.
1045 description: Spring Boot Actuator Web API Documentation
1046 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
1047 operationId: actuatorShutdown
1051 application/vnd.spring-boot.actuator.v3+json:
1057 application/vnd.spring-boot.actuator.v2+json:
1061 summary: Actuator endpoint - Shutdown (actuatorShutdown)
1068 A1-PMS Springboot Service Actuator web endpoint - Get a list of Application metrics names.
1070 description: Spring Boot Actuator Web API Documentation
1071 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
1072 operationId: actuatorMetrics
1076 application/vnd.spring-boot.actuator.v3+json:
1082 application/vnd.spring-boot.actuator.v2+json:
1086 summary: Actuator endpoint - Metrics (actuatorMetrics)
1090 /actuator/metrics/{requiredMetricName}:
1093 A1-PMS Springboot Service Actuator web endpoint - Get the value for a named Application metric.
1095 description: Spring Boot Actuator Web API Documentation
1096 url: https://docs.spring.io/spring-boot/reference/actuator/endpoints.html
1097 operationId: actuatorGetMetric
1101 name: requiredMetricName
1109 application/vnd.spring-boot.actuator.v3+json:
1115 application/vnd.spring-boot.actuator.v2+json:
1119 summary: Actuator endpoint - Get Metric (actuatorGetMetric)
1129 managed_element_ids:
1130 - some_managed_element_id
1131 - some_managed_element_id
1134 - some_policytype_id
1135 - some_policytype_id
1136 policy_type_id_list:
1137 description: Array of A1 Policy Type id's
1139 policy_type_id_list:
1143 description: Information for an A1 Policy Instance
1146 policy_id: policy_id1
1148 service_id: service_id1
1150 status_notification_uri: status_notification_uri
1151 policytype_id: policytype_id1
1156 managed_element_ids:
1157 - some_managed_element_id
1158 - some_managed_element_id
1164 managed_element_ids:
1165 - managed_element_ids
1166 - managed_element_ids
1171 service_status_list:
1172 description: List of service information
1175 - callback_url: callback_url
1176 service_id: service_id
1177 keep_alive_interval_seconds: 0
1178 time_since_last_activity_seconds: 6
1179 - callback_url: callback_url
1180 service_id: service_id
1181 keep_alive_interval_seconds: 0
1182 time_since_last_activity_seconds: 6
1183 policy_type_definition:
1184 description: Schema of the given A1 Policy Type
1188 description: A list of policy identities
1194 description: List of policy information
1198 policy_id: policy_id1
1200 service_id: service_id1
1202 status_notification_uri: status_notification_uri
1203 policytype_id: policytype_id1
1205 policy_id: policy_id2
1207 service_id: service_id2
1209 status_notification_uri: status_notification_uri
1210 policytype_id: policytype_id2
1212 description: Status for one A1-P Policy
1214 last_modified: last_modified
1221 application/problem+json:
1223 description: Not Found
1226 application/problem+json:
1230 detail: Requested resource is in a locked state.
1232 $ref: '#/components/schemas/error_information'
1233 description: Locked - HTTP Status code which can be used when the state is Locked
1236 application/problem+json:
1240 detail: The provided request is not valid.
1242 $ref: '#/components/schemas/error_information'
1243 description: Bad Request
1246 application/problem+json:
1250 detail: Your role does not allow to perform this action. Contact System
1251 Administrator to change your access rights.
1253 $ref: '#/components/schemas/error_information'
1254 description: Forbidden
1261 description: status text
1265 description: Information for a Near-RT RIC
1268 managed_element_ids:
1269 - managed_element_ids
1270 - managed_element_ids
1277 description: identity of the Near-RT RIC
1279 managed_element_ids:
1280 description: O1 identities for managed entities
1282 description: O1 identities for managed entities
1286 description: Represents the states for a Near-RT RIC
1294 description: supported A1 Policy Types
1296 description: supported A1 Policy Types
1300 policy_type_id_list:
1301 description: Information about A1 Policy Types
1308 description: A1 Policy Type identities
1310 description: A1 Policy Type identities
1315 description: Information for one A1-P Policy
1318 policy_id: policy_id
1322 status_notification_uri: status_notification_uri
1323 policytype_id: policytype_id
1326 description: identity of the target Near-RT RIC
1329 description: identity of the policy
1334 If true, the policy is automatically deleted if the targeted Near-RT RIC restarts or recovers. If false, the A1 Policy Instance remains, and is re-pushed to the targeted Near-RT RIC after a restart or recovery. If false, the A1 Policy Instance is maintained and must be deleted separately in the event of Near-RT RIC restart or recovery. Default is false.
1341 The identity of the service owning the policy. This can be used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered. If the service is registered, the A1 Policy Instance will be subject to the same supervision rules as the the service's other policies.
1344 description: the configuration of the policy
1346 status_notification_uri:
1347 description: Callback URI for policy status updates
1350 description: identity of the A1 Policy Type
1359 description: Void/empty
1362 description: Problem as defined in https://tools.ietf.org/html/rfc7807
1364 detail: A1 Policy Type not found
1369 description: ' A human-readable explanation specific to this occurrence
1371 example: A1 Policy Type not found
1374 description: A specific error name
1378 description: 'The HTTP status code generated by the origin server for this
1379 occurrence of the problem. '
1385 description: List of Near-RT RIC information
1389 managed_element_ids:
1390 - managed_element_ids
1391 - managed_element_ids
1397 managed_element_ids:
1398 - managed_element_ids
1399 - managed_element_ids
1406 description: List of Near-RT RIC information
1408 $ref: '#/components/schemas/ric_info'
1411 service_status_list:
1414 - callback_url: callback_url
1415 service_id: service_id
1416 keep_alive_interval_seconds: 0
1417 time_since_last_activity_seconds: 6
1418 - callback_url: callback_url
1419 service_id: service_id
1420 keep_alive_interval_seconds: 0
1421 time_since_last_activity_seconds: 6
1424 description: List of service information
1426 $ref: '#/components/schemas/service_status'
1431 callback_url: callback_url
1432 service_id: service_id
1433 keep_alive_interval_seconds: 0
1434 time_since_last_activity_seconds: 6
1437 description: callback for notifying of RIC synchronization
1440 description: identity of the service
1442 keep_alive_interval_seconds:
1443 description: policy keep alive timeout
1446 time_since_last_activity_seconds:
1447 description: time since last invocation by the service
1451 service_registration_info:
1452 description: Information for one service
1455 description: Callback for notifying of Near-RT RIC state changes
1458 description: identity of the service
1460 keep_alive_interval_seconds:
1462 Keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.
1468 service_callback_info_v2:
1469 description: "Information transferred in Service callbacks, \nif a callback\
1470 \ URL was provided for a registered service\n"
1473 description: identity of a Near-RT RIC
1476 description: "values: \n AVAILABLE: the Near-RT RIC has become available\
1477 \ for A1 Policy management\n"
1485 policy_type_definition:
1486 description: Contains A1 Policy Type schema definition
1491 description: A1 Policy Type json schema. The schema is a json object following
1492 http://json-schema.org/draft-07/schema
1496 description: A list of policy identities
1503 description: Policy identities
1505 description: Policy identities
1510 description: List of policy information
1514 policy_id: policy_id
1518 status_notification_uri: status_notification_uri
1519 policytype_id: policytype_id
1521 policy_id: policy_id
1525 status_notification_uri: status_notification_uri
1526 policytype_id: policytype_id
1529 description: List of policy information
1531 $ref: '#/components/schemas/policy_info'
1535 description: Status for one A1-P Policy
1537 last_modified: last_modified
1541 description: "timestamp, last modification time"
1544 description: the Policy status
1547 policy_authorization:
1548 description: Authorization request for A1 policy requests
1551 $ref: '#/components/schemas/input'
1559 description: Access type
1566 description: Authorization token
1569 description: A1 Policy Type identifier
1576 authorization_result:
1577 description: Result of authorization
1582 description: "If true, the access is granted"