From c5351b0124f39d50476d09cf802588541342a68c Mon Sep 17 00:00:00 2001 From: JohnKeeney Date: Fri, 4 Jul 2025 14:31:40 +0100 Subject: [PATCH] Trigger RTD docs for l-release & Roll version for l-release branch Issue-ID: NONRTRIC-1072 Change-Id: I676e4d88d953994e1c05e7cb413a97885cc8e579 Signed-off-by: JohnKeeney --- api/a1pms-api-v3.json | 2 +- api/pms-api-v3.json | 2 +- api/pms-api-v3.yaml | 57 +++++++++++----------- api/pms-api.json | 2 +- api/pms-api.yaml | 57 +++++++++++----------- api/pms-api/index.html | 2 +- api/pms-api/v3/custom/index.html | 2 +- api/pms-api/v3/index.html | 2 +- .../openapitoolgen/offeredapis/pms-api/index.html | 2 +- .../offeredapis/pms-api/v3/custom/index.html | 2 +- .../offeredapis/pms-api/v3/index.html | 2 +- docs/offeredapis/swagger/a1pms-api-v3.json | 2 +- docs/offeredapis/swagger/pms-api-v3.json | 2 +- docs/offeredapis/swagger/pms-api-v3.yaml | 57 +++++++++++----------- docs/offeredapis/swagger/pms-api.json | 2 +- docs/offeredapis/swagger/pms-api.yaml | 57 +++++++++++----------- docs/release-notes.rst | 6 +-- oas-info.yaml | 8 +-- pom.xml | 2 +- 19 files changed, 132 insertions(+), 136 deletions(-) diff --git a/api/a1pms-api-v3.json b/api/a1pms-api-v3.json index 113df5c..ac4b257 100644 --- a/api/a1pms-api-v3.json +++ b/api/a1pms-api-v3.json @@ -5,7 +5,7 @@ "email" : "discuss@lists.o-ran-sc.org", "url" : "https://o-ran-sc.org//" }, - "description" : "

General

The ORAN SC 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.

", + "description" : "

General

The ORAN SC 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 'Copyright (C) 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" diff --git a/api/pms-api-v3.json b/api/pms-api-v3.json index 113df5c..ac4b257 100644 --- a/api/pms-api-v3.json +++ b/api/pms-api-v3.json @@ -5,7 +5,7 @@ "email" : "discuss@lists.o-ran-sc.org", "url" : "https://o-ran-sc.org//" }, - "description" : "

General

The ORAN SC 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.

", + "description" : "

General

The ORAN SC 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 'Copyright (C) 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" diff --git a/api/pms-api-v3.yaml b/api/pms-api-v3.yaml index ea2b24a..0bce0f1 100644 --- a/api/pms-api-v3.yaml +++ b/api/pms-api-v3.yaml @@ -22,35 +22,34 @@ info: contact: email: discuss@lists.o-ran-sc.org url: https://o-ran-sc.org// - description: "

General

The ORAN SC 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 '\xC2\xA9 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.

" + description: '

General

The ORAN SC 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 ''Copyright + (C) 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. diff --git a/api/pms-api.json b/api/pms-api.json index b0c612a..e939eff 100644 --- a/api/pms-api.json +++ b/api/pms-api.json @@ -5,7 +5,7 @@ "email" : "discuss@lists.o-ran-sc.org", "url" : "https://o-ran-sc.org//" }, - "description" : "

General

The ORAN SC 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.

", + "description" : "

General

The ORAN SC 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 'Copyright (C) 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" diff --git a/api/pms-api.yaml b/api/pms-api.yaml index 1905e49..95c51dc 100644 --- a/api/pms-api.yaml +++ b/api/pms-api.yaml @@ -22,35 +22,34 @@ info: contact: email: discuss@lists.o-ran-sc.org url: https://o-ran-sc.org// - description: "

General

The ORAN SC 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 '\xC2\xA9 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.

" + description: '

General

The ORAN SC 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 ''Copyright + (C) 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. diff --git a/api/pms-api/index.html b/api/pms-api/index.html index abc2a4f..74dcfa5 100644 --- a/api/pms-api/index.html +++ b/api/pms-api/index.html @@ -1334,7 +1334,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ORAN SC 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.

+

General

The ORAN SC 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 'Copyright (C) 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/api/pms-api/v3/custom/index.html b/api/pms-api/v3/custom/index.html index 618a540..29a9027 100644 --- a/api/pms-api/v3/custom/index.html +++ b/api/pms-api/v3/custom/index.html @@ -1279,7 +1279,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ORAN SC 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.

+

General

The ORAN SC 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 'Copyright (C) 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/api/pms-api/v3/index.html b/api/pms-api/v3/index.html index aafe820..dc8a1fc 100644 --- a/api/pms-api/v3/index.html +++ b/api/pms-api/v3/index.html @@ -1310,7 +1310,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ORAN SC 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.

+

General

The ORAN SC 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 'Copyright (C) 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/index.html b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html index abc2a4f..74dcfa5 100644 --- a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html +++ b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/index.html @@ -1334,7 +1334,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ORAN SC 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.

+

General

The ORAN SC 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 'Copyright (C) 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/custom/index.html b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html index 618a540..29a9027 100644 --- a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html +++ b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html @@ -1279,7 +1279,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ORAN SC 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.

+

General

The ORAN SC 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 'Copyright (C) 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 aafe820..dc8a1fc 100644 --- a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html +++ b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html @@ -1310,7 +1310,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ORAN SC 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.

+

General

The ORAN SC 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 'Copyright (C) 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/swagger/a1pms-api-v3.json b/docs/offeredapis/swagger/a1pms-api-v3.json index 113df5c..ac4b257 100644 --- a/docs/offeredapis/swagger/a1pms-api-v3.json +++ b/docs/offeredapis/swagger/a1pms-api-v3.json @@ -5,7 +5,7 @@ "email" : "discuss@lists.o-ran-sc.org", "url" : "https://o-ran-sc.org//" }, - "description" : "

General

The ORAN SC 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.

", + "description" : "

General

The ORAN SC 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 'Copyright (C) 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" diff --git a/docs/offeredapis/swagger/pms-api-v3.json b/docs/offeredapis/swagger/pms-api-v3.json index 113df5c..ac4b257 100644 --- a/docs/offeredapis/swagger/pms-api-v3.json +++ b/docs/offeredapis/swagger/pms-api-v3.json @@ -5,7 +5,7 @@ "email" : "discuss@lists.o-ran-sc.org", "url" : "https://o-ran-sc.org//" }, - "description" : "

General

The ORAN SC 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.

", + "description" : "

General

The ORAN SC 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 'Copyright (C) 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" diff --git a/docs/offeredapis/swagger/pms-api-v3.yaml b/docs/offeredapis/swagger/pms-api-v3.yaml index ea2b24a..0bce0f1 100644 --- a/docs/offeredapis/swagger/pms-api-v3.yaml +++ b/docs/offeredapis/swagger/pms-api-v3.yaml @@ -22,35 +22,34 @@ info: contact: email: discuss@lists.o-ran-sc.org url: https://o-ran-sc.org// - description: "

General

The ORAN SC 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 '\xC2\xA9 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.

" + description: '

General

The ORAN SC 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 ''Copyright + (C) 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. diff --git a/docs/offeredapis/swagger/pms-api.json b/docs/offeredapis/swagger/pms-api.json index b0c612a..e939eff 100644 --- a/docs/offeredapis/swagger/pms-api.json +++ b/docs/offeredapis/swagger/pms-api.json @@ -5,7 +5,7 @@ "email" : "discuss@lists.o-ran-sc.org", "url" : "https://o-ran-sc.org//" }, - "description" : "

General

The ORAN SC 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.

", + "description" : "

General

The ORAN SC 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 'Copyright (C) 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" diff --git a/docs/offeredapis/swagger/pms-api.yaml b/docs/offeredapis/swagger/pms-api.yaml index 1905e49..95c51dc 100644 --- a/docs/offeredapis/swagger/pms-api.yaml +++ b/docs/offeredapis/swagger/pms-api.yaml @@ -22,35 +22,34 @@ info: contact: email: discuss@lists.o-ran-sc.org url: https://o-ran-sc.org// - description: "

General

The ORAN SC 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 '\xC2\xA9 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.

" + description: '

General

The ORAN SC 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 ''Copyright + (C) 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. diff --git a/docs/release-notes.rst b/docs/release-notes.rst index b3e03c8..3b9df38 100755 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -381,20 +381,20 @@ K Release | | | +-----------------------------+--------------------------------------------------------+ -K Release +L Release --------- +-----------------------------+--------------------------------------------------------+ | **Project** | Non-RT RIC A1 Policy Management Service | | | | +-----------------------------+--------------------------------------------------------+ | **Repo/commit-ID** | nonrtric/plt/a1policymanagementservice | -| | 281562aab3e1b4e4065863c769ce0a6522f5e5aa | +| | a76bacf1a59ecf115f1e4d74d69e0493d33ba3cc | | | | +-----------------------------+--------------------------------------------------------+ | **Release designation** | L | | | | +-----------------------------+--------------------------------------------------------+ -| **Release date** | 2024-12-19 | +| **Release date** | 2025-07-03 | | | | +-----------------------------+--------------------------------------------------------+ | **Purpose of the delivery** | nonrtric-plt-a1policymanagementservice:2.10.0 | diff --git a/oas-info.yaml b/oas-info.yaml index f8ff827..1bda53a 100644 --- a/oas-info.yaml +++ b/oas-info.yaml @@ -2,7 +2,7 @@ title: OSC - A1 Policy Management API version: 1.0.0 x-api-id: e9776a07-0813-4fca-9801-6f892f0a7c13 x-audience: external-public -description: "

General

The ORAN SC A1 Policy Management Service \ +description: "

General

The ORAN SC 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.'

\ + \ for A1 Policy Management, and those parts should be considered 'Copyright (C) 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: