From: saul.gill Date: Thu, 20 Mar 2025 11:21:22 +0000 (+0000) Subject: Added JSON log streaming capability X-Git-Tag: 2.1.0~12 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=6c948b05d2865900f722ad3456094db80e49b60f;p=ccsdk%2Foran.git Added JSON log streaming capability - Added improvements to Open API yaml - Uplifted ccsdk parent references to 3.1.0 Issue-ID: CCSDK-4104 Change-Id: I082959c67e25c3516c68321bfaaa80313f332277 Signed-off-by: saul.gill --- diff --git a/a1-adapter/a1-adapter-api/feature/pom.xml b/a1-adapter/a1-adapter-api/feature/pom.xml index 9673de84..c49efa9e 100644 --- a/a1-adapter/a1-adapter-api/feature/pom.xml +++ b/a1-adapter/a1-adapter-api/feature/pom.xml @@ -27,7 +27,7 @@ org.onap.ccsdk.parent single-feature-parent - 3.0.1 + 3.1.0 diff --git a/a1-adapter/a1-adapter-api/installer/pom.xml b/a1-adapter/a1-adapter-api/installer/pom.xml index 6a79cf99..25a2e48f 100644 --- a/a1-adapter/a1-adapter-api/installer/pom.xml +++ b/a1-adapter/a1-adapter-api/installer/pom.xml @@ -27,7 +27,7 @@ org.onap.ccsdk.parent odlparent-lite - 3.0.1 + 3.1.0 diff --git a/a1-adapter/a1-adapter-api/model/pom.xml b/a1-adapter/a1-adapter-api/model/pom.xml index 6d8930ff..cd1c2729 100644 --- a/a1-adapter/a1-adapter-api/model/pom.xml +++ b/a1-adapter/a1-adapter-api/model/pom.xml @@ -27,7 +27,7 @@ org.onap.ccsdk.parent binding-parent - 3.0.1 + 3.1.0 diff --git a/a1-adapter/a1-adapter-api/pom.xml b/a1-adapter/a1-adapter-api/pom.xml index fc5989f8..98d54979 100644 --- a/a1-adapter/a1-adapter-api/pom.xml +++ b/a1-adapter/a1-adapter-api/pom.xml @@ -26,7 +26,7 @@ org.onap.ccsdk.parent odlparent-lite - 3.0.1 + 3.1.0 diff --git a/a1-adapter/a1-adapter-api/provider/pom.xml b/a1-adapter/a1-adapter-api/provider/pom.xml index 360c75ce..47ef37b6 100644 --- a/a1-adapter/a1-adapter-api/provider/pom.xml +++ b/a1-adapter/a1-adapter-api/provider/pom.xml @@ -27,7 +27,7 @@ org.onap.ccsdk.parent binding-parent - 3.0.1 + 3.1.0 diff --git a/a1-adapter/features/a1-adapter-northbound/pom.xml b/a1-adapter/features/a1-adapter-northbound/pom.xml index 02e506a4..d190c90b 100644 --- a/a1-adapter/features/a1-adapter-northbound/pom.xml +++ b/a1-adapter/features/a1-adapter-northbound/pom.xml @@ -26,7 +26,7 @@ org.onap.ccsdk.parent single-feature-parent - 3.0.1 + 3.1.0 diff --git a/a1-adapter/features/installer/pom.xml b/a1-adapter/features/installer/pom.xml index c1ab0d45..5ae2c0ed 100644 --- a/a1-adapter/features/installer/pom.xml +++ b/a1-adapter/features/installer/pom.xml @@ -27,7 +27,7 @@ org.onap.ccsdk.parent odlparent-lite - 3.0.1 + 3.1.0 diff --git a/a1-adapter/features/pom.xml b/a1-adapter/features/pom.xml index d3ab5cba..689a17ff 100644 --- a/a1-adapter/features/pom.xml +++ b/a1-adapter/features/pom.xml @@ -27,7 +27,7 @@ org.onap.ccsdk.parent odlparent-lite - 3.0.1 + 3.1.0 diff --git a/a1-adapter/pom.xml b/a1-adapter/pom.xml index 2f354aaa..e074de98 100644 --- a/a1-adapter/pom.xml +++ b/a1-adapter/pom.xml @@ -27,7 +27,7 @@ org.onap.ccsdk.parent odlparent-lite - 3.0.1 + 3.1.0 diff --git a/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html b/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html index 31499b8f..61b74d18 100644 --- a/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html +++ b/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html @@ -1212,7 +1212,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

+

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are deleted. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

diff --git a/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html b/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html index 4327613c..cfc8c659 100644 --- a/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html +++ b/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html @@ -1243,7 +1243,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

+

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are deleted. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

@@ -14308,7 +14308,7 @@ The identity of the registered service

-

A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered)

+

A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.


/services/{serviceId}/keepalive
diff --git a/a1-policy-management/api/offeredapis/swagger/custom/a1pms-api-custom-v3.json b/a1-policy-management/api/offeredapis/swagger/custom/a1pms-api-custom-v3.json index 07f2ac42..7b221983 100644 --- a/a1-policy-management/api/offeredapis/swagger/custom/a1pms-api-custom-v3.json +++ b/a1-policy-management/api/offeredapis/swagger/custom/a1pms-api-custom-v3.json @@ -5,7 +5,7 @@ "email" : "discuss-list@onap.com", "url" : "https://www.onap.org/" }, - "description" : "

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

", + "description" : "

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are deleted. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

", "license" : { "name" : "Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License.", "url" : "http://www.apache.org/licenses/LICENSE-2.0" @@ -35,7 +35,7 @@ "description" : "API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "API used to manage registered service, and control their keep-alive status via heart-beat messages.\n", + "description" : "API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { "description" : "API used to get the health status and statistics of this service.\n", @@ -1511,7 +1511,7 @@ }, "/services/{serviceId}/keepalive" : { "put" : { - "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered)", + "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.", "operationId" : "keepAliveService", "parameters" : [ { "explode" : false, @@ -1791,13 +1791,13 @@ }, "StatusInfo" : { "value" : { - "status" : "status" + "status" : "success" } }, "RicInfo" : { "value" : { "ricId" : "ricId1", - "managedElementIds" : [ "managedElementId1", "managedElementId2" ], + "managedElementIds" : [ "Note #1", "Athlone small cells", "Some optional string" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] } @@ -1806,12 +1806,12 @@ "value" : { "rics" : [ { "ricId" : "ricId1", - "managedElementIds" : [ "managedElementId1", "managedElementId2" ], + "managedElementIds" : [ "Note #1", "Athlone small cells", "Fake Cells" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] }, { "ricId" : "ricId2", - "managedElementIds" : [ "managedElementId3", "managedElementId4" ], + "managedElementIds" : [ "My test element", "Another test element" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId3", "policyTypeId4" ] } ] diff --git a/a1-policy-management/api/offeredapis/swagger/pms-api-v3.json b/a1-policy-management/api/offeredapis/swagger/pms-api-v3.json index 07f2ac42..7b221983 100644 --- a/a1-policy-management/api/offeredapis/swagger/pms-api-v3.json +++ b/a1-policy-management/api/offeredapis/swagger/pms-api-v3.json @@ -5,7 +5,7 @@ "email" : "discuss-list@onap.com", "url" : "https://www.onap.org/" }, - "description" : "

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

", + "description" : "

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are deleted. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

", "license" : { "name" : "Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License.", "url" : "http://www.apache.org/licenses/LICENSE-2.0" @@ -35,7 +35,7 @@ "description" : "API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "API used to manage registered service, and control their keep-alive status via heart-beat messages.\n", + "description" : "API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { "description" : "API used to get the health status and statistics of this service.\n", @@ -1511,7 +1511,7 @@ }, "/services/{serviceId}/keepalive" : { "put" : { - "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered)", + "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.", "operationId" : "keepAliveService", "parameters" : [ { "explode" : false, @@ -1791,13 +1791,13 @@ }, "StatusInfo" : { "value" : { - "status" : "status" + "status" : "success" } }, "RicInfo" : { "value" : { "ricId" : "ricId1", - "managedElementIds" : [ "managedElementId1", "managedElementId2" ], + "managedElementIds" : [ "Note #1", "Athlone small cells", "Some optional string" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] } @@ -1806,12 +1806,12 @@ "value" : { "rics" : [ { "ricId" : "ricId1", - "managedElementIds" : [ "managedElementId1", "managedElementId2" ], + "managedElementIds" : [ "Note #1", "Athlone small cells", "Fake Cells" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] }, { "ricId" : "ricId2", - "managedElementIds" : [ "managedElementId3", "managedElementId4" ], + "managedElementIds" : [ "My test element", "Another test element" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId3", "policyTypeId4" ] } ] diff --git a/a1-policy-management/api/offeredapis/swagger/pms-api-v3.yaml b/a1-policy-management/api/offeredapis/swagger/pms-api-v3.yaml index 5ee5cb9d..0865ff2b 100644 --- a/a1-policy-management/api/offeredapis/swagger/pms-api-v3.yaml +++ b/a1-policy-management/api/offeredapis/swagger/pms-api-v3.yaml @@ -45,10 +45,10 @@ info: \ is targeted towards one Near-RT RIC.

Health Check

API used for supervision\ \ of the A1 Policy Management Service.

Service Registry and Supervision

\ \

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner.\ - \ If the owner service is registered, then the service can be monitored by a heart-beat supervision\ - \ mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note \ - \ that services do not need to be registered to create A1 Policies, but unregistered services are not \ - \ supervised. This is a feature that is optional to use.

" + \ If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision\ + \ mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are \ + \ deleted. Note that services do not need to be registered to create A1 Policies, but unregistered \ + \ services are not supervised. This is a feature that is optional to use.

" license: name: Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License. url: http://www.apache.org/licenses/LICENSE-2.0 @@ -678,8 +678,10 @@ paths: description: A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered - and all its A1 policies wil be removed. This operation is only intended for registered - services. (This timeout can be set or disabled when each service is initially registered) + and all its A1 policies wil be removed and the service is deleted. + This operation is only intended for registered services. (This timeout can be set or disabled when + each service is initially registered). Unregistered services do not need to invoke this operation, + since the optional keep-alive monitoring feature can only be enabled for registered services. summary: Heartbeat message from a service (keepAliveService) tags: - Service Registry and Supervision @@ -869,8 +871,9 @@ components: value: ricId: ricId1 managedElementIds: - - managedElementId1 - - managedElementId2 + - "Note #1" + - "Athlone small cells" + - "Some optional string" state: UNAVAILABLE policyTypeIds: - policyTypeId1 @@ -880,16 +883,17 @@ components: rics: - ricId: ricId1 managedElementIds: - - managedElementId1 - - managedElementId2 + - "Note #1" + - "Athlone small cells" + - "Fake Cells" state: UNAVAILABLE policyTypeIds: - policyTypeId1 - policyTypeId2 - ricId: ricId2 managedElementIds: - - managedElementId3 - - managedElementId4 + - "My test element" + - "Another test element" state: UNAVAILABLE policyTypeIds: - policyTypeId3 diff --git a/a1-policy-management/api/offeredapis/swagger/pms-api.json b/a1-policy-management/api/offeredapis/swagger/pms-api.json index 8434ba94..26fc1220 100644 --- a/a1-policy-management/api/offeredapis/swagger/pms-api.json +++ b/a1-policy-management/api/offeredapis/swagger/pms-api.json @@ -26,7 +26,7 @@ "description" : "Older API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "Older API used to manage registered service, and control their keep-alive status via heart-beat messages.\n", + "description" : "Older API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { "description" : "API used to get the health status and statistics of this service\n", diff --git a/a1-policy-management/pom.xml b/a1-policy-management/pom.xml index 22142918..93c32377 100644 --- a/a1-policy-management/pom.xml +++ b/a1-policy-management/pom.xml @@ -26,7 +26,7 @@ org.onap.ccsdk.parent spring-boot-34-starter-parent - 3.1.0-SNAPSHOT + 3.1.0 org.onap.ccsdk.oran @@ -63,6 +63,7 @@ 1.41.0 2.7.0-alpha false + 8.0 @@ -298,6 +299,11 @@ spring-boot-actuator-autoconfigure ${spring.boot.version} + + net.logstash.logback + logstash-logback-encoder + ${version.logback} + diff --git a/a1-policy-management/src/main/resources/logback-json.xml b/a1-policy-management/src/main/resources/logback-json.xml new file mode 100644 index 00000000..3c22aeac --- /dev/null +++ b/a1-policy-management/src/main/resources/logback-json.xml @@ -0,0 +1,70 @@ + + + + + + + + version + 1.2.0 + + + timestamp + yyyy-MM-dd'T'HH:mm:ss.SSSZ + + + true + + { + "service_id": "${SERVICE_ID:-a1pms}", + "message": "%msg", + "facility": "%X{facility}", + "subject": "%X{subject}", + "extra_data": { + "logger": "%logger", + "thread_info": { + "thread_name": "%thread" + }, + "dst": { + "trace_id": "%mdc{traceId}" + }, + "exception": { + "stack_trace": "%xEx" + } + }, + "metadata": { + "application_id": "${APP_ID:-a1pms}" + } + } + + + + + + + + + + + + + + diff --git a/a1-policy-management/src/main/resources/logback-plain.xml b/a1-policy-management/src/main/resources/logback-plain.xml index 0340cce8..014a983a 100644 --- a/a1-policy-management/src/main/resources/logback-plain.xml +++ b/a1-policy-management/src/main/resources/logback-plain.xml @@ -19,22 +19,17 @@ ~ --> - - - %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{55} - %replace(%X{facility}){'^(.+)$','facility=$1 | '} %replace(%X{subject}){'^(.+)$','subject=$1 | ' } %msg%n + + %d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} [%thread] %-5level %logger - %msg [facility=%X{facility}, subject=%X{subject}, traceId=%mdc{traceId}] %n%xEx + - - - - + + \ No newline at end of file diff --git a/a1-policy-management/src/main/resources/logback-stream.xml b/a1-policy-management/src/main/resources/logback-stream.xml new file mode 100644 index 00000000..9cfb863b --- /dev/null +++ b/a1-policy-management/src/main/resources/logback-stream.xml @@ -0,0 +1,80 @@ + + + + + localhost:5044 + + + + version + 1.2.0 + + + timestamp + yyyy-MM-dd'T'HH:mm:ss.SSSZ + + + true + + { + "service_id": "${SERVICE_ID:-a1pms}", + "message": "%msg", + "facility": "%X{facility}", + "subject": "%X{subject}", + "extra_data": { + "logger": "%logger", + "thread_info": { + "thread_name": "%thread" + }, + "dst": { + "trace_id": "%mdc{traceId}" + }, + "exception": { + "stack_trace": "%xEx" + } + }, + "metadata": { + "application_id": "${APP_ID:-a1pms}" + } + } + + + + + + + + + + + %d{yyyy-MM-dd'T'HH:mm:ss.SSSZ} [%thread] %-5level %logger - %msg [facility=%X{facility}, subject=%X{subject}, traceId=%mdc{traceId}] %n%xEx + + + + + + + + + + + + diff --git a/docs/offeredapis/application_configuration_schema.json b/docs/offeredapis/application_configuration_schema.json new file mode 100644 index 00000000..3186dae6 --- /dev/null +++ b/docs/offeredapis/application_configuration_schema.json @@ -0,0 +1,91 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "config": { + "type": "object", + "properties": { + "//description": { + "type": "string" + }, + "description": { + "type": "string" + }, + "controller": { + "type": "array", + "items": [ + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "baseUrl": { + "type": "string" + }, + "userName": { + "type": "string" + }, + "password": { + "type": "string" + } + }, + "required": [ + "name", + "baseUrl", + "userName", + "password" + ], + "additionalProperties": false + } + ] + }, + "ric": { + "type": "array", + "items": [ + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "baseUrl": { + "type": "string" + }, + "controller": { + "type": "string" + }, + "customAdapterClass": { + "type": "string" + }, + "managedElementIds": { + "type": "array", + "items": [ + { + "type": "string" + }, + { + "type": "string" + } + ] + } + }, + "required": [ + "name", + "baseUrl" + ], + "additionalProperties": false + } + ] + } + }, + "required": [ + "ric" + ], + "additionalProperties": true + } + }, + "required": [ + "config" + ] +} diff --git a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html index 31499b8f..61b74d18 100644 --- a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html +++ b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html @@ -1212,7 +1212,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

+

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are deleted. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

diff --git a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html index 4327613c..cfc8c659 100644 --- a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html +++ b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html @@ -1243,7 +1243,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

+

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are deleted. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

@@ -14308,7 +14308,7 @@ The identity of the registered service

-

A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered)

+

A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.


/services/{serviceId}/keepalive
diff --git a/docs/offeredapis/swagger/custom/a1pms-api-custom-v3.json b/docs/offeredapis/swagger/custom/a1pms-api-custom-v3.json index 07f2ac42..7b221983 100644 --- a/docs/offeredapis/swagger/custom/a1pms-api-custom-v3.json +++ b/docs/offeredapis/swagger/custom/a1pms-api-custom-v3.json @@ -5,7 +5,7 @@ "email" : "discuss-list@onap.com", "url" : "https://www.onap.org/" }, - "description" : "

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

", + "description" : "

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are deleted. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

", "license" : { "name" : "Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License.", "url" : "http://www.apache.org/licenses/LICENSE-2.0" @@ -35,7 +35,7 @@ "description" : "API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "API used to manage registered service, and control their keep-alive status via heart-beat messages.\n", + "description" : "API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { "description" : "API used to get the health status and statistics of this service.\n", @@ -1511,7 +1511,7 @@ }, "/services/{serviceId}/keepalive" : { "put" : { - "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered)", + "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.", "operationId" : "keepAliveService", "parameters" : [ { "explode" : false, @@ -1791,13 +1791,13 @@ }, "StatusInfo" : { "value" : { - "status" : "status" + "status" : "success" } }, "RicInfo" : { "value" : { "ricId" : "ricId1", - "managedElementIds" : [ "managedElementId1", "managedElementId2" ], + "managedElementIds" : [ "Note #1", "Athlone small cells", "Some optional string" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] } @@ -1806,12 +1806,12 @@ "value" : { "rics" : [ { "ricId" : "ricId1", - "managedElementIds" : [ "managedElementId1", "managedElementId2" ], + "managedElementIds" : [ "Note #1", "Athlone small cells", "Fake Cells" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] }, { "ricId" : "ricId2", - "managedElementIds" : [ "managedElementId3", "managedElementId4" ], + "managedElementIds" : [ "My test element", "Another test element" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId3", "policyTypeId4" ] } ] diff --git a/docs/offeredapis/swagger/pms-api-v3.json b/docs/offeredapis/swagger/pms-api-v3.json index 07f2ac42..7b221983 100644 --- a/docs/offeredapis/swagger/pms-api-v3.json +++ b/docs/offeredapis/swagger/pms-api-v3.json @@ -5,7 +5,7 @@ "email" : "discuss-list@onap.com", "url" : "https://www.onap.org/" }, - "description" : "

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

", + "description" : "

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies.
This document describes the latest API set to perform tasks for:

  • A1 Policy creation, modification and deletion.
  • Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs
  • Maintaining a view of each Near-RT RIC's supported A1 Policy Types
  • Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.

APIs provided or defined by the service

Note: parts of this API are strongly based on extracts of the O-RAN Alliance R1 Interface specification for A1 Policy Management, and those parts should be considered '© O-RAN ALLIANCE - All rights reserved.'

A1 Policy Management

This is the latest API for managing A1 Policies. This API is partially compliant with O-RAN Alliance R1 Interface specifications for A1 Policy Management:

  • A1 Policy retrieval, creation, modification and deletion.
  • Retrieval of supported A1 Policy Types for a Near-RT RIC
  • Retrieval of status for existing A1 policies

Management of configuration

API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.

Service Callbacks

These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.

NearRT-RIC Repository (Older version)

This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.

Health Check

API used for supervision of the A1 Policy Management Service.

Service Registry and Supervision

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner. If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are deleted. Note that services do not need to be registered to create A1 Policies, but unregistered services are not supervised. This is a feature that is optional to use.

", "license" : { "name" : "Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License.", "url" : "http://www.apache.org/licenses/LICENSE-2.0" @@ -35,7 +35,7 @@ "description" : "API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "API used to manage registered service, and control their keep-alive status via heart-beat messages.\n", + "description" : "API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { "description" : "API used to get the health status and statistics of this service.\n", @@ -1511,7 +1511,7 @@ }, "/services/{serviceId}/keepalive" : { "put" : { - "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered)", + "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.", "operationId" : "keepAliveService", "parameters" : [ { "explode" : false, @@ -1791,13 +1791,13 @@ }, "StatusInfo" : { "value" : { - "status" : "status" + "status" : "success" } }, "RicInfo" : { "value" : { "ricId" : "ricId1", - "managedElementIds" : [ "managedElementId1", "managedElementId2" ], + "managedElementIds" : [ "Note #1", "Athlone small cells", "Some optional string" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] } @@ -1806,12 +1806,12 @@ "value" : { "rics" : [ { "ricId" : "ricId1", - "managedElementIds" : [ "managedElementId1", "managedElementId2" ], + "managedElementIds" : [ "Note #1", "Athlone small cells", "Fake Cells" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] }, { "ricId" : "ricId2", - "managedElementIds" : [ "managedElementId3", "managedElementId4" ], + "managedElementIds" : [ "My test element", "Another test element" ], "state" : "UNAVAILABLE", "policyTypeIds" : [ "policyTypeId3", "policyTypeId4" ] } ] diff --git a/docs/offeredapis/swagger/pms-api-v3.yaml b/docs/offeredapis/swagger/pms-api-v3.yaml index 9570cd46..0865ff2b 100644 --- a/docs/offeredapis/swagger/pms-api-v3.yaml +++ b/docs/offeredapis/swagger/pms-api-v3.yaml @@ -45,10 +45,10 @@ info: \ is targeted towards one Near-RT RIC.

Health Check

API used for supervision\ \ of the A1 Policy Management Service.

Service Registry and Supervision

\ \

API used for registering services/clients/rApps. Each A1 Policy can be tagged with an owner.\ - \ If the owner service is registered, then the service can be monitored by a heart-beat supervision\ - \ mechanism, and if the registered service becomes unavailable, then its A1 Policies are removed. Note \ - \ that services do not need to be registered to create A1 Policies, but unregistered services are not \ - \ supervised. This is a feature that is optional to use.

" + \ If the owner service is registered, then the service can be optionally monitored by a heart-beat supervision\ + \ mechanism, and if the registered service becomes unavailable, then it is removed and all its A1 Policies are \ + \ deleted. Note that services do not need to be registered to create A1 Policies, but unregistered \ + \ services are not supervised. This is a feature that is optional to use.

" license: name: Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License. url: http://www.apache.org/licenses/LICENSE-2.0 @@ -74,7 +74,7 @@ tags: API used to get information about registered Near-RT RICs. - name: Service Registry and Supervision description: > - API used to manage registered service, and control their keep-alive status via heart-beat messages. + API used to manage registered services, and control their keep-alive status via heart-beat messages. - name: Health Check description: > API used to get the health status and statistics of this service. @@ -678,8 +678,10 @@ paths: description: A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered - and all its A1 policies wil be removed. This operation is only intended for registered - services. (This timeout can be set or disabled when each service is initially registered) + and all its A1 policies wil be removed and the service is deleted. + This operation is only intended for registered services. (This timeout can be set or disabled when + each service is initially registered). Unregistered services do not need to invoke this operation, + since the optional keep-alive monitoring feature can only be enabled for registered services. summary: Heartbeat message from a service (keepAliveService) tags: - Service Registry and Supervision @@ -864,13 +866,14 @@ components: timeSinceLastActivitySeconds: 401 StatusInfo: value: - status: status + status: success RicInfo: value: ricId: ricId1 managedElementIds: - - managedElementId1 - - managedElementId2 + - "Note #1" + - "Athlone small cells" + - "Some optional string" state: UNAVAILABLE policyTypeIds: - policyTypeId1 @@ -880,16 +883,17 @@ components: rics: - ricId: ricId1 managedElementIds: - - managedElementId1 - - managedElementId2 + - "Note #1" + - "Athlone small cells" + - "Fake Cells" state: UNAVAILABLE policyTypeIds: - policyTypeId1 - policyTypeId2 - ricId: ricId2 managedElementIds: - - managedElementId3 - - managedElementId4 + - "My test element" + - "Another test element" state: UNAVAILABLE policyTypeIds: - policyTypeId3 diff --git a/docs/offeredapis/swagger/pms-api.json b/docs/offeredapis/swagger/pms-api.json index 8434ba94..26fc1220 100644 --- a/docs/offeredapis/swagger/pms-api.json +++ b/docs/offeredapis/swagger/pms-api.json @@ -26,7 +26,7 @@ "description" : "Older API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "Older API used to manage registered service, and control their keep-alive status via heart-beat messages.\n", + "description" : "Older API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { "description" : "API used to get the health status and statistics of this service\n", diff --git a/docs/offeredapis/swagger/pms-api.yaml b/docs/offeredapis/swagger/pms-api.yaml index c8c1b089..ea6d5d1e 100644 --- a/docs/offeredapis/swagger/pms-api.yaml +++ b/docs/offeredapis/swagger/pms-api.yaml @@ -69,7 +69,7 @@ tags: Older API used to get information about registered Near-RT RICs. - name: Service Registry and Supervision description: > - Older API used to manage registered service, and control their keep-alive status via heart-beat messages. + Older API used to manage registered services, and control their keep-alive status via heart-beat messages. - name: Health Check description: > API used to get the health status and statistics of this service diff --git a/pom.xml b/pom.xml index 367330f0..96c19553 100644 --- a/pom.xml +++ b/pom.xml @@ -27,7 +27,7 @@ org.onap.ccsdk.parent odlparent-lite - 3.0.1 + 3.1.0