Offered APIs

Introduction

The north-bound REST API of the A1 Policy Management Service provides convenient methods to handle A1 policies.

Overall architecture for O-RAN A1 Policy functions

This picture provides a overview of ONAP’s A1 Controller architecture, integration with other ONAP components and API resource/operation provided.

../_images/ONAP-A1ControllerArchitecture-Paris.png

API Table

API name

swagger-icon

yaml-icon

html-icon

New A1 Policy Management API: A1PolicyManagementService, ServiceRegistry, Configuration, NearRT-RIC Repository, and Health Check APIs (NBI)

link

link

A1 Policy Management API

Older Pre-Spec A1 Policy Management API: Older A1PolicyManagementService, ServiceRegistry, Configuration, NearRT-RIC Repository, Health Check APIs, and Admin/Actuator APIs (NBI)

link

link

Pre-Spec A1 Policy Management API

A1 ADAPTER API (Internal Only)

link

link

A1 ADAPTER API (Internal Only)

A1 Policy Management Service APIs

The New A1 Policy Management API includes the latest APIs (NBI) for: A1 Policy Management, Service Registry, Configuration, NearRT-RIC Repository, and Health Check.
This A1 Policy Management API is described in more detail in: A1 Policy Management API (html)
The Older Pre-Spec A1 Policy Management API includes older versions of the APIs for: A1 Policy Management, Service Registry, Configuration, NearRT-RIC Repository, Health Check, and Admin/Actuator functions.
These APIs may be deprecated in future versions.
This Older Pre-Spec A1 Policy Management API is described in more detail in: Pre-Spec A1 Policy Management API (html)

A1 ADAPTER API

The O-RAN A1 Adapter provides an internal RESTCONF API that is used by the A1 Policy Management Service when accessing the A1 Interface.
This API is useful for test and verification purposes but should not be used otherwise.
The A1 Adapter API is described in more detail in A1 ADAPTER API (html)