From 0722f07df800ad4c400e5ce315de117ad7a22407 Mon Sep 17 00:00:00 2001 From: "aravind.est" Date: Wed, 26 Mar 2025 18:51:45 +0000 Subject: [PATCH] Update openapi & other files for improved docs (oslo) Update openapi & other files for improved docs (oslo) Issue-ID: CCSDK-4050 Change-Id: I132c9b464a64414126a62d4d3d6b0efa53469b68 Signed-off-by: aravind.est --- .gitignore | 1 + .readthedocs.yaml | 3 + README.md | 10 +- a1-policy-management/README.md | 4 +- .../offeredapis/pms-api/v3/custom/index.html | 341 +++++++------- .../offeredapis/pms-api/v3/index.html | 507 ++++++++++++--------- .../swagger/custom/a1pms-api-custom-v3.json | 246 +++++----- .../api/offeredapis/swagger/pms-api-v3.json | 246 +++++----- .../api/offeredapis/swagger/pms-api-v3.yaml | 503 +++++++++++--------- a1-policy-management/pom.xml | 6 + docs/conf.py | 3 + docs/guide/developer-guide.rst | 57 ++- docs/humaninterfaces/humaninterfaces.rst | 4 +- ...ONAP-A1ControllerArchitecture-NewDelhiOslo.png} | Bin docs/media/html_logo.png | Bin 0 -> 1816 bytes .../application_configuration_schema.json | 91 ++++ docs/offeredapis/offeredapis.rst | 47 +- .../offeredapis/pms-api/v3/custom/index.html | 341 +++++++------- .../offeredapis/pms-api/v3/index.html | 507 ++++++++++++--------- .../swagger/custom/a1pms-api-custom-v3.json | 246 +++++----- docs/offeredapis/swagger/pms-api-v3.json | 246 +++++----- docs/offeredapis/swagger/pms-api-v3.yaml | 503 +++++++++++--------- 22 files changed, 2201 insertions(+), 1711 deletions(-) rename docs/media/{ONAP-A1ControllerArchitecture-NewDelhi.png => ONAP-A1ControllerArchitecture-NewDelhiOslo.png} (100%) create mode 100644 docs/media/html_logo.png create mode 100644 docs/offeredapis/application_configuration_schema.json diff --git a/.gitignore b/.gitignore index 0f5d71ca..cf9dd09e 100644 --- a/.gitignore +++ b/.gitignore @@ -45,3 +45,4 @@ _build/ docs/offeredapis/**/README.md a1-policy-management/api/**/README.md a1-policy-management/api/**/.openapi-generator** +a1-policy-management/custom/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 62a44d85..676a4115 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -31,6 +31,9 @@ build: post_build: - mkdir -p ${READTHEDOCS_OUTPUT}html/openapi - cp -v -r docs/offeredapis/openapitoolgen/offeredapis/pms-api/* ${READTHEDOCS_OUTPUT}html/openapi + - cp -v -r docs/offeredapis/swagger/*.json ${READTHEDOCS_OUTPUT}html/openapi + - cp -v -r docs/offeredapis/swagger/*.yaml ${READTHEDOCS_OUTPUT}html/openapi + - cp -v -r docs/offeredapis/*.json ${READTHEDOCS_OUTPUT}html/openapi python: install: diff --git a/README.md b/README.md index 9831f78b..c57d837c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ## General -This source repository contains the code for the ORAN A1 related components. +This source repository contains the code for the O-RAN A1 related components. More information on the CCSDK A1 Policy Management Service can be found in the 'a1-policy-management' sub-directory. @@ -10,7 +10,7 @@ See also additional information at: - https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16444961/O-RAN+A1+Policies+in+ONAP - https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html -## Prerequisits +## Prerequisites To compile this code: @@ -21,7 +21,8 @@ To compile this code: ## License Copyright (C) 2022-2023 Nordix Foundation. All rights reserved. -Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved. + +Copyright (C) 2024-2025 OpenInfra Foundation Europe. All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -36,6 +37,3 @@ See the License for the specific language governing permissions and limitations under the License. SPDX-License-Identifier: Apache-2.0 - - - diff --git a/a1-policy-management/README.md b/a1-policy-management/README.md index 746eb650..e55395e7 100644 --- a/a1-policy-management/README.md +++ b/a1-policy-management/README.md @@ -36,7 +36,7 @@ The target paths in the container should not be modified. It is also possible to configure a HTTP(S) Proxy for southbound connections. This can be set in the application.yaml configuration file. Example docker run command for mounting new files (assuming they are located in the current directory): -docker run -p 8081:8081 -p 8433:8433 --name=PMS-container --network=oran-docker-net --volume "$PWD/new_keystore.jks:/opt/app/policy-agent/etc/cert/keystore.jks" --volume "$PWD/new_truststore.jks:/opt/app/policy-agent/etc/cert/truststore.jks" --volume "$PWD/new_application.yaml:/opt/app/policy-agent/config/application.yaml" onap/ccsdk-oran-a1policymanagementservice:1.0.0-SNAPSHOT +docker run -p 8081:8081 -p 8433:8433 --name=PMS-container --network=oran-docker-net --volume "$PWD/new_keystore.jks:/opt/app/policy-agent/etc/cert/keystore.jks" --volume "$PWD/new_truststore.jks:/opt/app/policy-agent/etc/cert/truststore.jks" --volume "$PWD/new_application.yaml:/opt/app/policy-agent/config/application.yaml" onap/ccsdk-oran-a1policymanagementservice:2.0.1-SNAPSHOT To run A1 Policy Management Service in a local environment: In the folder /opt/app/policy-agent/config/, create a soft link with below command, @@ -58,7 +58,7 @@ More information about the ONAP CCSDK A1 Policy Management Service can be found ONAP : ccsdk oran Copyright (C) 2019-2023 Nordix Foundation. All rights reserved. -Copyright (C) 2023-2024 OpenInfra Foundation Europe. All rights reserved. +Copyright (C) 2023-2025 OpenInfra Foundation Europe. All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 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 3b6a2658..932756a4 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 @@ -2,7 +2,7 @@ - A1 policy management API + ONAP CCSDK - A1 Policy Management API @@ -849,7 +849,7 @@ ul.nav-tabs { "properties" : { "detail" : { "type" : "string", - "description" : " A human-readable explanation specific to this occurrence of the problem.", + "description" : "A human-readable explanation specific to this occurrence of the problem.", "example" : "Policy type not found" }, "title" : { @@ -859,7 +859,7 @@ ul.nav-tabs { }, "status" : { "type" : "integer", - "description" : "The HTTP status code generated by the origin server for this occurrence of the problem. ", + "description" : "The HTTP status code generated by the origin server for this occurrence of the problem.\n", "format" : "int32", "example" : 404 } @@ -872,13 +872,13 @@ ul.nav-tabs { "properties" : { "policyId" : { "type" : "string", - "description" : "Identity of the policy" + "description" : "Identity of the A1 Policy Instance" }, "nearRtRicId" : { "$ref" : "#/components/schemas/NearRtRicId" } }, - "description" : "Near-RT RIC identifiers where A1 policies exist and for each Near-RT RIC identifier the policy identifiers of those policies that exist in that Near-RT RIC" + "description" : "Information tuple for a single A1 Policy Instance. Contains the A1 Policy Instance ID, and the ID of the Near-RT RIC where the policy is created.\n" }; defs["PolicyObjectInformation"] = { "required" : [ "nearRtRicId", "policyObject", "policyTypeId" ], @@ -887,23 +887,23 @@ ul.nav-tabs { "nearRtRicId" : { "type" : "string", "description" : "Identity of the target Near-RT RIC", - "example" : "Near-RT-Ric-ID" + "example" : "Near-RT-Ric-ID1" }, "transient" : { "type" : "boolean", - "description" : "If true, the policy is deleted at RIC restart. If false, its value is maintained by this service until explicitly deleted. Default false.", + "description" : "If true, the policy is automatically deleted if the targeted Near-RT RIC restarts or recovers. If false, the A1 Policy Instance remains, and is re-pushed to the targeted Near-RT RIC after a restart or recovery. If false, the A1 Policy Instance is maintained and must be deleted separately in the event of Near-RT RIC restart or recovery. Default is false.\n", "nullable" : false, "default" : false }, "policyId" : { "type" : "string", - "description" : "The identity of the Policy. If this value is present, it must be unique; otherwise, a random UUID is generated.", - "example" : "POLICY-ID" + "description" : "An optional identity to be used for the new A1 Policy Instance. If this value is present, it must be unique. If not present the new A1 Policy Instance will be assigned a newly generated unique ID, and the new ID can be extracted from the 'Location' header in the response.\n", + "example" : "POLICY-ID1" }, "serviceId" : { "type" : "string", - "description" : "the identity of the service owning the policy. This can be used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered.", - "example" : "rApp ID", + "description" : "the identity of the service owning the policy. This can be used to group the policies (it is possible to get all policies associated to a service). Note that the service does not need to be registered. If the service is registered, the newly created A1 Policy Instance will be subject to the same supervision rules as the the service's other policies.", + "example" : "rApp 1", "default" : "" }, "policyObject" : { @@ -911,11 +911,11 @@ ul.nav-tabs { }, "policyTypeId" : { "type" : "string", - "description" : "Identity of the policy type", - "example" : "ORAN_QOS_1.0.0(typeName_SemVersion)" + "description" : "A1 Policy Type identity", + "example" : "ORAN_QOS_1.0.0 '(typeName_SemVersion)'" } }, - "description" : "Information related to the creation of the policy" + "description" : "Information to create an A1 Policy Instance" }; defs["PolicyTypeInformation"] = { "required" : [ "nearRtRicId", "policyTypeId" ], @@ -923,16 +923,16 @@ ul.nav-tabs { "properties" : { "policyTypeId" : { "type" : "string", - "description" : "Identity of the policy type" + "description" : "A1 Policy Type identifier" }, "nearRtRicId" : { "$ref" : "#/components/schemas/NearRtRicId" } }, - "description" : "Available policy types and for each policy type identifier the Near-RT RIC identifiers of those Near-RT RICs that support the related A1 policy type", + "description" : "A data tuple to indicate that an identified A1 Policy Type is supported at an identified Near-RT RIC.", "example" : { "policyTypeId" : "STD_QOS2_0.1.0", - "nearRtRicId" : "ricsim_g3_2" + "nearRtRicId" : "ric_g3_2" } }; defs["PolicyTypeObject"] = { @@ -946,12 +946,12 @@ ul.nav-tabs { "$ref" : "#/components/schemas/StatusSchema" } }, - "description" : "policy type object as defined in A1TD", + "description" : "An A1 Policy Type, as defined in O-RAN Alliance A1TD", "example" : { "policySchema" : { "$schema" : "http://json-schema.org/draft-07/schema#", "title" : "STD_QOS_0_2_0", - "description" : "STD QOS policy type", + "description" : "Policy data schema for STD_QOS_0.2.0 A1 Policy Instances.", "type" : "object", "properties" : { "scope" : { @@ -982,7 +982,7 @@ ul.nav-tabs { "statusSchema" : { "$schema" : "http://json-schema.org/draft-07/schema#", "title" : "STD_QOS_0.2.0", - "description" : "STD QOS policy type status", + "description" : "Status schema for STD_QOS_0.2.0 A1 Policy Instances.", "type" : "object", "properties" : { "enforceStatus" : { @@ -1002,26 +1002,26 @@ ul.nav-tabs { "properties" : { "type" : { "type" : "string", - "description" : "a URI reference according to IETF RFC 3986 that identifies the problem type" + "description" : "URI reference according to IETF RFC 3986 that identifies the problem type" }, "title" : { "type" : "string", - "description" : "human-readable summary of the problem type" + "description" : "Human-readable summary of the problem type" }, "status" : { "type" : "number", - "description" : "the HTTP status code" + "description" : "HTTP status code" }, "detail" : { "type" : "string", - "description" : "human-readable explanation " + "description" : "Human-readable explanation" }, "instance" : { "type" : "string", "description" : "URI reference that identifies the specific occurrence of the problem" } }, - "description" : "A problem detail to carry details in an HTTP response according to RFC 7807" + "description" : "Object to carry details about a problem in an HTTP response according to IETF RFC 7807" }; defs["RicInfo"] = { "type" : "object", @@ -1032,23 +1032,23 @@ ul.nav-tabs { }, "managedElementIds" : { "type" : "array", - "description" : "O1 identities for managed entities", + "description" : "Identities for managed entities", "items" : { "type" : "string", - "description" : "O1 identities for managed entities" + "description" : "Identity for a managed entity" } }, "state" : { "type" : "string", - "description" : "Represents the states for a Near-RT RIC", + "description" : "Represents the state of a Near-RT RIC", "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ] }, "policyTypeIds" : { "type" : "array", - "description" : "supported policy types", + "description" : "Supported A1 Policy Types", "items" : { "type" : "string", - "description" : "supported policy types" + "description" : "Supported A1 Policy Type ID" } } }, @@ -1059,13 +1059,13 @@ ul.nav-tabs { "properties" : { "rics" : { "type" : "array", - "description" : "List of Near-RT RIC information", + "description" : "List of Near-RT RIC information objects", "items" : { "$ref" : "#/components/schemas/RicInfo" } } }, - "description" : "List of Near-RT RIC information" + "description" : "Collection of Near-RT RIC information objects" }; defs["ServiceCallbackInfo"] = { "required" : [ "eventType", "ricId" ], @@ -1077,11 +1077,11 @@ ul.nav-tabs { }, "eventType" : { "type" : "string", - "description" : "values:\nAVAILABLE: the Near-RT RIC has become available for A1 Policy management", + "description" : "values: \n AVAILABLE: the Near-RT RIC has become available for A1 Policy management\n", "enum" : [ "AVAILABLE" ] } }, - "description" : "Information transferred as in Service callbacks (callback_url)" + "description" : "Information transferred in Service callbacks, \nif a callback URL was provided for a registered service\n" }; defs["ServiceRegistrationInfo"] = { "required" : [ "serviceId" ], @@ -1089,7 +1089,7 @@ ul.nav-tabs { "properties" : { "callbackUrl" : { "type" : "string", - "description" : "callback for notifying of Near-RT RIC state changes" + "description" : "Callback URL for notifying of Near-RT RIC state changes" }, "serviceId" : { "type" : "string", @@ -1097,18 +1097,18 @@ ul.nav-tabs { }, "keepAliveIntervalSeconds" : { "type" : "integer", - "description" : "keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.", + "description" : "Keep alive interval for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.\n", "format" : "int64" } }, - "description" : "Information for one service" + "description" : "Information for a service to be registered" }; defs["ServiceStatus"] = { "type" : "object", "properties" : { "callbackUrl" : { "type" : "string", - "description" : "callback for notifying of RIC synchronization" + "description" : "Callback URL for notifying of Near-RT RIC state changes" }, "serviceId" : { "type" : "string", @@ -1116,22 +1116,23 @@ ul.nav-tabs { }, "keepAliveIntervalSeconds" : { "type" : "integer", - "description" : "policy keep alive timeout", + "description" : "Keep alive interval (seconds) for the service. This is used to enable optional heartbeat supervision of the service. If set (> 0) the registered service should regularly invoke a 'keepalive' REST call. When a service fails to invoke this 'keepalive' call within the configured time, the service is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means timeout supervision is disabled.\n", "format" : "int64" }, "timeSinceLastActivitySeconds" : { "type" : "integer", - "description" : "time since last invocation by the service", + "description" : "Time (seconds) since last recorded operation by the service", "format" : "int64" } - } + }, + "description" : "Information about a previously registered service" }; defs["ServiceStatusList"] = { "type" : "object", "properties" : { "serviceList" : { "type" : "array", - "description" : "List of service information", + "description" : "List of Service Status objects, describing a collection of registered services.", "items" : { "$ref" : "#/components/schemas/ServiceStatus" } @@ -1143,14 +1144,14 @@ ul.nav-tabs { "properties" : { "status" : { "type" : "string", - "description" : "status text" + "description" : "Status text" } } }; defs["NearRtRicId"] = { "type" : "string", - "description" : "Identity of the policy" + "description" : "Identity of the Near-RT RIC" }; var errs = {}; @@ -1201,7 +1202,7 @@ ul.nav-tabs {
-

A1 policy management API

+

ONAP CCSDK - A1 Policy Management API

@@ -1211,7 +1212,7 @@ ul.nav-tabs {
Version: 1.0.0
-

General

The ONAP CCSDK A1 Policy Management Service provides a REST API for managemecnt of A1 policies.
The main tasks of the service are:

  • 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 supported Near-RT RIC policy types
  • Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.

APIs provided or defined by the service

A1 Policy Management

This is an API for management of A1 Policies.

  • 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

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

Health Check

API used for supervision of the PMS component.

Service Registry and Supervision

API used for registering services that uses PMS. Each A1 policy is optionally owned by a service. PMS can supervise each registered service by a heart-beat supervision and will automatically remove policies for unavailable services. Note that a service does not need to be registered in order to create A1 Policies. This is a feature that is optional to use.

Authorization API

API used for access control of A1 Policy access. If configured, an external authorization provider is requested to grant access to the A1 Policy type.

+

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.

@@ -1223,12 +1224,12 @@ ul.nav-tabs {

createPolicy

-

+

Create an A1 Policy Instance (createPolicy)

-

To create A1 policies

+

Create an A1 Policy Instance


/policies
@@ -1258,12 +1259,12 @@ ul.nav-tabs { -H "Content-Type: application/json" \ "https://example.com/a1-policy-management/v1/policies" \ -d '{ - "policyId" : "POLICY-ID", - "nearRtRicId" : "Near-RT-Ric-ID", + "policyId" : "POLICY-ID1", + "nearRtRicId" : "Near-RT-Ric-ID1", "transient" : false, "policyObject" : "{}", - "serviceId" : "rApp ID", - "policyTypeId" : "ORAN_QOS_1.0.0(typeName_SemVersion)" + "serviceId" : "rApp 1", + "policyTypeId" : "ORAN_QOS_1.0.0 '(typeName_SemVersion)'" }' @@ -1341,6 +1342,7 @@ public class A1PolicyManagementApiExample { A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; PolicyObjectInformation *policyObjectInformation = ; // +// Create an A1 Policy Instance (createPolicy) [apiInstance createPolicyWith:policyObjectInformation completionHandler: ^(PolicyObjectInformation output, NSError* error) { if (output) { @@ -1354,10 +1356,10 @@ PolicyObjectInformation *policyObjectInformation = ; //
- 
var A1PolicyManagementApi = require('a1_policy_management_api');
+                              
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');
 
 // Create an instance of the API class
-var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
 var policyObjectInformation = ; // {PolicyObjectInformation} 
 
 var callback = function(error, data, response) {
@@ -1393,6 +1395,7 @@ namespace Example
             var policyObjectInformation = new PolicyObjectInformation(); // PolicyObjectInformation | 
 
             try {
+                // Create an A1 Policy Instance (createPolicy)
                 PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
                 Debug.WriteLine(result);
             } catch (Exception e) {
@@ -1451,6 +1454,7 @@ api_instance = openapi_client.A1PolicyManagementApi()
 policyObjectInformation =  # PolicyObjectInformation | 
 
 try:
+    # Create an A1 Policy Instance (createPolicy)
     api_response = api_instance.create_policy(policyObjectInformation)
     pprint(api_response)
 except ApiException as e:
@@ -1570,7 +1574,7 @@ $(document).ready(function() {
   "description" : "Created",
   "headers" : {
     "Location" : {
-      "description" : "Contains the URI of the newly created resource",
+      "description" : "Contains the URI of the newly created A1 Policy Instances. This URI includes the A1 Policy Instance ID for the newly  created policy instance.\n",
       "required" : true,
       "style" : "simple",
       "explode" : false,
@@ -1643,7 +1647,8 @@ $(document).ready(function() {
                                                   Location
                                                   String
                                                   
-                                                  Contains the URI of the newly created resource
+                                                  Contains the URI of the newly created A1 Policy Instances. This URI includes the A1 Policy Instance ID for the newly  created policy instance.
+
                                               
                                               
                                                   Content-Type
@@ -2378,7 +2383,7 @@ $(document).ready(function() {
       "example" : {
         "status" : 423,
         "title" : "Locked",
-        "detail" : "State is Locked in the  provided request."
+        "detail" : "State is Locked in the provided request."
       }
     }
   }
@@ -2730,12 +2735,12 @@ $(document).ready(function() {
                       

                         

                           
deletePolicy

-                          
Delete a policy

+                          
Delete an A1 Policy instance (deletePolicy)

                         

                         

                         

                         

-                        
Deleting the policy using policyId.

+                        
Delete an existing A1 Policy instance using its policy ID.

                         

                         

                         
/policies/{policyId}

@@ -2841,7 +2846,7 @@ A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
 String *policyId = policyId_example; //  (default to null)
 String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
 
-// Delete a policy
+// Delete an A1 Policy instance (deletePolicy)
 [apiInstance deletePolicyWith:policyId
     accept:accept
               completionHandler: ^(NSError* error) {
@@ -2853,10 +2858,10 @@ String *accept = application/json; // Specifies the content type that the client
- 
var A1PolicyManagementApi = require('a1_policy_management_api');
+                              
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');
 
 // Create an instance of the API class
-var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
 var policyId = policyId_example; // {String} 
 var opts = {
   'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
@@ -2896,7 +2901,7 @@ namespace Example
             var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
 
             try {
-                // Delete a policy
+                // Delete an A1 Policy instance (deletePolicy)
                 apiInstance.deletePolicy(policyId, accept);
             } catch (Exception e) {
                 Debug.Print("Exception when calling A1PolicyManagementApi.deletePolicy: " + e.Message );
@@ -2955,7 +2960,7 @@ policyId = policyId_example # String |  (default to null)
 accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
 
 try:
-    # Delete a policy
+    # Delete an A1 Policy instance (deletePolicy)
     api_instance.delete_policy(policyId, accept=accept)
 except ApiException as e:
     print("Exception when calling A1PolicyManagementApi->deletePolicy: %s\n" % e)

@@ -3604,7 +3609,7 @@ Specifies the content type that the client expects to receive in response to the
       "example" : {
         "status" : 423,
         "title" : "Locked",
-        "detail" : "State is Locked in the  provided request."
+        "detail" : "State is Locked in the provided request."
       }
     }
   }
@@ -3956,12 +3961,13 @@ Specifies the content type that the client expects to receive in response to the
                       

                         

                           
getAllPolicies

-                          
Query policy identities

+                          
Query for A1 Policy instances (getAllPolicies)

                         

                         

                         

                         

-                        
Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.

+                        
Returns a collection of A1 Policy Instance IDs for policies that match given search criteria.  If several query parameters are defined, the policies matching all conditions are returned.
+

                         

                         

                         
/policies

@@ -4005,10 +4011,10 @@ public class A1PolicyManagementApiExample {
 
         // Create an instance of the API class
         A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
-        String policyTypeId = policyTypeId_example; // String | Select policies of a given policy type identity.
-        String nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
-        String serviceId = serviceId_example; // String | Select policies owned by a given service.
-        String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
+        String policyTypeId = policyTypeId_example; // String | Select policies with a given A1 Policy Type ID.
+        String nearRtRicId = nearRtRicId_example; // String | Select policies for a given Near-RT RIC identity.
+        String serviceId = serviceId_example; // String | Select policies owned by a given service (registered or unregistered).
+        String typeName = typeName_example; // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
         String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
 
         try {
@@ -4028,10 +4034,10 @@ public class A1PolicyManagementApiExample {
 
 final api_instance = DefaultApi();
 
-final String policyTypeId = new String(); // String | Select policies of a given policy type identity.
-final String nearRtRicId = new String(); // String | Select policies of a given Near-RT RIC identity.
-final String serviceId = new String(); // String | Select policies owned by a given service.
-final String typeName = new String(); // String | Select policies of types with the given type name (type identity has the format )
+final String policyTypeId = new String(); // String | Select policies with a given A1 Policy Type ID.
+final String nearRtRicId = new String(); // String | Select policies for a given Near-RT RIC identity.
+final String serviceId = new String(); // String | Select policies owned by a given service (registered or unregistered).
+final String typeName = new String(); // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
 final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
 
 try {
@@ -4050,10 +4056,10 @@ try {
 public class A1PolicyManagementApiExample {
     public static void main(String[] args) {
         A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
-        String policyTypeId = policyTypeId_example; // String | Select policies of a given policy type identity.
-        String nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
-        String serviceId = serviceId_example; // String | Select policies owned by a given service.
-        String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
+        String policyTypeId = policyTypeId_example; // String | Select policies with a given A1 Policy Type ID.
+        String nearRtRicId = nearRtRicId_example; // String | Select policies for a given Near-RT RIC identity.
+        String serviceId = serviceId_example; // String | Select policies owned by a given service (registered or unregistered).
+        String typeName = typeName_example; // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
         String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
 
         try {
@@ -4075,13 +4081,13 @@ public class A1PolicyManagementApiExample {
 
 // Create an instance of the API class
 A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
-String *policyTypeId = policyTypeId_example; // Select policies of a given policy type identity. (optional) (default to null)
-String *nearRtRicId = nearRtRicId_example; // Select policies of a given Near-RT RIC identity. (optional) (default to null)
-String *serviceId = serviceId_example; // Select policies owned by a given service. (optional) (default to null)
-String *typeName = typeName_example; // Select policies of types with the given type name (type identity has the format ) (optional) (default to null)
+String *policyTypeId = policyTypeId_example; // Select policies with a given A1 Policy Type ID. (optional) (default to null)
+String *nearRtRicId = nearRtRicId_example; // Select policies for a given Near-RT RIC identity. (optional) (default to null)
+String *serviceId = serviceId_example; // Select policies owned by a given service (registered or unregistered). (optional) (default to null)
+String *typeName = typeName_example; // Select policies of a given A1 Policy Type name (type identity has the format 'typename_version'). (optional) (default to null)
 String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
 
-// Query policy identities
+// Query for A1 Policy instances (getAllPolicies)
 [apiInstance getAllPoliciesWith:policyTypeId
     nearRtRicId:nearRtRicId
     serviceId:serviceId
@@ -4099,15 +4105,15 @@ String *accept = application/json; // Specifies the content type that the client
- 
var A1PolicyManagementApi = require('a1_policy_management_api');
+                              
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');
 
 // Create an instance of the API class
-var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
 var opts = {
-  'policyTypeId': policyTypeId_example, // {String} Select policies of a given policy type identity.
-  'nearRtRicId': nearRtRicId_example, // {String} Select policies of a given Near-RT RIC identity.
-  'serviceId': serviceId_example, // {String} Select policies owned by a given service.
-  'typeName': typeName_example, // {String} Select policies of types with the given type name (type identity has the format )
+  'policyTypeId': policyTypeId_example, // {String} Select policies with a given A1 Policy Type ID.
+  'nearRtRicId': nearRtRicId_example, // {String} Select policies for a given Near-RT RIC identity.
+  'serviceId': serviceId_example, // {String} Select policies owned by a given service (registered or unregistered).
+  'typeName': typeName_example, // {String} Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
   'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
 };
 
@@ -4141,14 +4147,14 @@ namespace Example
 
             // Create an instance of the API class
             var apiInstance = new A1PolicyManagementApi();
-            var policyTypeId = policyTypeId_example;  // String | Select policies of a given policy type identity. (optional)  (default to null)
-            var nearRtRicId = nearRtRicId_example;  // String | Select policies of a given Near-RT RIC identity. (optional)  (default to null)
-            var serviceId = serviceId_example;  // String | Select policies owned by a given service. (optional)  (default to null)
-            var typeName = typeName_example;  // String | Select policies of types with the given type name (type identity has the format ) (optional)  (default to null)
+            var policyTypeId = policyTypeId_example;  // String | Select policies with a given A1 Policy Type ID. (optional)  (default to null)
+            var nearRtRicId = nearRtRicId_example;  // String | Select policies for a given Near-RT RIC identity. (optional)  (default to null)
+            var serviceId = serviceId_example;  // String | Select policies owned by a given service (registered or unregistered). (optional)  (default to null)
+            var typeName = typeName_example;  // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version'). (optional)  (default to null)
             var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
 
             try {
-                // Query policy identities
+                // Query for A1 Policy instances (getAllPolicies)
                 array[PolicyInformation] result = apiInstance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
                 Debug.WriteLine(result);
             } catch (Exception e) {
@@ -4166,10 +4172,10 @@ require_once(__DIR__ . '/vendor/autoload.php');
 
 // Create an instance of the API class
 $api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
-$policyTypeId = policyTypeId_example; // String | Select policies of a given policy type identity.
-$nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
-$serviceId = serviceId_example; // String | Select policies owned by a given service.
-$typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
+$policyTypeId = policyTypeId_example; // String | Select policies with a given A1 Policy Type ID.
+$nearRtRicId = nearRtRicId_example; // String | Select policies for a given Near-RT RIC identity.
+$serviceId = serviceId_example; // String | Select policies owned by a given service (registered or unregistered).
+$typeName = typeName_example; // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
 $accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
 
 try {
@@ -4188,10 +4194,10 @@ use WWW::OPenAPIClient::A1PolicyManagementApi;
 
 # Create an instance of the API class
 my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
-my $policyTypeId = policyTypeId_example; # String | Select policies of a given policy type identity.
-my $nearRtRicId = nearRtRicId_example; # String | Select policies of a given Near-RT RIC identity.
-my $serviceId = serviceId_example; # String | Select policies owned by a given service.
-my $typeName = typeName_example; # String | Select policies of types with the given type name (type identity has the format )
+my $policyTypeId = policyTypeId_example; # String | Select policies with a given A1 Policy Type ID.
+my $nearRtRicId = nearRtRicId_example; # String | Select policies for a given Near-RT RIC identity.
+my $serviceId = serviceId_example; # String | Select policies owned by a given service (registered or unregistered).
+my $typeName = typeName_example; # String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
 my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
 
 eval {
@@ -4212,14 +4218,14 @@ from pprint import pprint
 
 # Create an instance of the API class
 api_instance = openapi_client.A1PolicyManagementApi()
-policyTypeId = policyTypeId_example # String | Select policies of a given policy type identity. (optional) (default to null)
-nearRtRicId = nearRtRicId_example # String | Select policies of a given Near-RT RIC identity. (optional) (default to null)
-serviceId = serviceId_example # String | Select policies owned by a given service. (optional) (default to null)
-typeName = typeName_example # String | Select policies of types with the given type name (type identity has the format ) (optional) (default to null)
+policyTypeId = policyTypeId_example # String | Select policies with a given A1 Policy Type ID. (optional) (default to null)
+nearRtRicId = nearRtRicId_example # String | Select policies for a given Near-RT RIC identity. (optional) (default to null)
+serviceId = serviceId_example # String | Select policies owned by a given service (registered or unregistered). (optional) (default to null)
+typeName = typeName_example # String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version'). (optional) (default to null)
 accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
 
 try:
-    # Query policy identities
+    # Query for A1 Policy instances (getAllPolicies)
     api_response = api_instance.get_all_policies(policyTypeId=policyTypeId, nearRtRicId=nearRtRicId, serviceId=serviceId, typeName=typeName, accept=accept)
     pprint(api_response)
 except ApiException as e:
@@ -4301,7 +4307,7 @@ Specifies the content type that the client expects to receive in response to the
                 
 
                     

-Select policies of a given policy type identity.
+Select policies with a given A1 Policy Type ID.
@@ -4321,7 +4327,7 @@ Select policies of a given policy type identity.
-Select policies of a given Near-RT RIC identity. +Select policies for a given Near-RT RIC identity.
@@ -4341,7 +4347,7 @@ Select policies of a given Near-RT RIC identity.
-Select policies owned by a given service. +Select policies owned by a given service (registered or unregistered).
@@ -4361,7 +4367,7 @@ Select policies owned by a given service.
-Select policies of types with the given type name (type identity has the format <typename_version>) +Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
@@ -5142,12 +5148,12 @@ Select policies of types with the given type name (type identity has the format

getPolicy

-

+

Get an A1 Policy's policy data (getPolicy)

-

Returns a policy

+

Get an A1 Policy instance's policy data using its policy ID


/policies/{policyId}
@@ -5255,6 +5261,7 @@ A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *policyId = policyId_example; // (default to null) String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null) +// Get an A1 Policy's policy data (getPolicy) [apiInstance getPolicyWith:policyId accept:accept completionHandler: ^(Object output, NSError* error) { @@ -5269,10 +5276,10 @@ String *accept = application/json; // Specifies the content type that the client
- 
var A1PolicyManagementApi = require('a1_policy_management_api');
+                              
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');
 
 // Create an instance of the API class
-var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
 var policyId = policyId_example; // {String} 
 var opts = {
   'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
@@ -5312,6 +5319,7 @@ namespace Example
             var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
 
             try {
+                // Get an A1 Policy's policy data (getPolicy)
                 Object result = apiInstance.getPolicy(policyId, accept);
                 Debug.WriteLine(result);
             } catch (Exception e) {
@@ -5373,6 +5381,7 @@ policyId = policyId_example # String |  (default to null)
 accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
 
 try:
+    # Get an A1 Policy's policy data (getPolicy)
     api_response = api_instance.get_policy(policyId, accept=accept)
     pprint(api_response)
 except ApiException as e:
@@ -6234,12 +6243,12 @@ Specifies the content type that the client expects to receive in response to the
                       

                         

                           
getPolicyStatus

-                          

+                          
Get an A1 Policy Instance's status (getPolicyStatus)

                         

                         

                         

                         

-                        
Query a policy status

+                        
Retrieve the status information for an A1 Policy Instance using its policy ID.

                         

                         

                         
/policies/{policyId}/status

@@ -6347,6 +6356,7 @@ A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
 String *policyId = policyId_example; //  (default to null)
 String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
 
+// Get an A1 Policy Instance's status (getPolicyStatus)
 [apiInstance getPolicyStatusWith:policyId
     accept:accept
               completionHandler: ^(Object output, NSError* error) {
@@ -6361,10 +6371,10 @@ String *accept = application/json; // Specifies the content type that the client
- 
var A1PolicyManagementApi = require('a1_policy_management_api');
+                              
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');
 
 // Create an instance of the API class
-var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
 var policyId = policyId_example; // {String} 
 var opts = {
   'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
@@ -6404,6 +6414,7 @@ namespace Example
             var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
 
             try {
+                // Get an A1 Policy Instance's status (getPolicyStatus)
                 Object result = apiInstance.getPolicyStatus(policyId, accept);
                 Debug.WriteLine(result);
             } catch (Exception e) {
@@ -6465,6 +6476,7 @@ policyId = policyId_example # String |  (default to null)
 accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
 
 try:
+    # Get an A1 Policy Instance's status (getPolicyStatus)
     api_response = api_instance.get_policy_status(policyId, accept=accept)
     pprint(api_response)
 except ApiException as e:
@@ -7321,12 +7333,12 @@ Specifies the content type that the client expects to receive in response to the
                       

                         

                           
getPolicyTypeDefinition

-                          

+                          
Get an A1 Policy Type definition (getPolicyTypeDefinition)

                         

                         

                         

                         

-                        
Returns a policy type definition

+                        
Get an A1 Policy Type definition using its policy type ID

                         

                         

                         
/policy-types/{policyTypeId}

@@ -7434,6 +7446,7 @@ A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
 String *policyTypeId = policyTypeId_example; //  (default to null)
 String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
 
+// Get an A1 Policy Type definition (getPolicyTypeDefinition)
 [apiInstance getPolicyTypeDefinitionWith:policyTypeId
     accept:accept
               completionHandler: ^(PolicyTypeObject output, NSError* error) {
@@ -7448,10 +7461,10 @@ String *accept = application/json; // Specifies the content type that the client
- 
var A1PolicyManagementApi = require('a1_policy_management_api');
+                              
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');
 
 // Create an instance of the API class
-var api = new A1PolicyManagementApi.A1PolicyManagementApi()
+var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
 var policyTypeId = policyTypeId_example; // {String} 
 var opts = {
   'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
@@ -7491,6 +7504,7 @@ namespace Example
             var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)
 
             try {
+                // Get an A1 Policy Type definition (getPolicyTypeDefinition)
                 PolicyTypeObject result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
                 Debug.WriteLine(result);
             } catch (Exception e) {
@@ -7552,6 +7566,7 @@ policyTypeId = policyTypeId_example # String |  (default to null)
 accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)
 
 try:
+    # Get an A1 Policy Type definition (getPolicyTypeDefinition)
     api_response = api_instance.get_policy_type_definition(policyTypeId, accept=accept)
     pprint(api_response)
 except ApiException as e:
@@ -7644,7 +7659,7 @@ Specifies the content type that the client expects to receive in response to the