diff options
| author |   aravind.est <aravindhan.a@est.tech> | 2025-03-26 18:51:45 +0000 |
|---|---|---|
| committer | aravind.est <aravindhan.a@est.tech> | 2025-03-26 18:51:45 +0000 |
| commit | 0722f07df800ad4c400e5ce315de117ad7a22407 (patch) | |
| tree | 9edb3b28b1ea12099e9007427f8117e4963dbe2f | |
| parent | d2c683570632d0510749dfd97aa47caeea471643 (diff) | |
Update openapi & other files for improved docs (oslo)oslo
Update openapi & other files for improved docs (oslo)
Issue-ID: CCSDK-4050
Change-Id: I132c9b464a64414126a62d4d3d6b0efa53469b68
Signed-off-by: aravind.est <aravindhan.a@est.tech>
22 files changed, 2201 insertions, 1711 deletions
@@ -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: @@ -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 @@ <html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> - <title>A1 policy management API</title> + <title>ONAP CCSDK - A1 Policy Management API</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="UTF-8" /> @@ -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 { <div id="content"> <div id="project"> <div class="pull-left"> - <h1>A1 policy management API</h1> + <h1>ONAP CCSDK - A1 Policy Management API</h1> </div> <div class="clearfix"></div> </div> @@ -1211,7 +1212,7 @@ ul.nav-tabs { <div class="app-desc">Version: 1.0.0</div> <hr> <div id="app-description" class="app-desc"> - <h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p> + <h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies. <br/>This document describes the latest API set to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2> <p>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.'</p> <h3>A1 Policy Management</h3> <p>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:</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy Types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3> <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3> <p>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.</p> </div> </div> @@ -1223,12 +1224,12 @@ ul.nav-tabs { <article id="api-A1PolicyManagement-createPolicy-0" data-group="User" data-name="createPolicy" data-version="0"> <div class="pull-left"> <h1>createPolicy</h1> - <p></p> + <p>Create an A1 Policy Instance (createPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">To create A1 policies</p> + <p class="marked">Create an A1 Policy Instance</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/policies</span></code></pre> @@ -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)'" }' </code></pre> </div> @@ -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 = ; // </div> <div class="tab-pane" id="examples-A1PolicyManagement-createPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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() { <td>Location</td> <td>String</td> <td></td> - <td>Contains the URI of the newly created resource</td> + <td>Contains the URI of the newly created A1 Policy Instances. This URI includes the A1 Policy Instance ID for the newly created policy instance. +</td> </tr> <tr> <td>Content-Type</td> @@ -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() { <article id="api-A1PolicyManagement-deletePolicy-0" data-group="User" data-name="deletePolicy" data-version="0"> <div class="pull-left"> <h1>deletePolicy</h1> - <p>Delete a policy</p> + <p>Delete an A1 Policy instance (deletePolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Deleting the policy using policyId.</p> + <p class="marked">Delete an existing A1 Policy instance using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-deletePolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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)</code></pre> @@ -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 <article id="api-A1PolicyManagement-getAllPolicies-0" data-group="User" data-name="getAllPolicies" data-version="0"> <div class="pull-left"> <h1>getAllPolicies</h1> - <p>Query policy identities</p> + <p>Query for A1 Policy instances (getAllPolicies)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.</p> + <p class="marked">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. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies</span></code></pre> @@ -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 <typename_version>) + 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 <typename_version>) +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 <typename_version>) + 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 <typename_version>) (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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-getAllPolicies-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <typename_version>) + '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 <typename_version>) (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 <typename_version>) +$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 <typename_version>) +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 <typename_version>) (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 </span> <div class="inner description marked"> -Select policies of a given policy type identity. +Select policies with a given A1 Policy Type ID. </div> </div> </div> @@ -4321,7 +4327,7 @@ Select policies of a given policy type identity. </span> <div class="inner description marked"> -Select policies of a given Near-RT RIC identity. +Select policies for a given Near-RT RIC identity. </div> </div> </div> @@ -4341,7 +4347,7 @@ Select policies of a given Near-RT RIC identity. </span> <div class="inner description marked"> -Select policies owned by a given service. +Select policies owned by a given service (registered or unregistered). </div> </div> </div> @@ -4361,7 +4367,7 @@ Select policies owned by a given service. </span> <div class="inner description marked"> -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'). </div> </div> </div> @@ -5142,12 +5148,12 @@ Select policies of types with the given type name (type identity has the format <article id="api-A1PolicyManagement-getPolicy-0" data-group="User" data-name="getPolicy" data-version="0"> <div class="pull-left"> <h1>getPolicy</h1> - <p></p> + <p>Get an A1 Policy's policy data (getPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a policy</p> + <p class="marked">Get an A1 Policy instance's policy data using its policy ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <article id="api-A1PolicyManagement-getPolicyStatus-0" data-group="User" data-name="getPolicyStatus" data-version="0"> <div class="pull-left"> <h1>getPolicyStatus</h1> - <p></p> + <p>Get an A1 Policy Instance's status (getPolicyStatus)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Query a policy status</p> + <p class="marked">Retrieve the status information for an A1 Policy Instance using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies/{policyId}/status</span></code></pre> @@ -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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyStatus-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <article id="api-A1PolicyManagement-getPolicyTypeDefinition-0" data-group="User" data-name="getPolicyTypeDefinition" data-version="0"> <div class="pull-left"> <h1>getPolicyTypeDefinition</h1> - <p></p> + <p>Get an A1 Policy Type definition (getPolicyTypeDefinition)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a policy type definition</p> + <p class="marked">Get an A1 Policy Type definition using its policy type ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policy-types/{policyTypeId}</span></code></pre> @@ -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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <h3 id="examples-A1PolicyManagement-getPolicyTypeDefinition-title-200"></h3> <p id="examples-A1PolicyManagement-getPolicyTypeDefinition-description-200" class="marked"></p> <script> - var responseA1PolicyManagement200_description = `OK - schema of the given policy type`; + var responseA1PolicyManagement200_description = `OK - details and schema of the requested A1 Policy Type`; var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n'); if (responseA1PolicyManagement200_description_break == -1) { $("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description); @@ -7672,7 +7687,7 @@ Specifies the content type that the client expects to receive in response to the <script> $(document).ready(function() { var schemaWrapper = { - "description" : "OK - schema of the given policy type", + "description" : "OK - details and schema of the requested A1 Policy Type", "content" : { "application/json" : { "schema" : { @@ -8413,12 +8428,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getPolicyTypes-0" data-group="User" data-name="getPolicyTypes" data-version="0"> <div class="pull-left"> <h1>getPolicyTypes</h1> - <p></p> + <p>Get A1 Policy Types (getPolicyTypes)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Query policy type identities</p> + <p class="marked">Query A1 Policy Type identities using query parameters</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policy-types</span></code></pre> @@ -8463,8 +8478,9 @@ public class A1PolicyManagementApiExample { // Create an instance of the API class A1PolicyManagementApi apiInstance = new A1PolicyManagementApi(); String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. - String typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) - String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') + String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8485,8 +8501,9 @@ public class A1PolicyManagementApiExample { final api_instance = DefaultApi(); final String nearRtRicId = new String(); // String | Select types for the given Near-RT RIC identity. -final String typeName = new String(); // String | Select types with the given type name (type identity has the format <typename_version>) -final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +final String typeName = new String(); // String | Select types compatible with the given type name (type identity has the format 'typename_version') +final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8506,8 +8523,9 @@ public class A1PolicyManagementApiExample { public static void main(String[] args) { A1PolicyManagementApi apiInstance = new A1PolicyManagementApi(); String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. - String typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) - String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') + String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8530,10 +8548,12 @@ public class A1PolicyManagementApiExample { // Create an instance of the API class A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *nearRtRicId = nearRtRicId_example; // Select types for the given Near-RT RIC identity. (optional) (default to null) -String *typeName = typeName_example; // Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) -String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) +String *typeName = typeName_example; // Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) +String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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) +// Get A1 Policy Types (getPolicyTypes) [apiInstance getPolicyTypesWith:nearRtRicId typeName:typeName compatibleWithVersion:compatibleWithVersion @@ -8550,14 +8570,15 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypes-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 = { 'nearRtRicId': nearRtRicId_example, // {String} Select types for the given Near-RT RIC identity. - 'typeName': typeName_example, // {String} Select types with the given type name (type identity has the format <typename_version>) - 'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 'typeName': typeName_example, // {String} Select types compatible with the given type name (type identity has the format 'typename_version') + 'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. }; @@ -8592,11 +8613,13 @@ namespace Example // Create an instance of the API class var apiInstance = new A1PolicyManagementApi(); var nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. (optional) (default to null) - var typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) - var compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) + var typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) + var compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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 { + // Get A1 Policy Types (getPolicyTypes) array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -8615,8 +8638,9 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi(); $nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. -$typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) -$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +$typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') +$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + $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 { @@ -8636,8 +8660,9 @@ use WWW::OPenAPIClient::A1PolicyManagementApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new(); my $nearRtRicId = nearRtRicId_example; # String | Select types for the given Near-RT RIC identity. -my $typeName = typeName_example; # String | Select types with the given type name (type identity has the format <typename_version>) -my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +my $typeName = typeName_example; # String | Select types compatible with the given type name (type identity has the format 'typename_version') +my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8659,11 +8684,13 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.A1PolicyManagementApi() nearRtRicId = nearRtRicId_example # String | Select types for the given Near-RT RIC identity. (optional) (default to null) -typeName = typeName_example # String | Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) -compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) +typeName = typeName_example # String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) +compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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: + # Get A1 Policy Types (getPolicyTypes) api_response = api_instance.get_policy_types(nearRtRicId=nearRtRicId, typeName=typeName, compatibleWithVersion=compatibleWithVersion, accept=accept) pprint(api_response) except ApiException as e: @@ -8764,7 +8791,7 @@ Select types for the given Near-RT RIC identity. </span> <div class="inner description marked"> -Select types with the given type name (type identity has the format <typename_version>) +Select types compatible with the given type name (type identity has the format 'typename_version') </div> </div> </div> @@ -8784,7 +8811,8 @@ Select types with the given type name (type identity has the format <typename </span> <div class="inner description marked"> -Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + </div> </div> </div> @@ -9570,12 +9598,12 @@ Select types that are compatible with the given version. This parameter is only <article id="api-A1PolicyManagement-putPolicy-0" data-group="User" data-name="putPolicy" data-version="0"> <div class="pull-left"> <h1>putPolicy</h1> - <p></p> + <p>Update an A1 Policy's policy data (putPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">update a policy</p> + <p class="marked">Update an existing A1 Policy instance's policy data using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -9685,6 +9713,7 @@ A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *policyId = policyId_example; // (default to null) Object *body = Object; // +// Update an A1 Policy's policy data (putPolicy) [apiInstance putPolicyWith:policyId body:body completionHandler: ^(Object output, NSError* error) { @@ -9699,10 +9728,10 @@ Object *body = Object; // </div> <div class="tab-pane" id="examples-A1PolicyManagement-putPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 body = Object; // {Object} @@ -9740,6 +9769,7 @@ namespace Example var body = Object; // Object | try { + // Update an A1 Policy's policy data (putPolicy) Object result = apiInstance.putPolicy(policyId, body); Debug.WriteLine(result); } catch (Exception e) { @@ -9801,6 +9831,7 @@ policyId = policyId_example # String | (default to null) body = Object # Object | try: + # Update an A1 Policy's policy data (putPolicy) api_response = api_instance.put_policy(policyId, body) pprint(api_response) except ApiException as e: @@ -10640,7 +10671,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." } } } diff --git a/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html b/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html index c693818d..71e0c49f 100644 --- a/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html +++ b/a1-policy-management/api/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html @@ -2,7 +2,7 @@ <html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> - <title>A1 policy management API</title> + <title>ONAP CCSDK - A1 Policy Management API</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="UTF-8" /> @@ -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 = {}; @@ -1232,7 +1233,7 @@ ul.nav-tabs { <div id="content"> <div id="project"> <div class="pull-left"> - <h1>A1 policy management API</h1> + <h1>ONAP CCSDK - A1 Policy Management API</h1> </div> <div class="clearfix"></div> </div> @@ -1242,7 +1243,7 @@ ul.nav-tabs { <div class="app-desc">Version: 1.0.0</div> <hr> <div id="app-description" class="app-desc"> - <h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p> + <h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies. <br/>This document describes the latest API set to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2> <p>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.'</p> <h3>A1 Policy Management</h3> <p>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:</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy Types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3> <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3> <p>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.</p> </div> </div> @@ -1254,12 +1255,12 @@ ul.nav-tabs { <article id="api-A1PolicyManagement-createPolicy-0" data-group="User" data-name="createPolicy" data-version="0"> <div class="pull-left"> <h1>createPolicy</h1> - <p></p> + <p>Create an A1 Policy Instance (createPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">To create A1 policies</p> + <p class="marked">Create an A1 Policy Instance</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/policies</span></code></pre> @@ -1289,12 +1290,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)'" }' </code></pre> </div> @@ -1372,6 +1373,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) { @@ -1385,10 +1387,10 @@ PolicyObjectInformation *policyObjectInformation = ; // </div> <div class="tab-pane" id="examples-A1PolicyManagement-createPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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) { @@ -1424,6 +1426,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) { @@ -1482,6 +1485,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: @@ -1601,7 +1605,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, @@ -1674,7 +1678,8 @@ $(document).ready(function() { <td>Location</td> <td>String</td> <td></td> - <td>Contains the URI of the newly created resource</td> + <td>Contains the URI of the newly created A1 Policy Instances. This URI includes the A1 Policy Instance ID for the newly created policy instance. +</td> </tr> <tr> <td>Content-Type</td> @@ -2409,7 +2414,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." } } } @@ -2761,12 +2766,12 @@ $(document).ready(function() { <article id="api-A1PolicyManagement-deletePolicy-0" data-group="User" data-name="deletePolicy" data-version="0"> <div class="pull-left"> <h1>deletePolicy</h1> - <p>Delete a policy</p> + <p>Delete an A1 Policy instance (deletePolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Deleting the policy using policyId.</p> + <p class="marked">Delete an existing A1 Policy instance using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -2872,7 +2877,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) { @@ -2884,10 +2889,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-deletePolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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. @@ -2927,7 +2932,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 ); @@ -2986,7 +2991,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)</code></pre> @@ -3635,7 +3640,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." } } } @@ -3987,12 +3992,13 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getAllPolicies-0" data-group="User" data-name="getAllPolicies" data-version="0"> <div class="pull-left"> <h1>getAllPolicies</h1> - <p>Query policy identities</p> + <p>Query for A1 Policy instances (getAllPolicies)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.</p> + <p class="marked">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. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies</span></code></pre> @@ -4036,10 +4042,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 <typename_version>) + 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 { @@ -4059,10 +4065,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 <typename_version>) +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 { @@ -4081,10 +4087,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 <typename_version>) + 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 { @@ -4106,13 +4112,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 <typename_version>) (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 @@ -4130,15 +4136,15 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getAllPolicies-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <typename_version>) + '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. }; @@ -4172,14 +4178,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 <typename_version>) (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) { @@ -4197,10 +4203,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 <typename_version>) +$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 { @@ -4219,10 +4225,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 <typename_version>) +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 { @@ -4243,14 +4249,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 <typename_version>) (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: @@ -4332,7 +4338,7 @@ Specifies the content type that the client expects to receive in response to the </span> <div class="inner description marked"> -Select policies of a given policy type identity. +Select policies with a given A1 Policy Type ID. </div> </div> </div> @@ -4352,7 +4358,7 @@ Select policies of a given policy type identity. </span> <div class="inner description marked"> -Select policies of a given Near-RT RIC identity. +Select policies for a given Near-RT RIC identity. </div> </div> </div> @@ -4372,7 +4378,7 @@ Select policies of a given Near-RT RIC identity. </span> <div class="inner description marked"> -Select policies owned by a given service. +Select policies owned by a given service (registered or unregistered). </div> </div> </div> @@ -4392,7 +4398,7 @@ Select policies owned by a given service. </span> <div class="inner description marked"> -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'). </div> </div> </div> @@ -5173,12 +5179,12 @@ Select policies of types with the given type name (type identity has the format <article id="api-A1PolicyManagement-getPolicy-0" data-group="User" data-name="getPolicy" data-version="0"> <div class="pull-left"> <h1>getPolicy</h1> - <p></p> + <p>Get an A1 Policy's policy data (getPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a policy</p> + <p class="marked">Get an A1 Policy instance's policy data using its policy ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -5286,6 +5292,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) { @@ -5300,10 +5307,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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. @@ -5343,6 +5350,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) { @@ -5404,6 +5412,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: @@ -6265,12 +6274,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getPolicyStatus-0" data-group="User" data-name="getPolicyStatus" data-version="0"> <div class="pull-left"> <h1>getPolicyStatus</h1> - <p></p> + <p>Get an A1 Policy Instance's status (getPolicyStatus)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Query a policy status</p> + <p class="marked">Retrieve the status information for an A1 Policy Instance using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies/{policyId}/status</span></code></pre> @@ -6378,6 +6387,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) { @@ -6392,10 +6402,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyStatus-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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. @@ -6435,6 +6445,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) { @@ -6496,6 +6507,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: @@ -7352,12 +7364,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getPolicyTypeDefinition-0" data-group="User" data-name="getPolicyTypeDefinition" data-version="0"> <div class="pull-left"> <h1>getPolicyTypeDefinition</h1> - <p></p> + <p>Get an A1 Policy Type definition (getPolicyTypeDefinition)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a policy type definition</p> + <p class="marked">Get an A1 Policy Type definition using its policy type ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policy-types/{policyTypeId}</span></code></pre> @@ -7465,6 +7477,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) { @@ -7479,10 +7492,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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. @@ -7522,6 +7535,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) { @@ -7583,6 +7597,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: @@ -7675,7 +7690,7 @@ Specifies the content type that the client expects to receive in response to the <h3 id="examples-A1PolicyManagement-getPolicyTypeDefinition-title-200"></h3> <p id="examples-A1PolicyManagement-getPolicyTypeDefinition-description-200" class="marked"></p> <script> - var responseA1PolicyManagement200_description = `OK - schema of the given policy type`; + var responseA1PolicyManagement200_description = `OK - details and schema of the requested A1 Policy Type`; var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n'); if (responseA1PolicyManagement200_description_break == -1) { $("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description); @@ -7703,7 +7718,7 @@ Specifies the content type that the client expects to receive in response to the <script> $(document).ready(function() { var schemaWrapper = { - "description" : "OK - schema of the given policy type", + "description" : "OK - details and schema of the requested A1 Policy Type", "content" : { "application/json" : { "schema" : { @@ -8444,12 +8459,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getPolicyTypes-0" data-group="User" data-name="getPolicyTypes" data-version="0"> <div class="pull-left"> <h1>getPolicyTypes</h1> - <p></p> + <p>Get A1 Policy Types (getPolicyTypes)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Query policy type identities</p> + <p class="marked">Query A1 Policy Type identities using query parameters</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policy-types</span></code></pre> @@ -8494,8 +8509,9 @@ public class A1PolicyManagementApiExample { // Create an instance of the API class A1PolicyManagementApi apiInstance = new A1PolicyManagementApi(); String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. - String typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) - String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') + String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8516,8 +8532,9 @@ public class A1PolicyManagementApiExample { final api_instance = DefaultApi(); final String nearRtRicId = new String(); // String | Select types for the given Near-RT RIC identity. -final String typeName = new String(); // String | Select types with the given type name (type identity has the format <typename_version>) -final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +final String typeName = new String(); // String | Select types compatible with the given type name (type identity has the format 'typename_version') +final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8537,8 +8554,9 @@ public class A1PolicyManagementApiExample { public static void main(String[] args) { A1PolicyManagementApi apiInstance = new A1PolicyManagementApi(); String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. - String typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) - String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') + String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8561,10 +8579,12 @@ public class A1PolicyManagementApiExample { // Create an instance of the API class A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *nearRtRicId = nearRtRicId_example; // Select types for the given Near-RT RIC identity. (optional) (default to null) -String *typeName = typeName_example; // Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) -String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) +String *typeName = typeName_example; // Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) +String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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) +// Get A1 Policy Types (getPolicyTypes) [apiInstance getPolicyTypesWith:nearRtRicId typeName:typeName compatibleWithVersion:compatibleWithVersion @@ -8581,14 +8601,15 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypes-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 = { 'nearRtRicId': nearRtRicId_example, // {String} Select types for the given Near-RT RIC identity. - 'typeName': typeName_example, // {String} Select types with the given type name (type identity has the format <typename_version>) - 'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 'typeName': typeName_example, // {String} Select types compatible with the given type name (type identity has the format 'typename_version') + 'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. }; @@ -8623,11 +8644,13 @@ namespace Example // Create an instance of the API class var apiInstance = new A1PolicyManagementApi(); var nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. (optional) (default to null) - var typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) - var compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) + var typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) + var compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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 { + // Get A1 Policy Types (getPolicyTypes) array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -8646,8 +8669,9 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi(); $nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. -$typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) -$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +$typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') +$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + $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 { @@ -8667,8 +8691,9 @@ use WWW::OPenAPIClient::A1PolicyManagementApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new(); my $nearRtRicId = nearRtRicId_example; # String | Select types for the given Near-RT RIC identity. -my $typeName = typeName_example; # String | Select types with the given type name (type identity has the format <typename_version>) -my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +my $typeName = typeName_example; # String | Select types compatible with the given type name (type identity has the format 'typename_version') +my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8690,11 +8715,13 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.A1PolicyManagementApi() nearRtRicId = nearRtRicId_example # String | Select types for the given Near-RT RIC identity. (optional) (default to null) -typeName = typeName_example # String | Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) -compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) +typeName = typeName_example # String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) +compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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: + # Get A1 Policy Types (getPolicyTypes) api_response = api_instance.get_policy_types(nearRtRicId=nearRtRicId, typeName=typeName, compatibleWithVersion=compatibleWithVersion, accept=accept) pprint(api_response) except ApiException as e: @@ -8795,7 +8822,7 @@ Select types for the given Near-RT RIC identity. </span> <div class="inner description marked"> -Select types with the given type name (type identity has the format <typename_version>) +Select types compatible with the given type name (type identity has the format 'typename_version') </div> </div> </div> @@ -8815,7 +8842,8 @@ Select types with the given type name (type identity has the format <typename </span> <div class="inner description marked"> -Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + </div> </div> </div> @@ -9601,12 +9629,12 @@ Select types that are compatible with the given version. This parameter is only <article id="api-A1PolicyManagement-putPolicy-0" data-group="User" data-name="putPolicy" data-version="0"> <div class="pull-left"> <h1>putPolicy</h1> - <p></p> + <p>Update an A1 Policy's policy data (putPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">update a policy</p> + <p class="marked">Update an existing A1 Policy instance's policy data using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -9716,6 +9744,7 @@ A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *policyId = policyId_example; // (default to null) Object *body = Object; // +// Update an A1 Policy's policy data (putPolicy) [apiInstance putPolicyWith:policyId body:body completionHandler: ^(Object output, NSError* error) { @@ -9730,10 +9759,10 @@ Object *body = Object; // </div> <div class="tab-pane" id="examples-A1PolicyManagement-putPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 body = Object; // {Object} @@ -9771,6 +9800,7 @@ namespace Example var body = Object; // Object | try { + // Update an A1 Policy's policy data (putPolicy) Object result = apiInstance.putPolicy(policyId, body); Debug.WriteLine(result); } catch (Exception e) { @@ -9832,6 +9862,7 @@ policyId = policyId_example # String | (default to null) body = Object # Object | try: + # Update an A1 Policy's policy data (putPolicy) api_response = api_instance.put_policy(policyId, body) pprint(api_response) except ApiException as e: @@ -10671,7 +10702,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." } } } @@ -11026,12 +11057,12 @@ $(document).ready(function() { <article id="api-Configuration-getConfiguration-0" data-group="User" data-name="getConfiguration" data-version="0"> <div class="pull-left"> <h1>getConfiguration</h1> - <p></p> + <p>Get the Application Configuration (getConfiguration)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns the contents of the application configuration</p> + <p class="marked">Returns the entire contents of the Application Configuration.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/configuration</span></code></pre> @@ -11131,6 +11162,7 @@ public class ConfigurationApiExample { // Create an instance of the API class ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init]; +// Get the Application Configuration (getConfiguration) [apiInstance getConfigurationWithCompletionHandler: ^('String' output, NSError* error) { if (output) { @@ -11144,10 +11176,10 @@ ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init]; </div> <div class="tab-pane" id="examples-Configuration-getConfiguration-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ConfigurationApi() +var api = new OnapCcsdkA1PolicyManagementApi.ConfigurationApi() var callback = function(error, data, response) { if (error) { console.error(error); @@ -11180,6 +11212,7 @@ namespace Example var apiInstance = new ConfigurationApi(); try { + // Get the Application Configuration (getConfiguration) 'String' result = apiInstance.getConfiguration(); Debug.WriteLine(result); } catch (Exception e) { @@ -11235,6 +11268,7 @@ from pprint import pprint api_instance = openapi_client.ConfigurationApi() try: + # Get the Application Configuration (getConfiguration) api_response = api_instance.get_configuration() pprint(api_response) except ApiException as e: @@ -11427,12 +11461,13 @@ pub fn main() { <article id="api-Configuration-putConfiguration-0" data-group="User" data-name="putConfiguration" data-version="0"> <div class="pull-left"> <h1>putConfiguration</h1> - <p></p> + <p>Set/Replace the Application Configuration (putConfiguration)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Replace the current configuration file with the given configuration</p> + <p class="marked">Replace the current Application Configuration with a new configuration. The new configuration, if accepted, will take effect after a short delay. The new configuration must comply with the Application Configuration schema, which can be found from the the Application Documentation (Developer Guide) +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/configuration</span></code></pre> @@ -11538,6 +11573,7 @@ public class ConfigurationApiExample { ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init]; Object *body = Object; // +// Set/Replace the Application Configuration (putConfiguration) [apiInstance putConfigurationWith:body completionHandler: ^(Object output, NSError* error) { if (output) { @@ -11551,10 +11587,10 @@ Object *body = Object; // </div> <div class="tab-pane" id="examples-Configuration-putConfiguration-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ConfigurationApi() +var api = new OnapCcsdkA1PolicyManagementApi.ConfigurationApi() var body = Object; // {Object} var callback = function(error, data, response) { @@ -11590,6 +11626,7 @@ namespace Example var body = Object; // Object | try { + // Set/Replace the Application Configuration (putConfiguration) Object result = apiInstance.putConfiguration(body); Debug.WriteLine(result); } catch (Exception e) { @@ -11648,6 +11685,7 @@ api_instance = openapi_client.ConfigurationApi() body = Object # Object | try: + # Set/Replace the Application Configuration (putConfiguration) api_response = api_instance.put_configuration(body) pprint(api_response) except ApiException as e: @@ -11892,7 +11930,7 @@ $(document).ready(function() { <article id="api-HealthCheck-getStatus-0" data-group="User" data-name="getStatus" data-version="0"> <div class="pull-left"> <h1>getStatus</h1> - <p></p> + <p>Get Status (getStatus)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> @@ -11997,6 +12035,7 @@ public class HealthCheckApiExample { // Create an instance of the API class HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init]; +// Get Status (getStatus) [apiInstance getStatusWithCompletionHandler: ^(StatusInfo output, NSError* error) { if (output) { @@ -12010,10 +12049,10 @@ HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init]; </div> <div class="tab-pane" id="examples-HealthCheck-getStatus-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.HealthCheckApi() +var api = new OnapCcsdkA1PolicyManagementApi.HealthCheckApi() var callback = function(error, data, response) { if (error) { console.error(error); @@ -12046,6 +12085,7 @@ namespace Example var apiInstance = new HealthCheckApi(); try { + // Get Status (getStatus) StatusInfo result = apiInstance.getStatus(); Debug.WriteLine(result); } catch (Exception e) { @@ -12101,6 +12141,7 @@ from pprint import pprint api_instance = openapi_client.HealthCheckApi() try: + # Get Status (getStatus) api_response = api_instance.get_status() pprint(api_response) except ApiException as e: @@ -12301,12 +12342,12 @@ pub fn main() { <article id="api-NearRTRICRepository-getRic-0" data-group="User" data-name="getRic" data-version="0"> <div class="pull-left"> <h1>getRic</h1> - <p>Returns info for one Near-RT RIC</p> + <p>Get a Near-RT RIC (getRic)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">A ricId path parameter must be specified to retrieve associated ric infomation</p> + <p class="marked">Get information about a Near-RT RIC</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/rics/{ricId}</span></code></pre> @@ -12414,7 +12455,7 @@ NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init]; String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (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) -// Returns info for one Near-RT RIC +// Get a Near-RT RIC (getRic) [apiInstance getRicWith:ricId accept:accept completionHandler: ^(RicInfo output, NSError* error) { @@ -12429,10 +12470,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.NearRTRICRepositoryApi() +var api = new OnapCcsdkA1PolicyManagementApi.NearRTRICRepositoryApi() var ricId = ricId_example; // {String} The identity of a Near-RT RIC to get information for. 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. @@ -12472,7 +12513,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 { - // Returns info for one Near-RT RIC + // Get a Near-RT RIC (getRic) RicInfo result = apiInstance.getRic(ricId, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -12534,7 +12575,7 @@ ricId = ricId_example # String | The identity of a Near-RT RIC to get informatio 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: - # Returns info for one Near-RT RIC + # Get a Near-RT RIC (getRic) api_response = api_instance.get_ric(ricId, accept=accept) pprint(api_response) except ApiException as e: @@ -12791,12 +12832,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-NearRTRICRepository-getRics-0" data-group="User" data-name="getRics" data-version="0"> <div class="pull-left"> <h1>getRics</h1> - <p>Query Near-RT RIC information</p> + <p>Get Near-RT RICs for A1 Policy Type (getRics)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">The call returns all Near-RT RICs that supports a given policy type identity</p> + <p class="marked">Get all Near-RT RICs that supports a given A1 Policy Type ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/rics</span></code></pre> @@ -12840,7 +12881,8 @@ public class NearRTRICRepositoryApiExample { // Create an instance of the API class NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi(); - String policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned + String policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 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 { @@ -12860,7 +12902,8 @@ public class NearRTRICRepositoryApiExample { final api_instance = DefaultApi(); -final String policyTypeId = new String(); // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +final String policyTypeId = new String(); // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 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 { @@ -12879,7 +12922,8 @@ try { public class NearRTRICRepositoryApiExample { public static void main(String[] args) { NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi(); - String policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned + String policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 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 { @@ -12901,10 +12945,11 @@ public class NearRTRICRepositoryApiExample { // Create an instance of the API class NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init]; -String *policyTypeId = policyTypeId_example; // The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null) +String *policyTypeId = policyTypeId_example; // The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + (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 Near-RT RIC information +// Get Near-RT RICs for A1 Policy Type (getRics) [apiInstance getRicsWith:policyTypeId accept:accept completionHandler: ^(RicInfoList output, NSError* error) { @@ -12919,12 +12964,13 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.NearRTRICRepositoryApi() +var api = new OnapCcsdkA1PolicyManagementApi.NearRTRICRepositoryApi() var opts = { - 'policyTypeId': policyTypeId_example, // {String} The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned + 'policyTypeId': policyTypeId_example, // {String} The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. }; @@ -12958,11 +13004,12 @@ namespace Example // Create an instance of the API class var apiInstance = new NearRTRICRepositoryApi(); - var policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null) + var policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + (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 Near-RT RIC information + // Get Near-RT RICs for A1 Policy Type (getRics) RicInfoList result = apiInstance.getRics(policyTypeId, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -12980,7 +13027,8 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi(); -$policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +$policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + $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 { @@ -12999,7 +13047,8 @@ use WWW::OPenAPIClient::NearRTRICRepositoryApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new(); -my $policyTypeId = policyTypeId_example; # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +my $policyTypeId = policyTypeId_example; # String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 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 { @@ -13020,11 +13069,12 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.NearRTRICRepositoryApi() -policyTypeId = policyTypeId_example # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null) +policyTypeId = policyTypeId_example # String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + (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 Near-RT RIC information + # Get Near-RT RICs for A1 Policy Type (getRics) api_response = api_instance.get_rics(policyTypeId=policyTypeId, accept=accept) pprint(api_response) except ApiException as e: @@ -13103,7 +13153,8 @@ Specifies the content type that the client expects to receive in response to the </span> <div class="inner description marked"> -The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + </div> </div> </div> @@ -13281,12 +13332,13 @@ The identity of a policy type. If given, all Near-RT RICs supporting the policy <article id="api-ServiceRegistryAndSupervision-deleteService-0" data-group="User" data-name="deleteService" data-version="0"> <div class="pull-left"> <h1>deleteService</h1> - <p></p> + <p>Unregister a Service (deleteService)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Unregister a service</p> + <p class="marked">Unregister a registered Service using its service ID. Only registered services can be unregistered. All A1 Policy Instances for the previously registered service will be removed. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/services/{serviceId}</span></code></pre> @@ -13394,6 +13446,7 @@ ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionA String *serviceId = serviceId_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) +// Unregister a Service (deleteService) [apiInstance deleteServiceWith:serviceId accept:accept completionHandler: ^(Object output, NSError* error) { @@ -13408,10 +13461,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-ServiceRegistryAndSupervision-deleteService-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi() +var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi() var serviceId = serviceId_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. @@ -13451,6 +13504,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 { + // Unregister a Service (deleteService) Object result = apiInstance.deleteService(serviceId, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -13512,6 +13566,7 @@ serviceId = serviceId_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: + # Unregister a Service (deleteService) api_response = api_instance.delete_service(serviceId, accept=accept) pprint(api_response) except ApiException as e: @@ -13760,12 +13815,13 @@ Specifies the content type that the client expects to receive in response to the <article id="api-ServiceRegistryAndSupervision-getServices-0" data-group="User" data-name="getServices" data-version="0"> <div class="pull-left"> <h1>getServices</h1> - <p>Returns service information</p> + <p>Get Services (getServices)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Either information about a registered service with given identity or all registered services are returned.</p> + <p class="marked">Get information about all registered services, or a single registered service. If the service ID of a registered service is included in the query, information about that service is returned. Otherwise Information about all registered is returned. This operation does not retrieve information about unregistered services. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/services</span></code></pre> @@ -13809,7 +13865,7 @@ public class ServiceRegistryAndSupervisionApiExample { // Create an instance of the API class ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi(); - String serviceId = serviceId_example; // String | The identity of the service + String serviceId = serviceId_example; // String | The identity of the registered service 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 { @@ -13829,7 +13885,7 @@ public class ServiceRegistryAndSupervisionApiExample { final api_instance = DefaultApi(); -final String serviceId = new String(); // String | The identity of the service +final String serviceId = new String(); // String | The identity of the registered service 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 { @@ -13848,7 +13904,7 @@ try { public class ServiceRegistryAndSupervisionApiExample { public static void main(String[] args) { ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi(); - String serviceId = serviceId_example; // String | The identity of the service + String serviceId = serviceId_example; // String | The identity of the registered service 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 { @@ -13870,10 +13926,10 @@ public class ServiceRegistryAndSupervisionApiExample { // Create an instance of the API class ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init]; -String *serviceId = serviceId_example; // The identity of the service (optional) (default to null) +String *serviceId = serviceId_example; // The identity of the registered service (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) -// Returns service information +// Get Services (getServices) [apiInstance getServicesWith:serviceId accept:accept completionHandler: ^(ServiceStatusList output, NSError* error) { @@ -13888,12 +13944,12 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-ServiceRegistryAndSupervision-getServices-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi() +var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi() var opts = { - 'serviceId': serviceId_example, // {String} The identity of the service + 'serviceId': serviceId_example, // {String} The identity of the registered service 'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. }; @@ -13927,11 +13983,11 @@ namespace Example // Create an instance of the API class var apiInstance = new ServiceRegistryAndSupervisionApi(); - var serviceId = serviceId_example; // String | The identity of the service (optional) (default to null) + var serviceId = serviceId_example; // String | The identity of the registered service (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 { - // Returns service information + // Get Services (getServices) ServiceStatusList result = apiInstance.getServices(serviceId, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -13949,7 +14005,7 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi(); -$serviceId = serviceId_example; // String | The identity of the service +$serviceId = serviceId_example; // String | The identity of the registered service $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 { @@ -13968,7 +14024,7 @@ use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new(); -my $serviceId = serviceId_example; # String | The identity of the service +my $serviceId = serviceId_example; # String | The identity of the registered service 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 { @@ -13989,11 +14045,11 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.ServiceRegistryAndSupervisionApi() -serviceId = serviceId_example # String | The identity of the service (optional) (default to null) +serviceId = serviceId_example # String | The identity of the registered service (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: - # Returns service information + # Get Services (getServices) api_response = api_instance.get_services(serviceId=serviceId, accept=accept) pprint(api_response) except ApiException as e: @@ -14072,7 +14128,7 @@ Specifies the content type that the client expects to receive in response to the </span> <div class="inner description marked"> -The identity of the service +The identity of the registered service </div> </div> </div> @@ -14247,12 +14303,12 @@ The identity of the service <article id="api-ServiceRegistryAndSupervision-keepAliveService-0" data-group="User" data-name="keepAliveService" data-version="0"> <div class="pull-left"> <h1>keepAliveService</h1> - <p>Heartbeat indicates that the service is running</p> + <p>Heartbeat message from a service (keepAliveService)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)</p> + <p class="marked">A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/services/{serviceId}/keepalive</span></code></pre> @@ -14366,7 +14422,7 @@ String *serviceId = serviceId_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) String *body = body_example; // (optional) -// Heartbeat indicates that the service is running +// Heartbeat message from a service (keepAliveService) [apiInstance keepAliveServiceWith:serviceId accept:accept body:body @@ -14382,10 +14438,10 @@ String *body = body_example; // (optional) </div> <div class="tab-pane" id="examples-ServiceRegistryAndSupervision-keepAliveService-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi() +var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi() var serviceId = serviceId_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. @@ -14427,7 +14483,7 @@ namespace Example var body = body_example; // String | (optional) try { - // Heartbeat indicates that the service is running + // Heartbeat message from a service (keepAliveService) Object result = apiInstance.keepAliveService(serviceId, accept, body); Debug.WriteLine(result); } catch (Exception e) { @@ -14492,7 +14548,7 @@ accept = application/json # String | Specifies the content type that the client body = body_example # String | (optional) try: - # Heartbeat indicates that the service is running + # Heartbeat message from a service (keepAliveService) api_response = api_instance.keep_alive_service(serviceId, accept=accept, body=body) pprint(api_response) except ApiException as e: @@ -14790,12 +14846,13 @@ $(document).ready(function() { <article id="api-ServiceRegistryAndSupervision-putService-0" data-group="User" data-name="putService" data-version="0"> <div class="pull-left"> <h1>putService</h1> - <p>Register a service</p> + <p>Register or update a Service (putService)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><li>Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.</li></ul>Policies can be created even if the service is not registerred. This is a feature which it is optional to use.</p> + <p class="marked">Register a single service, or update a previous registration. Service registration is required to get callbacks about available NearRT RICs and to enable supervision of the service's active status. If a registered service becomes inactive, its policies can be automatically deleted. A1 Policy instances can also be created for unregistered services. If an unregistered service is later registered, the service's policies are retained when the service becomes registered. This feature is optional to use. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/services</span></code></pre> @@ -14905,7 +14962,7 @@ public class ServiceRegistryAndSupervisionApiExample { ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init]; ServiceRegistrationInfo *serviceRegistrationInfo = ; // -// Register a service +// Register or update a Service (putService) [apiInstance putServiceWith:serviceRegistrationInfo completionHandler: ^(Object output, NSError* error) { if (output) { @@ -14919,10 +14976,10 @@ ServiceRegistrationInfo *serviceRegistrationInfo = ; // </div> <div class="tab-pane" id="examples-ServiceRegistryAndSupervision-putService-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi() +var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi() var serviceRegistrationInfo = ; // {ServiceRegistrationInfo} var callback = function(error, data, response) { @@ -14958,7 +15015,7 @@ namespace Example var serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | try { - // Register a service + // Register or update a Service (putService) Object result = apiInstance.putService(serviceRegistrationInfo); Debug.WriteLine(result); } catch (Exception e) { @@ -15017,7 +15074,7 @@ api_instance = openapi_client.ServiceRegistryAndSupervisionApi() serviceRegistrationInfo = # ServiceRegistrationInfo | try: - # Register a service + # Register or update a Service (putService) api_response = api_instance.put_service(serviceRegistrationInfo) pprint(api_response) except ApiException as e: diff --git a/a1-policy-management/api/offeredapis/swagger/custom/a1pms-api-custom-v3.json b/a1-policy-management/api/offeredapis/swagger/custom/a1pms-api-custom-v3.json index f2141968..ec085700 100644 --- a/a1-policy-management/api/offeredapis/swagger/custom/a1pms-api-custom-v3.json +++ b/a1-policy-management/api/offeredapis/swagger/custom/a1pms-api-custom-v3.json @@ -5,39 +5,43 @@ "email" : "discuss-list@onap.com", "url" : "https://www.onap.org/" }, - "description" : "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p>", + "description" : "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies. <br/>This document describes the latest API set to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2> <p>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.'</p> <h3>A1 Policy Management</h3> <p>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:</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy Types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3> <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3> <p>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.</p>", "license" : { "name" : "Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License.", "url" : "http://www.apache.org/licenses/LICENSE-2.0" }, - "title" : "A1 policy management API", + "title" : "ONAP CCSDK - A1 Policy Management API", "version" : "1.0.0", - "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8", + "x-api-id" : "e9776a07-0813-4fca-9801-6f892f0a7c13", "x-audience" : "external-public" }, + "externalDocs" : { + "description" : "Based on parts of O-RAN ALLIANCE specification: O-RAN.WG2.R1AP-v07.00", + "url" : "https://www.o-ran.org/specifications" + }, "servers" : [ { "url" : "{apiRoot}/a1-policy-management/v1", "variables" : { "apiRoot" : { "default" : "https://example.com", - "description" : "This is the Host:Port or Address where the A1-Policy Management Service can be accessed. Note: This URL path format aligns with the O-RAN Alliance (r) R1-AP specifiactions for A1 Policy Management" + "description" : "This is the Host:Port or Address where the A1-Policy Management Service can be accessed. Note: This URL path format aligns with the O-RAN Alliance R1-AP specifications for A1 Policy Management" } } } ], "tags" : [ { - "description" : "**(Newer Version)** API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances.", + "description" : "API used to get, create, update and delete A1 Policy Instances. Also used to query A1 Policy Types.\n", "name" : "A1 Policy Management" }, { - "description" : "API used to get the NearRT-RIC for the managed element.", + "description" : "API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "API used to keep the service Alive with in the timeout period", + "description" : "API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { - "description" : "API used to get the health status and statistics of this service", + "description" : "API used to get the health status and statistics of this service.\n", "name" : "Health Check" }, { - "description" : "API used to create or fetch the application configuration.", + "description" : "API used to create or fetch the application configuration.\n", "name" : "Configuration" } ], "paths" : { @@ -72,12 +76,13 @@ "description" : "Not Found" } }, + "summary" : "Get Status (getStatus)", "tags" : [ "Health Check" ] } }, "/rics/{ricId}" : { "get" : { - "description" : "A ricId path parameter must be specified to retrieve associated ric infomation", + "description" : "Get information about a Near-RT RIC", "operationId" : "getRic", "parameters" : [ { "description" : "The identity of a Near-RT RIC to get information for.", @@ -89,7 +94,7 @@ "nullable" : false, "type" : "string" }, - "style" : "form" + "style" : "simple" }, { "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", "explode" : false, @@ -129,16 +134,16 @@ "description" : "Not Found" } }, - "summary" : "Returns info for one Near-RT RIC", + "summary" : "Get a Near-RT RIC (getRic)", "tags" : [ "NearRT-RIC Repository" ] } }, "/rics" : { "get" : { - "description" : "The call returns all Near-RT RICs that supports a given policy type identity", + "description" : "Get all Near-RT RICs that supports a given A1 Policy Type ID", "operationId" : "getRics", "parameters" : [ { - "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned", + "description" : "The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.\n", "explode" : true, "in" : "query", "name" : "policyTypeId", @@ -186,13 +191,13 @@ "description" : "Not Found" } }, - "summary" : "Query Near-RT RIC information", + "summary" : "Get Near-RT RICs for A1 Policy Type (getRics)", "tags" : [ "NearRT-RIC Repository" ] } }, "/policy-types" : { "get" : { - "description" : "Query policy type identities", + "description" : "Query A1 Policy Type identities using query parameters", "operationId" : "getPolicyTypes", "parameters" : [ { "description" : "Select types for the given Near-RT RIC identity.", @@ -205,7 +210,7 @@ }, "style" : "form" }, { - "description" : "Select types with the given type name (type identity has the format <typename_version>)", + "description" : "Select types compatible with the given type name (type identity has the format 'typename_version')", "explode" : true, "in" : "query", "name" : "typeName", @@ -215,7 +220,7 @@ }, "style" : "form" }, { - "description" : "Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.", + "description" : "Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.\n", "explode" : true, "in" : "query", "name" : "compatibleWithVersion", @@ -346,12 +351,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Get A1 Policy Types (getPolicyTypes)", "tags" : [ "A1 Policy Management" ] } }, "/policy-types/{policyTypeId}" : { "get" : { - "description" : "Returns a policy type definition", + "description" : "Get an A1 Policy Type definition using its policy type ID", "operationId" : "getPolicyTypeDefinition", "parameters" : [ { "explode" : false, @@ -388,7 +394,7 @@ } } }, - "description" : "OK - schema of the given policy type" + "description" : "OK - details and schema of the requested A1 Policy Type" }, "400" : { "content" : { @@ -481,12 +487,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy Type definition (getPolicyTypeDefinition)", "tags" : [ "A1 Policy Management" ] } }, "/policies/{policyId}" : { "delete" : { - "description" : "Deleting the policy using policyId.", + "description" : "Delete an existing A1 Policy instance using its policy ID.", "operationId" : "deletePolicy", "parameters" : [ { "explode" : false, @@ -579,7 +586,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -629,11 +636,11 @@ "description" : "Service Unavailable" } }, - "summary" : "Delete a policy", + "summary" : "Delete an A1 Policy instance (deletePolicy)", "tags" : [ "A1 Policy Management" ] }, "get" : { - "description" : "Returns a policy", + "description" : "Get an A1 Policy instance's policy data using its policy ID", "operationId" : "getPolicy", "parameters" : [ { "explode" : false, @@ -763,10 +770,11 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy's policy data (getPolicy)", "tags" : [ "A1 Policy Management" ] }, "put" : { - "description" : "update a policy", + "description" : "Update an existing A1 Policy instance's policy data using its policy ID.", "operationId" : "putPolicy", "parameters" : [ { "explode" : false, @@ -890,7 +898,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -940,12 +948,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Update an A1 Policy's policy data (putPolicy)", "tags" : [ "A1 Policy Management" ] } }, "/policies/{policyId}/status" : { "get" : { - "description" : "Query a policy status", + "description" : "Retrieve the status information for an A1 Policy Instance using its policy ID.", "operationId" : "getPolicyStatus", "parameters" : [ { "explode" : false, @@ -1070,15 +1079,16 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy Instance's status (getPolicyStatus)", "tags" : [ "A1 Policy Management" ] } }, "/policies" : { "get" : { - "description" : "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.", + "description" : "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.\n", "operationId" : "getAllPolicies", "parameters" : [ { - "description" : "Select policies of a given policy type identity.", + "description" : "Select policies with a given A1 Policy Type ID.", "explode" : true, "in" : "query", "name" : "policyTypeId", @@ -1088,7 +1098,7 @@ }, "style" : "form" }, { - "description" : "Select policies of a given Near-RT RIC identity.", + "description" : "Select policies for a given Near-RT RIC identity.", "explode" : true, "in" : "query", "name" : "nearRtRicId", @@ -1098,7 +1108,7 @@ }, "style" : "form" }, { - "description" : "Select policies owned by a given service.", + "description" : "Select policies owned by a given service (registered or unregistered).", "explode" : true, "in" : "query", "name" : "serviceId", @@ -1108,7 +1118,7 @@ }, "style" : "form" }, { - "description" : "Select policies of types with the given type name (type identity has the format <typename_version>)", + "description" : "Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').", "explode" : true, "in" : "query", "name" : "typeName", @@ -1234,11 +1244,11 @@ "description" : "Service Unavailable" } }, - "summary" : "Query policy identities", + "summary" : "Query for A1 Policy instances (getAllPolicies)", "tags" : [ "A1 Policy Management" ] }, "post" : { - "description" : "To create A1 policies", + "description" : "Create an A1 Policy Instance", "operationId" : "createPolicy", "requestBody" : { "content" : { @@ -1262,7 +1272,7 @@ "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", "explode" : false, "required" : true, "schema" : { @@ -1377,7 +1387,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -1427,12 +1437,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Create an A1 Policy Instance (createPolicy)", "tags" : [ "A1 Policy Management" ] } }, "/configuration" : { "get" : { - "description" : "Returns the contents of the application configuration", + "description" : "Returns the entire contents of the Application Configuration.", "operationId" : "getConfiguration", "responses" : { "200" : { @@ -1456,10 +1467,11 @@ "description" : "Not Found" } }, + "summary" : "Get the Application Configuration (getConfiguration)", "tags" : [ "Configuration" ] }, "put" : { - "description" : "Replace the current configuration file with the given configuration", + "description" : "Replace the current Application Configuration with a new configuration. The new configuration, if accepted, will take effect after a short delay. The new configuration must comply with the Application Configuration schema, which can be found from the the Application Documentation (Developer Guide) \n", "operationId" : "putConfiguration", "requestBody" : { "content" : { @@ -1493,12 +1505,13 @@ "description" : "Bad Request" } }, + "summary" : "Set/Replace the Application Configuration (putConfiguration)", "tags" : [ "Configuration" ] } }, "/services/{serviceId}/keepalive" : { "put" : { - "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)", + "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.", "operationId" : "keepAliveService", "parameters" : [ { "explode" : false, @@ -1553,16 +1566,16 @@ "description" : "Not Found" } }, - "summary" : "Heartbeat indicates that the service is running", + "summary" : "Heartbeat message from a service (keepAliveService)", "tags" : [ "Service Registry and Supervision" ] } }, "/services" : { "get" : { - "description" : "Either information about a registered service with given identity or all registered services are returned.", + "description" : "Get information about all registered services, or a single registered service. If the service ID of a registered service is included in the query, information about that service is returned. Otherwise Information about all registered is returned. This operation does not retrieve information about unregistered services.\n", "operationId" : "getServices", "parameters" : [ { - "description" : "The identity of the service", + "description" : "The identity of the registered service", "explode" : true, "in" : "query", "name" : "serviceId", @@ -1610,7 +1623,7 @@ "description" : "Not Found" } }, - "summary" : "Returns service information", + "summary" : "Get Services (getServices)", "tags" : [ "Service Registry and Supervision" ] }, "put" : { @@ -1618,7 +1631,7 @@ "RICStatus" : { "{$request.body#/callback_url}" : { "post" : { - "description" : "The URL to this call is registered at Service registration. <br>Callouts to indicate status changes relevant for Services. Note that these calls are called by A1-PMS and they are not provided.", + "description" : "Callouts to indicate Near-RT RIC status changes relevant for Services. \nThe URL invoked by this callback is provided at Service registration.\n", "operationId" : "serviceCallback", "requestBody" : { "content" : { @@ -1652,12 +1665,13 @@ "description" : "Not Found" } }, - "summary" : "Callback for Near-RT RIC status." + "summary" : "Callback for Near-RT RIC status (serviceCallback)", + "tags" : [ "Service Registry and Supervision" ] } } } }, - "description" : "Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><li>Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.</li></ul>Policies can be created even if the service is not registerred. This is a feature which it is optional to use.", + "description" : "Register a single service, or update a previous registration. Service registration is required to get callbacks about available NearRT RICs and to enable supervision of the service's active status. If a registered service becomes inactive, its policies can be automatically deleted. A1 Policy instances can also be created for unregistered services. If an unregistered service is later registered, the service's policies are retained when the service becomes registered. This feature is optional to use.\n", "operationId" : "putService", "requestBody" : { "content" : { @@ -1701,13 +1715,13 @@ "description" : "Bad Request" } }, - "summary" : "Register a service", + "summary" : "Register or update a Service (putService)", "tags" : [ "Service Registry and Supervision" ] } }, "/services/{serviceId}" : { "delete" : { - "description" : "Unregister a service", + "description" : "Unregister a registered Service using its service ID. Only registered services can be unregistered. All A1 Policy Instances for the previously registered service will be removed.\n", "operationId" : "deleteService", "parameters" : [ { "explode" : false, @@ -1752,6 +1766,7 @@ "description" : "Not Found" } }, + "summary" : "Unregister a Service (deleteService)", "tags" : [ "Service Registry and Supervision" ] } } @@ -1762,43 +1777,43 @@ "description" : "List of service information", "value" : { "serviceList" : [ { - "callbackUrl" : "callbackUrl", - "serviceId" : "serviceId", + "callbackUrl" : "http://callback.url", + "serviceId" : "serviceId1", "keepAliveIntervalSeconds" : 0, "timeSinceLastActivitySeconds" : 6 }, { - "callbackUrl" : "callbackUrl", - "serviceId" : "serviceId", - "keepAliveIntervalSeconds" : 0, - "timeSinceLastActivitySeconds" : 6 + "callbackUrl" : "http://callback.url", + "serviceId" : "serviceId2", + "keepAliveIntervalSeconds" : 500, + "timeSinceLastActivitySeconds" : 401 } ] } }, "StatusInfo" : { "value" : { - "status" : "status" + "status" : "success" } }, "RicInfo" : { "value" : { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId1", + "managedElementIds" : [ "Note #1", "Athlone small cells", "Some optional string" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] } }, "RicInfoList" : { "value" : { "rics" : [ { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId1", + "managedElementIds" : [ "Note #1", "Athlone small cells", "Fake Cells" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] }, { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId2", + "managedElementIds" : [ "My test element", "Another test element" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId3", "policyTypeId4" ] } ] } }, @@ -1847,16 +1862,16 @@ "PolicyTypeInformation" : { "value" : [ { "policyTypeId" : "STD_QOS2_0.1.0", - "nearRtRicId" : "ricsim_g3_2" + "nearRtRicId" : "ric_g3_2" }, { "policyTypeId" : "STD_QOS_0_2_0", - "nearRtRicId" : "ricsim_g3_2" + "nearRtRicId" : "ric_g3_2" }, { "policyTypeId" : "STD_QOS2_0.1.0", - "nearRtRicId" : "ricsim_g3_1" + "nearRtRicId" : "ric_g3_1" }, { "policyTypeId" : "STD_QOS_0_2_0", - "nearRtRicId" : "ricsim_g3_1" + "nearRtRicId" : "ric_g3_1" } ] }, "PolicyTypeObject" : { @@ -2042,7 +2057,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -2054,14 +2069,14 @@ }, "schemas" : { "PolicyTypeInformation" : { - "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" }, "properties" : { "policyTypeId" : { - "description" : "Identity of the policy type", + "description" : "A1 Policy Type identifier", "type" : "string" }, "nearRtRicId" : { @@ -2072,36 +2087,36 @@ "type" : "object" }, "PolicyObjectInformation" : { - "description" : "Information related to the creation of the policy", + "description" : "Information to create an A1 Policy Instance", "properties" : { "nearRtRicId" : { "description" : "Identity of the target Near-RT RIC", - "example" : "Near-RT-Ric-ID", + "example" : "Near-RT-Ric-ID1", "type" : "string" }, "transient" : { "default" : false, - "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, "type" : "boolean" }, "policyId" : { - "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", "type" : "string" }, "serviceId" : { "default" : "", - "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", "type" : "string" }, "policyObject" : { "$ref" : "#/components/schemas/PolicyObject" }, "policyTypeId" : { - "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)'", "type" : "string" } }, @@ -2112,7 +2127,7 @@ "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807", "properties" : { "detail" : { - "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", "type" : "string" }, @@ -2122,7 +2137,7 @@ "type" : "string" }, "status" : { - "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", "example" : 404, "format" : "int32", "type" : "integer" @@ -2131,16 +2146,16 @@ "type" : "object" }, "PolicyObject" : { - "description" : "Policy Object is a JSON representation of an A1 policy", + "description" : "Policy Object is a JSON representation policy data for an A1 Policy Instance. The schema for this policy data is defined in the corresponding A1 Policy Type. \n", "type" : "object" }, "PolicyTypeObject" : { - "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" : { @@ -2171,7 +2186,7 @@ "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" : { @@ -2197,15 +2212,15 @@ "type" : "object" }, "PolicySchema" : { - "description" : "The schemas are policy type specific", + "description" : "A schema to define the policy data contents of A1 Policy Instances. Policy data schemas are Policy Type specific. All A1 Policy Instances of an A1 Policy Type should comply with the type's policy data schema.\n", "type" : "object" }, "StatusSchema" : { - "description" : "The optional schema for policy status", + "description" : "A schema to define the contents of the status information for A1 Policy Instances. Status schemas are Policy Type specific. All status information for all A1 Policy Instances of an A1 Policy Type should comply with the type's status schema.\n", "type" : "object" }, "PolicyStatusObject" : { - "description" : "A generic policy status object that can be used to transport any policy status. Additionally, a policy status shall be valid according to the schema of its specific policy type.", + "description" : "A generic policy status object that can be used to transport any policy status. Additionally, a schema for policy status can be defined in the corresponding A1 Policy Type.\n", "type" : "object" }, "void" : { @@ -2215,7 +2230,7 @@ "StatusInfo" : { "properties" : { "status" : { - "description" : "status text", + "description" : "Status text", "type" : "string" } }, @@ -2229,22 +2244,22 @@ "type" : "string" }, "managedElementIds" : { - "description" : "O1 identities for managed entities", + "description" : "Identities for managed entities", "items" : { - "description" : "O1 identities for managed entities", + "description" : "Identity for a managed entity", "type" : "string" }, "type" : "array" }, "state" : { - "description" : "Represents the states for a Near-RT RIC", + "description" : "Represents the state of a Near-RT RIC", "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ], "type" : "string" }, "policyTypeIds" : { - "description" : "supported policy types", + "description" : "Supported A1 Policy Types", "items" : { - "description" : "supported policy types", + "description" : "Supported A1 Policy Type ID", "type" : "string" }, "type" : "array" @@ -2253,10 +2268,10 @@ "type" : "object" }, "ServiceRegistrationInfo" : { - "description" : "Information for one service", + "description" : "Information for a service to be registered", "properties" : { "callbackUrl" : { - "description" : "callback for notifying of Near-RT RIC state changes", + "description" : "Callback URL for notifying of Near-RT RIC state changes", "type" : "string" }, "serviceId" : { @@ -2264,7 +2279,7 @@ "type" : "string" }, "keepAliveIntervalSeconds" : { - "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", "type" : "integer" } @@ -2273,9 +2288,10 @@ "type" : "object" }, "ServiceStatus" : { + "description" : "Information about a previously registered service", "properties" : { "callbackUrl" : { - "description" : "callback for notifying of RIC synchronization", + "description" : "Callback URL for notifying of Near-RT RIC state changes", "type" : "string" }, "serviceId" : { @@ -2283,12 +2299,12 @@ "type" : "string" }, "keepAliveIntervalSeconds" : { - "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", "type" : "integer" }, "timeSinceLastActivitySeconds" : { - "description" : "time since last invocation by the service", + "description" : "Time (seconds) since last recorded operation by the service", "format" : "int64", "type" : "integer" } @@ -2296,10 +2312,10 @@ "type" : "object" }, "RicInfoList" : { - "description" : "List of Near-RT RIC information", + "description" : "Collection of Near-RT RIC information objects", "properties" : { "rics" : { - "description" : "List of Near-RT RIC information", + "description" : "List of Near-RT RIC information objects", "items" : { "$ref" : "#/components/schemas/RicInfo" }, @@ -2309,14 +2325,14 @@ "type" : "object" }, "NearRtRicId" : { - "description" : "Identity of the policy", + "description" : "Identity of the Near-RT RIC", "type" : "string" }, "PolicyInformation" : { - "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", "properties" : { "policyId" : { - "description" : "Identity of the policy", + "description" : "Identity of the A1 Policy Instance", "type" : "string" }, "nearRtRicId" : { @@ -2329,7 +2345,7 @@ "ServiceStatusList" : { "properties" : { "serviceList" : { - "description" : "List of service information", + "description" : "List of Service Status objects, describing a collection of registered services.", "items" : { "$ref" : "#/components/schemas/ServiceStatus" }, @@ -2339,14 +2355,14 @@ "type" : "object" }, "ServiceCallbackInfo" : { - "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", "properties" : { "ricId" : { "description" : "Identity of a Near-RT RIC", "type" : "string" }, "eventType" : { - "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" ], "type" : "string" } @@ -2355,22 +2371,22 @@ "type" : "object" }, "ProblemDetails" : { - "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", "properties" : { "type" : { - "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", "type" : "string" }, "title" : { - "description" : "human-readable summary of the problem type", + "description" : "Human-readable summary of the problem type", "type" : "string" }, "status" : { - "description" : "the HTTP status code", + "description" : "HTTP status code", "type" : "number" }, "detail" : { - "description" : "human-readable explanation ", + "description" : "Human-readable explanation", "type" : "string" }, "instance" : { diff --git a/a1-policy-management/api/offeredapis/swagger/pms-api-v3.json b/a1-policy-management/api/offeredapis/swagger/pms-api-v3.json index f2141968..ec085700 100644 --- a/a1-policy-management/api/offeredapis/swagger/pms-api-v3.json +++ b/a1-policy-management/api/offeredapis/swagger/pms-api-v3.json @@ -5,39 +5,43 @@ "email" : "discuss-list@onap.com", "url" : "https://www.onap.org/" }, - "description" : "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p>", + "description" : "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies. <br/>This document describes the latest API set to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2> <p>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.'</p> <h3>A1 Policy Management</h3> <p>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:</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy Types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3> <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3> <p>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.</p>", "license" : { "name" : "Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License.", "url" : "http://www.apache.org/licenses/LICENSE-2.0" }, - "title" : "A1 policy management API", + "title" : "ONAP CCSDK - A1 Policy Management API", "version" : "1.0.0", - "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8", + "x-api-id" : "e9776a07-0813-4fca-9801-6f892f0a7c13", "x-audience" : "external-public" }, + "externalDocs" : { + "description" : "Based on parts of O-RAN ALLIANCE specification: O-RAN.WG2.R1AP-v07.00", + "url" : "https://www.o-ran.org/specifications" + }, "servers" : [ { "url" : "{apiRoot}/a1-policy-management/v1", "variables" : { "apiRoot" : { "default" : "https://example.com", - "description" : "This is the Host:Port or Address where the A1-Policy Management Service can be accessed. Note: This URL path format aligns with the O-RAN Alliance (r) R1-AP specifiactions for A1 Policy Management" + "description" : "This is the Host:Port or Address where the A1-Policy Management Service can be accessed. Note: This URL path format aligns with the O-RAN Alliance R1-AP specifications for A1 Policy Management" } } } ], "tags" : [ { - "description" : "**(Newer Version)** API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances.", + "description" : "API used to get, create, update and delete A1 Policy Instances. Also used to query A1 Policy Types.\n", "name" : "A1 Policy Management" }, { - "description" : "API used to get the NearRT-RIC for the managed element.", + "description" : "API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "API used to keep the service Alive with in the timeout period", + "description" : "API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { - "description" : "API used to get the health status and statistics of this service", + "description" : "API used to get the health status and statistics of this service.\n", "name" : "Health Check" }, { - "description" : "API used to create or fetch the application configuration.", + "description" : "API used to create or fetch the application configuration.\n", "name" : "Configuration" } ], "paths" : { @@ -72,12 +76,13 @@ "description" : "Not Found" } }, + "summary" : "Get Status (getStatus)", "tags" : [ "Health Check" ] } }, "/rics/{ricId}" : { "get" : { - "description" : "A ricId path parameter must be specified to retrieve associated ric infomation", + "description" : "Get information about a Near-RT RIC", "operationId" : "getRic", "parameters" : [ { "description" : "The identity of a Near-RT RIC to get information for.", @@ -89,7 +94,7 @@ "nullable" : false, "type" : "string" }, - "style" : "form" + "style" : "simple" }, { "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", "explode" : false, @@ -129,16 +134,16 @@ "description" : "Not Found" } }, - "summary" : "Returns info for one Near-RT RIC", + "summary" : "Get a Near-RT RIC (getRic)", "tags" : [ "NearRT-RIC Repository" ] } }, "/rics" : { "get" : { - "description" : "The call returns all Near-RT RICs that supports a given policy type identity", + "description" : "Get all Near-RT RICs that supports a given A1 Policy Type ID", "operationId" : "getRics", "parameters" : [ { - "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned", + "description" : "The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.\n", "explode" : true, "in" : "query", "name" : "policyTypeId", @@ -186,13 +191,13 @@ "description" : "Not Found" } }, - "summary" : "Query Near-RT RIC information", + "summary" : "Get Near-RT RICs for A1 Policy Type (getRics)", "tags" : [ "NearRT-RIC Repository" ] } }, "/policy-types" : { "get" : { - "description" : "Query policy type identities", + "description" : "Query A1 Policy Type identities using query parameters", "operationId" : "getPolicyTypes", "parameters" : [ { "description" : "Select types for the given Near-RT RIC identity.", @@ -205,7 +210,7 @@ }, "style" : "form" }, { - "description" : "Select types with the given type name (type identity has the format <typename_version>)", + "description" : "Select types compatible with the given type name (type identity has the format 'typename_version')", "explode" : true, "in" : "query", "name" : "typeName", @@ -215,7 +220,7 @@ }, "style" : "form" }, { - "description" : "Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.", + "description" : "Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.\n", "explode" : true, "in" : "query", "name" : "compatibleWithVersion", @@ -346,12 +351,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Get A1 Policy Types (getPolicyTypes)", "tags" : [ "A1 Policy Management" ] } }, "/policy-types/{policyTypeId}" : { "get" : { - "description" : "Returns a policy type definition", + "description" : "Get an A1 Policy Type definition using its policy type ID", "operationId" : "getPolicyTypeDefinition", "parameters" : [ { "explode" : false, @@ -388,7 +394,7 @@ } } }, - "description" : "OK - schema of the given policy type" + "description" : "OK - details and schema of the requested A1 Policy Type" }, "400" : { "content" : { @@ -481,12 +487,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy Type definition (getPolicyTypeDefinition)", "tags" : [ "A1 Policy Management" ] } }, "/policies/{policyId}" : { "delete" : { - "description" : "Deleting the policy using policyId.", + "description" : "Delete an existing A1 Policy instance using its policy ID.", "operationId" : "deletePolicy", "parameters" : [ { "explode" : false, @@ -579,7 +586,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -629,11 +636,11 @@ "description" : "Service Unavailable" } }, - "summary" : "Delete a policy", + "summary" : "Delete an A1 Policy instance (deletePolicy)", "tags" : [ "A1 Policy Management" ] }, "get" : { - "description" : "Returns a policy", + "description" : "Get an A1 Policy instance's policy data using its policy ID", "operationId" : "getPolicy", "parameters" : [ { "explode" : false, @@ -763,10 +770,11 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy's policy data (getPolicy)", "tags" : [ "A1 Policy Management" ] }, "put" : { - "description" : "update a policy", + "description" : "Update an existing A1 Policy instance's policy data using its policy ID.", "operationId" : "putPolicy", "parameters" : [ { "explode" : false, @@ -890,7 +898,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -940,12 +948,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Update an A1 Policy's policy data (putPolicy)", "tags" : [ "A1 Policy Management" ] } }, "/policies/{policyId}/status" : { "get" : { - "description" : "Query a policy status", + "description" : "Retrieve the status information for an A1 Policy Instance using its policy ID.", "operationId" : "getPolicyStatus", "parameters" : [ { "explode" : false, @@ -1070,15 +1079,16 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy Instance's status (getPolicyStatus)", "tags" : [ "A1 Policy Management" ] } }, "/policies" : { "get" : { - "description" : "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.", + "description" : "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.\n", "operationId" : "getAllPolicies", "parameters" : [ { - "description" : "Select policies of a given policy type identity.", + "description" : "Select policies with a given A1 Policy Type ID.", "explode" : true, "in" : "query", "name" : "policyTypeId", @@ -1088,7 +1098,7 @@ }, "style" : "form" }, { - "description" : "Select policies of a given Near-RT RIC identity.", + "description" : "Select policies for a given Near-RT RIC identity.", "explode" : true, "in" : "query", "name" : "nearRtRicId", @@ -1098,7 +1108,7 @@ }, "style" : "form" }, { - "description" : "Select policies owned by a given service.", + "description" : "Select policies owned by a given service (registered or unregistered).", "explode" : true, "in" : "query", "name" : "serviceId", @@ -1108,7 +1118,7 @@ }, "style" : "form" }, { - "description" : "Select policies of types with the given type name (type identity has the format <typename_version>)", + "description" : "Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').", "explode" : true, "in" : "query", "name" : "typeName", @@ -1234,11 +1244,11 @@ "description" : "Service Unavailable" } }, - "summary" : "Query policy identities", + "summary" : "Query for A1 Policy instances (getAllPolicies)", "tags" : [ "A1 Policy Management" ] }, "post" : { - "description" : "To create A1 policies", + "description" : "Create an A1 Policy Instance", "operationId" : "createPolicy", "requestBody" : { "content" : { @@ -1262,7 +1272,7 @@ "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", "explode" : false, "required" : true, "schema" : { @@ -1377,7 +1387,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -1427,12 +1437,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Create an A1 Policy Instance (createPolicy)", "tags" : [ "A1 Policy Management" ] } }, "/configuration" : { "get" : { - "description" : "Returns the contents of the application configuration", + "description" : "Returns the entire contents of the Application Configuration.", "operationId" : "getConfiguration", "responses" : { "200" : { @@ -1456,10 +1467,11 @@ "description" : "Not Found" } }, + "summary" : "Get the Application Configuration (getConfiguration)", "tags" : [ "Configuration" ] }, "put" : { - "description" : "Replace the current configuration file with the given configuration", + "description" : "Replace the current Application Configuration with a new configuration. The new configuration, if accepted, will take effect after a short delay. The new configuration must comply with the Application Configuration schema, which can be found from the the Application Documentation (Developer Guide) \n", "operationId" : "putConfiguration", "requestBody" : { "content" : { @@ -1493,12 +1505,13 @@ "description" : "Bad Request" } }, + "summary" : "Set/Replace the Application Configuration (putConfiguration)", "tags" : [ "Configuration" ] } }, "/services/{serviceId}/keepalive" : { "put" : { - "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)", + "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.", "operationId" : "keepAliveService", "parameters" : [ { "explode" : false, @@ -1553,16 +1566,16 @@ "description" : "Not Found" } }, - "summary" : "Heartbeat indicates that the service is running", + "summary" : "Heartbeat message from a service (keepAliveService)", "tags" : [ "Service Registry and Supervision" ] } }, "/services" : { "get" : { - "description" : "Either information about a registered service with given identity or all registered services are returned.", + "description" : "Get information about all registered services, or a single registered service. If the service ID of a registered service is included in the query, information about that service is returned. Otherwise Information about all registered is returned. This operation does not retrieve information about unregistered services.\n", "operationId" : "getServices", "parameters" : [ { - "description" : "The identity of the service", + "description" : "The identity of the registered service", "explode" : true, "in" : "query", "name" : "serviceId", @@ -1610,7 +1623,7 @@ "description" : "Not Found" } }, - "summary" : "Returns service information", + "summary" : "Get Services (getServices)", "tags" : [ "Service Registry and Supervision" ] }, "put" : { @@ -1618,7 +1631,7 @@ "RICStatus" : { "{$request.body#/callback_url}" : { "post" : { - "description" : "The URL to this call is registered at Service registration. <br>Callouts to indicate status changes relevant for Services. Note that these calls are called by A1-PMS and they are not provided.", + "description" : "Callouts to indicate Near-RT RIC status changes relevant for Services. \nThe URL invoked by this callback is provided at Service registration.\n", "operationId" : "serviceCallback", "requestBody" : { "content" : { @@ -1652,12 +1665,13 @@ "description" : "Not Found" } }, - "summary" : "Callback for Near-RT RIC status." + "summary" : "Callback for Near-RT RIC status (serviceCallback)", + "tags" : [ "Service Registry and Supervision" ] } } } }, - "description" : "Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><li>Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.</li></ul>Policies can be created even if the service is not registerred. This is a feature which it is optional to use.", + "description" : "Register a single service, or update a previous registration. Service registration is required to get callbacks about available NearRT RICs and to enable supervision of the service's active status. If a registered service becomes inactive, its policies can be automatically deleted. A1 Policy instances can also be created for unregistered services. If an unregistered service is later registered, the service's policies are retained when the service becomes registered. This feature is optional to use.\n", "operationId" : "putService", "requestBody" : { "content" : { @@ -1701,13 +1715,13 @@ "description" : "Bad Request" } }, - "summary" : "Register a service", + "summary" : "Register or update a Service (putService)", "tags" : [ "Service Registry and Supervision" ] } }, "/services/{serviceId}" : { "delete" : { - "description" : "Unregister a service", + "description" : "Unregister a registered Service using its service ID. Only registered services can be unregistered. All A1 Policy Instances for the previously registered service will be removed.\n", "operationId" : "deleteService", "parameters" : [ { "explode" : false, @@ -1752,6 +1766,7 @@ "description" : "Not Found" } }, + "summary" : "Unregister a Service (deleteService)", "tags" : [ "Service Registry and Supervision" ] } } @@ -1762,43 +1777,43 @@ "description" : "List of service information", "value" : { "serviceList" : [ { - "callbackUrl" : "callbackUrl", - "serviceId" : "serviceId", + "callbackUrl" : "http://callback.url", + "serviceId" : "serviceId1", "keepAliveIntervalSeconds" : 0, "timeSinceLastActivitySeconds" : 6 }, { - "callbackUrl" : "callbackUrl", - "serviceId" : "serviceId", - "keepAliveIntervalSeconds" : 0, - "timeSinceLastActivitySeconds" : 6 + "callbackUrl" : "http://callback.url", + "serviceId" : "serviceId2", + "keepAliveIntervalSeconds" : 500, + "timeSinceLastActivitySeconds" : 401 } ] } }, "StatusInfo" : { "value" : { - "status" : "status" + "status" : "success" } }, "RicInfo" : { "value" : { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId1", + "managedElementIds" : [ "Note #1", "Athlone small cells", "Some optional string" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] } }, "RicInfoList" : { "value" : { "rics" : [ { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId1", + "managedElementIds" : [ "Note #1", "Athlone small cells", "Fake Cells" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] }, { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId2", + "managedElementIds" : [ "My test element", "Another test element" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId3", "policyTypeId4" ] } ] } }, @@ -1847,16 +1862,16 @@ "PolicyTypeInformation" : { "value" : [ { "policyTypeId" : "STD_QOS2_0.1.0", - "nearRtRicId" : "ricsim_g3_2" + "nearRtRicId" : "ric_g3_2" }, { "policyTypeId" : "STD_QOS_0_2_0", - "nearRtRicId" : "ricsim_g3_2" + "nearRtRicId" : "ric_g3_2" }, { "policyTypeId" : "STD_QOS2_0.1.0", - "nearRtRicId" : "ricsim_g3_1" + "nearRtRicId" : "ric_g3_1" }, { "policyTypeId" : "STD_QOS_0_2_0", - "nearRtRicId" : "ricsim_g3_1" + "nearRtRicId" : "ric_g3_1" } ] }, "PolicyTypeObject" : { @@ -2042,7 +2057,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -2054,14 +2069,14 @@ }, "schemas" : { "PolicyTypeInformation" : { - "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" }, "properties" : { "policyTypeId" : { - "description" : "Identity of the policy type", + "description" : "A1 Policy Type identifier", "type" : "string" }, "nearRtRicId" : { @@ -2072,36 +2087,36 @@ "type" : "object" }, "PolicyObjectInformation" : { - "description" : "Information related to the creation of the policy", + "description" : "Information to create an A1 Policy Instance", "properties" : { "nearRtRicId" : { "description" : "Identity of the target Near-RT RIC", - "example" : "Near-RT-Ric-ID", + "example" : "Near-RT-Ric-ID1", "type" : "string" }, "transient" : { "default" : false, - "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, "type" : "boolean" }, "policyId" : { - "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", "type" : "string" }, "serviceId" : { "default" : "", - "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", "type" : "string" }, "policyObject" : { "$ref" : "#/components/schemas/PolicyObject" }, "policyTypeId" : { - "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)'", "type" : "string" } }, @@ -2112,7 +2127,7 @@ "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807", "properties" : { "detail" : { - "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", "type" : "string" }, @@ -2122,7 +2137,7 @@ "type" : "string" }, "status" : { - "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", "example" : 404, "format" : "int32", "type" : "integer" @@ -2131,16 +2146,16 @@ "type" : "object" }, "PolicyObject" : { - "description" : "Policy Object is a JSON representation of an A1 policy", + "description" : "Policy Object is a JSON representation policy data for an A1 Policy Instance. The schema for this policy data is defined in the corresponding A1 Policy Type. \n", "type" : "object" }, "PolicyTypeObject" : { - "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" : { @@ -2171,7 +2186,7 @@ "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" : { @@ -2197,15 +2212,15 @@ "type" : "object" }, "PolicySchema" : { - "description" : "The schemas are policy type specific", + "description" : "A schema to define the policy data contents of A1 Policy Instances. Policy data schemas are Policy Type specific. All A1 Policy Instances of an A1 Policy Type should comply with the type's policy data schema.\n", "type" : "object" }, "StatusSchema" : { - "description" : "The optional schema for policy status", + "description" : "A schema to define the contents of the status information for A1 Policy Instances. Status schemas are Policy Type specific. All status information for all A1 Policy Instances of an A1 Policy Type should comply with the type's status schema.\n", "type" : "object" }, "PolicyStatusObject" : { - "description" : "A generic policy status object that can be used to transport any policy status. Additionally, a policy status shall be valid according to the schema of its specific policy type.", + "description" : "A generic policy status object that can be used to transport any policy status. Additionally, a schema for policy status can be defined in the corresponding A1 Policy Type.\n", "type" : "object" }, "void" : { @@ -2215,7 +2230,7 @@ "StatusInfo" : { "properties" : { "status" : { - "description" : "status text", + "description" : "Status text", "type" : "string" } }, @@ -2229,22 +2244,22 @@ "type" : "string" }, "managedElementIds" : { - "description" : "O1 identities for managed entities", + "description" : "Identities for managed entities", "items" : { - "description" : "O1 identities for managed entities", + "description" : "Identity for a managed entity", "type" : "string" }, "type" : "array" }, "state" : { - "description" : "Represents the states for a Near-RT RIC", + "description" : "Represents the state of a Near-RT RIC", "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ], "type" : "string" }, "policyTypeIds" : { - "description" : "supported policy types", + "description" : "Supported A1 Policy Types", "items" : { - "description" : "supported policy types", + "description" : "Supported A1 Policy Type ID", "type" : "string" }, "type" : "array" @@ -2253,10 +2268,10 @@ "type" : "object" }, "ServiceRegistrationInfo" : { - "description" : "Information for one service", + "description" : "Information for a service to be registered", "properties" : { "callbackUrl" : { - "description" : "callback for notifying of Near-RT RIC state changes", + "description" : "Callback URL for notifying of Near-RT RIC state changes", "type" : "string" }, "serviceId" : { @@ -2264,7 +2279,7 @@ "type" : "string" }, "keepAliveIntervalSeconds" : { - "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", "type" : "integer" } @@ -2273,9 +2288,10 @@ "type" : "object" }, "ServiceStatus" : { + "description" : "Information about a previously registered service", "properties" : { "callbackUrl" : { - "description" : "callback for notifying of RIC synchronization", + "description" : "Callback URL for notifying of Near-RT RIC state changes", "type" : "string" }, "serviceId" : { @@ -2283,12 +2299,12 @@ "type" : "string" }, "keepAliveIntervalSeconds" : { - "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", "type" : "integer" }, "timeSinceLastActivitySeconds" : { - "description" : "time since last invocation by the service", + "description" : "Time (seconds) since last recorded operation by the service", "format" : "int64", "type" : "integer" } @@ -2296,10 +2312,10 @@ "type" : "object" }, "RicInfoList" : { - "description" : "List of Near-RT RIC information", + "description" : "Collection of Near-RT RIC information objects", "properties" : { "rics" : { - "description" : "List of Near-RT RIC information", + "description" : "List of Near-RT RIC information objects", "items" : { "$ref" : "#/components/schemas/RicInfo" }, @@ -2309,14 +2325,14 @@ "type" : "object" }, "NearRtRicId" : { - "description" : "Identity of the policy", + "description" : "Identity of the Near-RT RIC", "type" : "string" }, "PolicyInformation" : { - "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", "properties" : { "policyId" : { - "description" : "Identity of the policy", + "description" : "Identity of the A1 Policy Instance", "type" : "string" }, "nearRtRicId" : { @@ -2329,7 +2345,7 @@ "ServiceStatusList" : { "properties" : { "serviceList" : { - "description" : "List of service information", + "description" : "List of Service Status objects, describing a collection of registered services.", "items" : { "$ref" : "#/components/schemas/ServiceStatus" }, @@ -2339,14 +2355,14 @@ "type" : "object" }, "ServiceCallbackInfo" : { - "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", "properties" : { "ricId" : { "description" : "Identity of a Near-RT RIC", "type" : "string" }, "eventType" : { - "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" ], "type" : "string" } @@ -2355,22 +2371,22 @@ "type" : "object" }, "ProblemDetails" : { - "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", "properties" : { "type" : { - "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", "type" : "string" }, "title" : { - "description" : "human-readable summary of the problem type", + "description" : "Human-readable summary of the problem type", "type" : "string" }, "status" : { - "description" : "the HTTP status code", + "description" : "HTTP status code", "type" : "number" }, "detail" : { - "description" : "human-readable explanation ", + "description" : "Human-readable explanation", "type" : "string" }, "instance" : { diff --git a/a1-policy-management/api/offeredapis/swagger/pms-api-v3.yaml b/a1-policy-management/api/offeredapis/swagger/pms-api-v3.yaml index 4df9d61a..e08bea1a 100644 --- a/a1-policy-management/api/offeredapis/swagger/pms-api-v3.yaml +++ b/a1-policy-management/api/offeredapis/swagger/pms-api-v3.yaml @@ -1,5 +1,6 @@ # ============LICENSE_START======================================================= -# Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. All rights reserved. +# Copyright (C) 2020-2023 Nordix Foundation. 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. @@ -18,62 +19,76 @@ openapi: 3.0.3 info: - title: 'A1 policy management API' + title: ONAP CCSDK - A1 Policy Management API version: 1.0.0 - x-api-id: a31c510b-20e6-4a08-af16-368c44d7fba8 + x-api-id: e9776a07-0813-4fca-9801-6f892f0a7c13 x-audience: external-public description: "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service\ - \ provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the\ - \ service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring\ - \ and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining\ - \ a view of supported Near-RT RIC policy types</li><li>Supervision of using services\ - \ (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs\ - \ provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This\ - \ is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation,\ - \ modification and deletion.</li><li>Retrieval of supported A1 Policy types for\ - \ a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management\ - \ of configuration</h3><p>API for updating and retrieval of the component configuration.\ - \ Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These\ - \ are endpoints that are invoked by this service. The callbacks are registered\ - \ in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This\ - \ is an API that provides support for looking up a NearRT-RIC. Each A1 policy\ - \ is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision\ - \ of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p>" + \ provides a REST API for managing A1 policies. <br/>This document describes the latest API set + \ to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring\ + \ and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining\ + \ a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services\ + \ (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs\ + \ provided or defined by the service</h2>\ + \ <p>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.'</p>\ + \ <h3>A1 Policy Management</h3>\ + \ <p>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:</p><ul><li>A1 Policy retrieval, creation,\ + \ modification and deletion.</li><li>Retrieval of supported A1 Policy Types for\ + \ a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management\ + \ of configuration</h3><p>API for updating and retrieval of the component configuration.\ + \ Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These\ + \ are endpoints that are invoked by this service. The callbacks are registered\ + \ in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3>\ + \ <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy\ + \ is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision\ + \ of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3>\ + \ <p>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.</p>" license: name: Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License. url: http://www.apache.org/licenses/LICENSE-2.0 contact: url: https://www.onap.org/ email: discuss-list@onap.com +externalDocs: + description: 'Based on parts of O-RAN ALLIANCE specification: O-RAN.WG2.R1AP-v07.00' + url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/a1-policy-management/v1' variables: apiRoot: default: 'https://example.com' description: 'This is the Host:Port or Address where the A1-Policy Management Service can be accessed. - Note: This URL path format aligns with the O-RAN Alliance (r) R1-AP specifiactions for A1 Policy Management' + Note: This URL path format aligns with the O-RAN Alliance R1-AP specifications for A1 Policy Management' tags: - name: A1 Policy Management - description: "**(Newer Version)** API used to create polices, Policy Instances and get \ them as individual using an ID or get all policies/Instances." + description: > + API used to get, create, update and delete A1 Policy Instances. Also used to query A1 Policy Types. - name: NearRT-RIC Repository - description: "API used to get the NearRT-RIC for the managed element." + description: > + API used to get information about registered Near-RT RICs. - name: Service Registry and Supervision - description: "API used to keep the service Alive with in the timeout period" + description: > + API used to manage registered services, and control their keep-alive status via heart-beat messages. - name: Health Check - description: "API used to get the health status and statistics of this service" + description: > + API used to get the health status and statistics of this service. - name: Configuration - description: "API used to create or fetch the application configuration." + description: > + API used to create or fetch the application configuration. paths: /status: get: operationId: getStatus + description: Returns status and statistics of this service + summary: Get Status (getStatus) + tags: + - Health Check responses: "200": content: @@ -86,13 +101,13 @@ paths: description: OK- Service is living Ok "404": $ref: '#/components/responses/404' - description: Returns status and statistics of this service - tags: - - Health Check /rics/{ricId}: get: - description: A ricId path parameter must be specified to retrieve associated ric infomation operationId: getRic + description: Get information about a Near-RT RIC + summary: Get a Near-RT RIC (getRic) + tags: + - NearRT-RIC Repository parameters: - description: The identity of a Near-RT RIC to get information for. explode: true @@ -102,7 +117,6 @@ paths: schema: type: string nullable: false - style: form - description: Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. in: header @@ -122,16 +136,17 @@ paths: description: OK - Near-RT RIC is found OK "404": $ref: '#/components/responses/404' - summary: Returns info for one Near-RT RIC - tags: - - NearRT-RIC Repository /rics: get: - description: The call returns all Near-RT RICs that supports a given policy - type identity operationId: getRics + description: Get all Near-RT RICs that supports a given A1 Policy Type ID + summary: Get Near-RT RICs for A1 Policy Type (getRics) + tags: + - NearRT-RIC Repository parameters: - - description: "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned" + - description: > + The identity of an A1 Policy Type. If given, all Near-RT RICs supporting + the A1 Policy Type are returned. explode: true in: query name: policyTypeId @@ -158,12 +173,13 @@ paths: description: OK "404": $ref: '#/components/responses/404' - summary: Query Near-RT RIC information - tags: - - NearRT-RIC Repository /policy-types: get: + description: Query A1 Policy Type identities using query parameters operationId: getPolicyTypes + summary: Get A1 Policy Types (getPolicyTypes) + tags: + - A1 Policy Management parameters: - description: Select types for the given Near-RT RIC identity. explode: true @@ -173,8 +189,7 @@ paths: schema: type: string style: form - - description: Select types with the given type name (type identity has the - format <typename_version>) + - description: Select types compatible with the given type name (type identity has the format 'typename_version') explode: true in: query name: typeName @@ -182,8 +197,9 @@ paths: schema: type: string style: form - - description: Select types that are compatible with the given version. This - parameter is only applicable in conjunction with type_name. As an example + - description: > + Select types that are compatible with the given version. This + parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. explode: true @@ -230,12 +246,13 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: Query policy type identities - tags: - - A1 Policy Management /policy-types/{policyTypeId}: get: operationId: getPolicyTypeDefinition + description: Get an A1 Policy Type definition using its policy type ID + summary: Get an A1 Policy Type definition (getPolicyTypeDefinition) + tags: + - A1 Policy Management parameters: - explode: false in: path @@ -260,7 +277,7 @@ paths: examples: PolicyTypeObject: $ref: '#/components/examples/PolicyTypeObject' - description: OK - schema of the given policy type + description: OK - details and schema of the requested A1 Policy Type '400': $ref: '#/components/responses/400' '401': @@ -279,12 +296,13 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: Returns a policy type definition - tags: - - A1 Policy Management /policies/{policyId}: put: operationId: putPolicy + description: Update an existing A1 Policy instance's policy data using its policy ID. + summary: Update an A1 Policy's policy data (putPolicy) + tags: + - A1 Policy Management parameters: - name: policyId in: path @@ -333,12 +351,12 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: update a policy - tags: - - A1 Policy Management delete: - description: Deleting the policy using policyId. operationId: deletePolicy + description: Delete an existing A1 Policy instance using its policy ID. + summary: Delete an A1 Policy instance (deletePolicy) + tags: + - A1 Policy Management parameters: - explode: false in: path @@ -379,11 +397,12 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - summary: Delete a policy - tags: - - A1 Policy Management get: operationId: getPolicy + description: Get an A1 Policy instance's policy data using its policy ID + summary: Get an A1 Policy's policy data (getPolicy) + tags: + - A1 Policy Management parameters: - explode: false in: path @@ -427,12 +446,13 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: Returns a policy - tags: - - A1 Policy Management /policies/{policyId}/status: get: operationId: getPolicyStatus + description: Retrieve the status information for an A1 Policy Instance using its policy ID. + summary: Get an A1 Policy Instance's status (getPolicyStatus) + tags: + - A1 Policy Management parameters: - explode: false in: path @@ -473,18 +493,17 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: 'Query a policy status' - tags: - - A1 Policy Management - /policies: get: - description: "Returns a list of A1 policies matching given search criteria.\ - \ <br>If several query parameters are defined, the policies matching all conditions\ - \ are returned." operationId: getAllPolicies + description: > + 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. + summary: Query for A1 Policy instances (getAllPolicies) + tags: + - A1 Policy Management parameters: - - description: Select policies of a given policy type identity. + - description: Select policies with a given A1 Policy Type ID. explode: true in: query name: policyTypeId @@ -492,7 +511,7 @@ paths: schema: type: string style: form - - description: Select policies of a given Near-RT RIC identity. + - description: Select policies for a given Near-RT RIC identity. explode: true in: query name: nearRtRicId @@ -500,7 +519,7 @@ paths: schema: type: string style: form - - description: Select policies owned by a given service. + - description: Select policies owned by a given service (registered or unregistered). explode: true in: query name: serviceId @@ -508,8 +527,7 @@ paths: schema: type: string style: form - - description: Select policies of types with the given type name (type identity - has the format <typename_version>) + - description: Select policies of a given A1 Policy Type name (type identity has the format 'typename_version'). explode: true in: query name: typeName @@ -551,11 +569,12 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - summary: Query policy identities - tags: - - A1 Policy Management post: operationId: createPolicy + description: Create an A1 Policy Instance + summary: Create an A1 Policy Instance (createPolicy) + tags: + - A1 Policy Management requestBody: required: true content: @@ -571,7 +590,10 @@ paths: $ref: '#/components/schemas/PolicyObjectInformation' 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. required: true schema: type: string @@ -609,12 +631,13 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: 'To create A1 policies' - tags: - - A1 Policy Management /configuration: get: operationId: getConfiguration + description: Returns the entire contents of the Application Configuration. + tags: + - Configuration + summary: Get the Application Configuration (getConfiguration) responses: "200": content: @@ -624,12 +647,16 @@ paths: description: OK - Application configuration received "404": $ref: '#/components/responses/404' - - description: Returns the contents of the application configuration - tags: - - Configuration put: operationId: putConfiguration + description: > + Replace the current Application Configuration with a new configuration. + The new configuration, if accepted, will take effect after a short delay. + The new configuration must comply with the Application Configuration schema, + which can be found from the the Application Documentation (Developer Guide) + tags: + - Configuration + summary: Set/Replace the Application Configuration (putConfiguration) requestBody: content: application/json: @@ -645,17 +672,19 @@ paths: description: OK - Configuration updated "400": $ref: '#/components/responses/400' - description: Replace the current configuration file with the given configuration - tags: - - Configuration /services/{serviceId}/keepalive: put: - description: A registered service should invoke this operation regularly to - indicate that it is still alive. If a registered service fails to invoke this - operation before the end of a timeout period the service will be deregistered - and all its A1 policies wil be removed. (This timeout can be set or disabled - when each service is initially registered) operationId: keepAliveService + description: A registered service should invoke this operation regularly to + indicate that it is still alive. If a registered service fails to invoke some operation, + or this operation, before the end of a timeout period the service will be deregistered + and all its A1 policies wil be removed and the service is deleted. + This operation is only intended for registered services. (This timeout can be set or disabled when + each service is initially registered). Unregistered services do not need to invoke this operation, + since the optional keep-alive monitoring feature can only be enabled for registered services. + summary: Heartbeat message from a service (keepAliveService) + tags: + - Service Registry and Supervision parameters: - explode: false in: path @@ -683,19 +712,22 @@ paths: 'application/json': schema: type: object - description: "OK - Service supervision timer refreshed, OK" + description: OK - Service supervision timer refreshed, OK "404": $ref: '#/components/responses/404' - summary: Heartbeat indicates that the service is running - tags: - - Service Registry and Supervision /services: get: - description: Either information about a registered service with given identity - or all registered services are returned. operationId: getServices + description: > + Get information about all registered services, or a single registered service. + If the service ID of a registered service is included in the query, information about that + service is returned. Otherwise Information about all registered is returned. + This operation does not retrieve information about unregistered services. + summary: Get Services (getServices) + tags: + - Service Registry and Supervision parameters: - - description: The identity of the service + - description: The identity of the registered service explode: true in: query name: serviceId @@ -722,16 +754,19 @@ paths: description: OK "404": $ref: '#/components/responses/404' - summary: Returns service information - tags: - - Service Registry and Supervision put: - description: "Registering a service is needed to:<ul><li>Get callbacks about\ - \ available NearRT RICs.</li><li>Activate supervision of the service. If a\ - \ service is inactive, its policies will automatically be deleted.</li></ul>Policies\ - \ can be created even if the service is not registerred. This is a feature\ - \ which it is optional to use." operationId: putService + description: > + Register a single service, or update a previous registration. + Service registration is required to get callbacks about available NearRT RICs + and to enable supervision of the service's active status. If a registered + service becomes inactive, its policies can be automatically deleted. + A1 Policy instances can also be created for unregistered services. + If an unregistered service is later registered, the service's policies are + retained when the service becomes registered. This feature is optional to use. + summary: Register or update a Service (putService) + tags: + - Service Registry and Supervision requestBody: content: application/json: @@ -753,15 +788,17 @@ paths: description: Created - Service created "400": $ref: '#/components/responses/400' - summary: Register a service - tags: - - Service Registry and Supervision callbacks: RICStatus: "{$request.body#/callback_url}": post: - description: 'The URL to this call is registered at Service registration. <br>Callouts to indicate status changes relevant for Services. Note that these calls are called by A1-PMS and they are not provided.' operationId: serviceCallback + description: | + Callouts to indicate Near-RT RIC status changes relevant for Services. + The URL invoked by this callback is provided at Service registration. + summary: Callback for Near-RT RIC status (serviceCallback) + tags: + - Service Registry and Supervision requestBody: content: application/json: @@ -777,10 +814,16 @@ paths: description: OK "404": $ref: '#/components/responses/404' - summary: "Callback for Near-RT RIC status." /services/{serviceId}: delete: operationId: deleteService + description: > + Unregister a registered Service using its service ID. + Only registered services can be unregistered. All A1 Policy Instances + for the previously registered service will be removed. + tags: + - Service Registry and Supervision + summary: Unregister a Service (deleteService) parameters: - explode: false in: path @@ -805,55 +848,56 @@ paths: description: No Content - Service unregistered "404": $ref: '#/components/responses/404' - description: Unregister a service - tags: - - Service Registry and Supervision + components: + examples: ServiceStatusList: description: List of service information value: serviceList: - - callbackUrl: callbackUrl - serviceId: serviceId - keepAliveIntervalSeconds: 0 - timeSinceLastActivitySeconds: 6 - - callbackUrl: callbackUrl - serviceId: serviceId + - callbackUrl: http://callback.url + serviceId: serviceId1 keepAliveIntervalSeconds: 0 timeSinceLastActivitySeconds: 6 + - callbackUrl: http://callback.url + serviceId: serviceId2 + keepAliveIntervalSeconds: 500 + timeSinceLastActivitySeconds: 401 StatusInfo: value: - status: status + status: success RicInfo: value: - ricId: ricId + ricId: ricId1 managedElementIds: - - managedElementId - - managedElementId + - "Note #1" + - "Athlone small cells" + - "Some optional string" state: UNAVAILABLE policyTypeIds: - - policyTypeId - - policyTypeId + - policyTypeId1 + - policyTypeId2 RicInfoList: value: rics: - - ricId: ricId + - ricId: ricId1 managedElementIds: - - managedElementId - - managedElementId + - "Note #1" + - "Athlone small cells" + - "Fake Cells" state: UNAVAILABLE policyTypeIds: - - policyTypeId - - policyTypeId - - ricId: ricId + - policyTypeId1 + - policyTypeId2 + - ricId: ricId2 managedElementIds: - - managedElementId - - managedElementId + - "My test element" + - "Another test element" state: UNAVAILABLE policyTypeIds: - - policyTypeId - - policyTypeId + - policyTypeId3 + - policyTypeId4 PolicyObject: value: scope: @@ -885,13 +929,13 @@ components: PolicyTypeInformation: value: - policyTypeId: STD_QOS2_0.1.0 - nearRtRicId: ricsim_g3_2 + nearRtRicId: ric_g3_2 - policyTypeId: STD_QOS_0_2_0 - nearRtRicId: ricsim_g3_2 + nearRtRicId: ric_g3_2 - policyTypeId: STD_QOS2_0.1.0 - nearRtRicId: ricsim_g3_1 + nearRtRicId: ric_g3_1 - policyTypeId: STD_QOS_0_2_0 - nearRtRicId: ricsim_g3_1 + nearRtRicId: ric_g3_1 PolicyTypeObject: value: policySchema: @@ -919,16 +963,15 @@ components: additionalProperties: false required: - priorityLevel + schemas: PolicyTypeInformation: 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 + A data tuple to indicate that an identified A1 Policy Type is supported at an identified Near-RT RIC. type: object properties: policyTypeId: - description: Identity of the policy type + description: A1 Policy Type identifier type: string nearRtRicId: $ref: '#/components/schemas/NearRtRicId' @@ -937,42 +980,50 @@ components: - nearRtRicId example: policyTypeId: STD_QOS2_0.1.0 - nearRtRicId: ricsim_g3_2 + nearRtRicId: ric_g3_2 PolicyObjectInformation: - description: Information related to the creation of the policy + description: Information to create an A1 Policy Instance type: object properties: nearRtRicId: description: Identity of the target Near-RT RIC type: string example: - 'Near-RT-Ric-ID' + 'Near-RT-Ric-ID1' transient: default: false - 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. nullable: false type: boolean policyId: - description: The identity of the Policy. If this value is present, it must be unique; otherwise, a random UUID is generated. + 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. type: string example: - 'POLICY-ID' + 'POLICY-ID1' serviceId: 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. + 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. type: string example: - 'rApp ID' + 'rApp 1' default: "" policyObject: $ref: '#/components/schemas/PolicyObject' policyTypeId: - description: Identity of the policy type + description: A1 Policy Type identity type: string - example: 'ORAN_QOS_1.0.0(typeName_SemVersion)' + example: ORAN_QOS_1.0.0 '(typeName_SemVersion)' required: - nearRtRicId - policyObject @@ -981,26 +1032,27 @@ components: description: Problem as defined in https://tools.ietf.org/html/rfc7807 properties: detail: - 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 type: string title: - description: 'A specific error name' + description: A specific error name type: string example: Not Found status: - 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. example: 404 format: int32 type: integer type: object PolicyObject: - description: 'Policy Object is a JSON representation of an A1 policy' + description: > + Policy Object is a JSON representation policy data for an A1 Policy Instance. + The schema for this policy data is defined in the corresponding A1 Policy Type. type: object PolicyTypeObject: - description: 'policy type object as defined in A1TD' + description: An A1 Policy Type, as defined in O-RAN Alliance A1TD type: object properties: policySchema: @@ -1008,12 +1060,12 @@ components: statusSchema: $ref: '#/components/schemas/StatusSchema' required: - - "policySchema" + - policySchema 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: @@ -1038,7 +1090,7 @@ components: 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: @@ -1049,13 +1101,22 @@ components: required: - enforceStatus PolicySchema: - description: 'The schemas are policy type specific' + description: > + A schema to define the policy data contents of A1 Policy Instances. + Policy data schemas are Policy Type specific. + All A1 Policy Instances of an A1 Policy Type should comply with the type's policy data schema. type: object StatusSchema: - description: 'The optional schema for policy status' + description: > + A schema to define the contents of the status information for A1 Policy Instances. + Status schemas are Policy Type specific. + All status information for all A1 Policy Instances of an A1 Policy Type should comply + with the type's status schema. type: object PolicyStatusObject: - description: 'A generic policy status object that can be used to transport any policy status. Additionally, a policy status shall be valid according to the schema of its specific policy type.' + description: > + A generic policy status object that can be used to transport any policy status. + Additionally, a schema for policy status can be defined in the corresponding A1 Policy Type. type: object void: description: Void/empty @@ -1063,7 +1124,7 @@ components: StatusInfo: properties: status: - description: status text + description: Status text type: string type: object RicInfo: @@ -1073,13 +1134,13 @@ components: description: Identity of the Near-RT RIC type: string managedElementIds: - description: O1 identities for managed entities + description: Identities for managed entities items: - description: O1 identities for managed entities + description: Identity for a managed entity type: string type: array state: - description: Represents the states for a Near-RT RIC + description: Represents the state of a Near-RT RIC enum: - UNAVAILABLE - AVAILABLE @@ -1087,72 +1148,80 @@ components: - CONSISTENCY_CHECK type: string policyTypeIds: - description: supported policy types + description: Supported A1 Policy Types items: - description: supported policy types + description: Supported A1 Policy Type ID type: string type: array type: object ServiceRegistrationInfo: - description: Information for one service + description: Information for a service to be registered properties: callbackUrl: - description: callback for notifying of Near-RT RIC state changes + description: Callback URL for notifying of Near-RT RIC state changes type: string serviceId: description: Identity of the service type: string keepAliveIntervalSeconds: - 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. format: int64 type: integer required: - serviceId type: object ServiceStatus: + description: Information about a previously registered service properties: callbackUrl: - description: callback for notifying of RIC synchronization + description: Callback URL for notifying of Near-RT RIC state changes type: string serviceId: description: Identity of the service type: string keepAliveIntervalSeconds: - 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. format: int64 type: integer timeSinceLastActivitySeconds: - description: time since last invocation by the service + description: Time (seconds) since last recorded operation by the service format: int64 type: integer type: object RicInfoList: - description: List of Near-RT RIC information + description: Collection of Near-RT RIC information objects properties: rics: - description: List of Near-RT RIC information + description: List of Near-RT RIC information objects items: $ref: '#/components/schemas/RicInfo' type: array type: object NearRtRicId: - description: Identity of the policy + description: Identity of the Near-RT RIC type: string PolicyInformation: - 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. type: object properties: policyId: - description: Identity of the policy + description: Identity of the A1 Policy Instance type: string nearRtRicId: $ref: '#/components/schemas/NearRtRicId' @@ -1162,20 +1231,23 @@ components: ServiceStatusList: properties: serviceList: - description: List of service information + description: List of Service Status objects, describing a collection of registered services. items: $ref: '#/components/schemas/ServiceStatus' type: array type: object ServiceCallbackInfo: - description: Information transferred as in Service callbacks (callback_url) + description: | + Information transferred in Service callbacks, + if a callback URL was provided for a registered service properties: ricId: description: Identity of a Near-RT RIC type: string eventType: - description: "values:\nAVAILABLE: the Near-RT RIC has become available\ - \ for A1 Policy management" + description: > + values: + AVAILABLE: the Near-RT RIC has become available for A1 Policy management enum: - AVAILABLE type: string @@ -1184,28 +1256,25 @@ components: - ricId type: object ProblemDetails: - 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 type: object properties: type: - 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 type: string title: - description: human-readable summary of the problem type + description: Human-readable summary of the problem type type: string status: - description: the HTTP status code + description: HTTP status code type: number detail: - description: 'human-readable explanation ' + description: Human-readable explanation type: string instance: description: URI reference that identifies the specific occurrence of the problem type: string + responses: '400': description: Bad Request @@ -1292,7 +1361,7 @@ components: schema: $ref: '#/components/schemas/ProblemDetails' Locked: - description: "Locked - HTTP Status code which can be used when the state is Locked" + description: Locked - HTTP Status code which can be used when the state is Locked content: application/problem+json: schema: @@ -1300,4 +1369,4 @@ components: example: status: 423 title: Locked - detail: State is Locked in the provided request. + detail: State is Locked in the provided request. diff --git a/a1-policy-management/pom.xml b/a1-policy-management/pom.xml index b70b9d8e..29368772 100644 --- a/a1-policy-management/pom.xml +++ b/a1-policy-management/pom.xml @@ -633,6 +633,12 @@ <include>openapitoolgen/offeredapis/pms-api/v3/custom/index.html</include> </includes> </resource> + <resource> + <directory>${project.basedir}/src/main/resources/</directory> + <includes> + <include>application_configuration_schema.json</include> + </includes> + </resource> </resources> </configuration> </execution> diff --git a/docs/conf.py b/docs/conf.py index d5815e56..ec924af9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -84,6 +84,9 @@ spelling_lang = "en_GB" html_extra_path = [ 'offeredapis/openapitoolgen' + # note: + # during the readthedocs build, additional files are copied, e.g. into directory "/openapi" + # See .readthedocs.yaml file ] # diff --git a/docs/guide/developer-guide.rst b/docs/guide/developer-guide.rst index 05a8281a..30d17430 100644 --- a/docs/guide/developer-guide.rst +++ b/docs/guide/developer-guide.rst @@ -10,9 +10,11 @@ Developer Guide This document provides a quickstart for developers of the CCSDK functions for O-RAN A1 Policies. -.. image:: ../media/ONAP-A1ControllerArchitecture-NewDelhi.png +.. image:: ../media/ONAP-A1ControllerArchitecture-NewDelhiOslo.png :width: 500pt +Additional guides for developers can be found on the `ONAP wiki (Development Guides) <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16445127/Development+guide+for+O-RAN+A1+Policies+Non-RealTime+RIC+applications>`_. + Source tree +++++++++++ @@ -46,7 +48,7 @@ Dependencies ------------ This project uses various frameworks which are managed with Maven -dependency management tool (see *pom.xml* file at root level) : +dependency management tool (see *pom.xml* file at root level). For example: - Swagger annotations - `Spring Framework <https://github.com/spring-projects/spring-boot>`_ @@ -60,28 +62,34 @@ To get a complete list of all dependencies, use command "mvn dependency:tree". Configuration ------------- -There are two configuration files for A1 Policy Management Service, *config/application_configuration.json* and *config/application.yaml* -The first (*config/application_configuration.json*) contains application-specific configuration needed by the application, such as which near-RT RICs, or controller to use. -The second (*config/application.yaml*) contains logging and security configurations. +There are two configuration files for A1 Policy Management Service, *config/application_configuration.json* +and *config/application.yaml*. +The first (*config/application_configuration.json*) contains application-specific configuration needed by +the application, such as which near-RT RICs, or controller to use. +The second (*config/application.yaml*) contains configuration options for underlying service, including +configurations for logging, tracing, security, storage, etc.. -For more information about these configuration files can be found as comments in the sample files provided with the source code, or on the `ONAP wiki <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16444961/O-RAN+A1+Policies+in+ONAP>`_ +For more information about these configuration files can be found as comments in the sample files +provided with the source code, or on the +`ONAP wiki <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16444961/O-RAN+A1+Policies+in+ONAP>`_ Static configuration - Settings that cannot be changed at runtime (*application.yaml*) -------------------------------------------------------------------------------------- The file *./config/application.yaml* is read by the application at startup. It provides the following configurable features: - * *server*; configuration for the WEB server + * *server*; configuration for the Web Server (Northbound Interface) * used port for HTTP/HTTPS, this is however not the port number visible outside the container * SSL parameters for setting up using of key store and trust store databases. - * *webclient*; configuration parameters for a web client used by the component + + * *webclient*; configuration parameters for a Web Client used by the component (Southbound Interface) * SSL parameters for setting up using of key store and trust store databases. * Usage of HTTP(S) Proxy; if configured, the proxy will be used for southbound access to the NearRT-RICs * *logging*; setting for which information is logged. - * *auth-token*; optional authorization token to use for REST call. + * *auth-token*; optional authorization token to use for REST calls. * *filepath*; the local path to a file used for dynamic configuration (if used). See next chapter. * *persistent storage* of runtime information. Configuration of A1 Policy instances is stored persistently. The media for this can be either filesystem (a persistent volume) or Amazon S3 - Cloud Object Storage. @@ -89,33 +97,40 @@ For details about the parameters in this file, see documentation in the file. Dynamic configuration - Settings that can be changed at runtime (*application_configuration.json* or REST or ConfigMap) ----------------------------------------------------------------------------------------------------------------------- -The component has configuration that can be updated in runtime. This configuration can either be loaded from a file (accessible from the container), or using the Configuration REST API. The configuration is re-read and refreshed at regular intervals if the file is changed (e.g. using K8s ConfigMap capabilities). +The component has configuration that can be updated in runtime. This configuration can either be loaded from a +file (accessible from the container), or using the Configuration REST API. The configuration is re-read and +refreshed at regular intervals if the file is changed (e.g. using K8s ConfigMap capabilities). The configuration includes: * Optional *Controller* configuration, e.g. an SDNC instance (with A1-Adapter) - * (If no 'Contoller' is configured, the A1 Policy Management Service will connect direct to near-RT RICs, bypassing the SDNC controller) + * (If no 'Controller' is configured, the A1 Policy Management Service will connect direct to near-RT RICs, bypassing the SDNC controller) * One entry for each near-RT-RIC (*ric*), which includes: * The base URL of the near-RT-RIC - * A optional list of O1 identifiers that near-RT-RIC is controlling. An application can query this service which near-RT-RIC should be addressed for which component (e.g. cells, sectors, locations, etc.). + * A optional list of O1 identifiers that near-RT-RIC is controlling. An application may query this service which near-RT-RIC should be addressed for which component (e.g. cells, sectors, locations, etc.). * An optional reference to the controller to use, or excluded if the near-RT-RIC should be accessed directly from the A1 Policy Management Service. -For details about the syntax of the file, there is an example in source code repository */config/application_configuration.json*. This file is also included in the docker container */opt/app/policy-agent/data/application_configuration.json_example*. +For details about the syntax of the file, there is an example in source code repository +*/config/application_configuration.json*. This file is also included in the docker +container */opt/app/policy-agent/data/application_configuration.json_example*. Configuring certificates ------------------------ -The A1 Policy Management Service uses the default security keystore and truststore that are included in the built container. The paths and -passwords for these stores are located in the static configuration file described above (*application.yaml*), with an example is provided in the source code repository *a1-policy-management/config/application.yaml* +The A1 Policy Management Service uses the default security keystore and truststore that are included +in the built container. The paths and passwords for these stores are located in the static configuration file +described above (*application.yaml*), with an example is provided in the source code +repository *a1-policy-management/config/application.yaml* -A default cert and truststore is also included in the A1 Policy Management Service, but should only be used for *mocking* and *testing* purposes. -(*ApplicationTest.java*). +A default cert and truststore is also included in the A1 Policy Management Service, but should only be used +for *mocking* and *testing* purposes. (ref. file: *ApplicationTest.java*). -The default keystore, truststore, and application.yaml files can be overridden by mounting new files using the the docker 'volumes' -command for 'docker-compose' or 'docker run' command. Assuming that the *keystore*, *truststore*, and *application.yaml* files are located in the same directory as 'docker-compose', +The default keystore, truststore, and application.yaml files can/should be overridden by mounting new +files using the the docker 'volumes' command for 'docker-compose' or 'docker run' command. Assuming that the +*keystore*, *truststore*, and *application.yaml* files are located in the same directory as 'docker-compose', the volumes field should have these entries: :: `volumes:` @@ -127,7 +142,7 @@ The target paths in the container should not be modified. 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=policy-agent-container --network=nonrtric-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.5.0 + docker run -p 8081:8081 -p 8433:8433 --name=policy-agent-container --network=nonrtric-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:latest A1 Adapter (Internal) +++++++++++++++++++++ @@ -146,5 +161,3 @@ In order to configure a HTTP Proxy for the A1-Adapter to use for southbound conn * Variable *a1Mediator.proxy.url* must contain the full Proxy URL After this configuration has been changed the A1 adapter needs to be either rebuilt, or restarted if the configuration is changed inside a container, or re-read by the container if externally accessible (e.g. K8s ConfigMap). - - diff --git a/docs/humaninterfaces/humaninterfaces.rst b/docs/humaninterfaces/humaninterfaces.rst index fb8635e3..1f14fd3e 100644 --- a/docs/humaninterfaces/humaninterfaces.rst +++ b/docs/humaninterfaces/humaninterfaces.rst @@ -1,6 +1,6 @@ .. SPDX-License-Identifier: CC-BY-4.0 .. Copyright 2022-2023 Nordix Foundation. All rights reserved. -.. Copyright 2024 OpenInfra Foundation Europe. All rights reserved. +.. Copyright 2024-2025 OpenInfra Foundation Europe. All rights reserved. Human Interfaces @@ -9,4 +9,4 @@ Human Interfaces The NON-RT RIC Control Panel in O-RAN-SC can be used to interact with the Policy Management Service. See `NON-RT RIC Control Panel repo <https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel>`_ from the `O-RAN-SC NONRTRIC Project <https://lf-o-ran-sc.atlassian.net/wiki/spaces/RICNR/overview>`_. -Any "REST Client" application may be used (Postman, ...) to interact with the Policy Management Service application via the :ref:`pms_api` +Any "REST Client" application may be used (e.g. Postman, ...) to interact with the Policy Management Service application via the :ref:`pms_api` diff --git a/docs/media/ONAP-A1ControllerArchitecture-NewDelhi.png b/docs/media/ONAP-A1ControllerArchitecture-NewDelhiOslo.png Binary files differindex 15580c87..15580c87 100644 --- a/docs/media/ONAP-A1ControllerArchitecture-NewDelhi.png +++ b/docs/media/ONAP-A1ControllerArchitecture-NewDelhiOslo.png diff --git a/docs/media/html_logo.png b/docs/media/html_logo.png Binary files differnew file mode 100644 index 00000000..3f27ba8c --- /dev/null +++ b/docs/media/html_logo.png diff --git a/docs/offeredapis/application_configuration_schema.json b/docs/offeredapis/application_configuration_schema.json new file mode 100644 index 00000000..3186dae6 --- /dev/null +++ b/docs/offeredapis/application_configuration_schema.json @@ -0,0 +1,91 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "config": { + "type": "object", + "properties": { + "//description": { + "type": "string" + }, + "description": { + "type": "string" + }, + "controller": { + "type": "array", + "items": [ + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "baseUrl": { + "type": "string" + }, + "userName": { + "type": "string" + }, + "password": { + "type": "string" + } + }, + "required": [ + "name", + "baseUrl", + "userName", + "password" + ], + "additionalProperties": false + } + ] + }, + "ric": { + "type": "array", + "items": [ + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "baseUrl": { + "type": "string" + }, + "controller": { + "type": "string" + }, + "customAdapterClass": { + "type": "string" + }, + "managedElementIds": { + "type": "array", + "items": [ + { + "type": "string" + }, + { + "type": "string" + } + ] + } + }, + "required": [ + "name", + "baseUrl" + ], + "additionalProperties": false + } + ] + } + }, + "required": [ + "ric" + ], + "additionalProperties": true + } + }, + "required": [ + "config" + ] +} diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index 579b4aaa..6b50873c 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -1,7 +1,8 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 - International License. +.. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2022 Nordix Foundation +.. Copyright 2022-2024 Nordix Foundation. All rights reserved. +.. Copyright 2024-2025 OpenInfra Foundation Europe. All rights reserved. + .. _offered_apis: @@ -24,15 +25,6 @@ integration with other ONAP components and API resource/operation provided. .. image:: ../media/ONAP-A1ControllerArchitecture.png :width: 500pt - -API Version ------------ - -APIs are described with a state version with "v" following the API Name, -e.g.: ``v2/policy``. -The schema associated with a REST API must have its version number aligned -with that of the REST API. - API Table --------- @@ -42,29 +34,34 @@ API Table .. |yaml-icon| image:: ../media/yaml_logo.png :width: 40px - +.. |html-icon| image:: ../media/html_logo.png + :width: 40px + .. csv-table:: - :header: "API name", "|swagger-icon|", "|yaml-icon|" - :widths: 10,5, 5 + :header: "API name", "|swagger-icon|", "|yaml-icon|", "|html-icon|" + :widths: 56,11,11,22 - "Older A1PolicyManagementService, ServiceRegistry, Configuration, NearRT-RIC Repository, Health Check APIs, and Admin/Actuator APIs (NBI)", ":download:`link <./swagger/pms-api.json>`", ":download:`link <./swagger/pms-api.yaml>`" - "New 'V3' A1PolicyManagementService, ServiceRegistry, Configuration, NearRT-RIC Repository, and Health Check APIs (NBI)", ":download:`link <./swagger/pms-api-v3.json>`", ":download:`link <./swagger/pms-api-v3.yaml>`" - "A1 ADAPTER API (Internal)", ":download:`link <./swagger/a1-adapter-api.json>`", ":download:`link <./swagger/a1-adapter-api.yaml>`" + "*New* **A1 Policy Management API**: A1PolicyManagementService, ServiceRegistry, Configuration, NearRT-RIC Repository, and Health Check APIs (NBI)", ":download:`link <./swagger/pms-api-v3.json>`", ":download:`link <./swagger/pms-api-v3.yaml>`", "`A1 Policy Management API <./pms-api-v3.html>`_" + "*Older* **Pre-Spec A1 Policy Management API**: Older A1PolicyManagementService, ServiceRegistry, Configuration, NearRT-RIC Repository, Health Check APIs, and Admin/Actuator APIs (NBI)", ":download:`link <./swagger/pms-api.json>`", ":download:`link <./swagger/pms-api.yaml>`", "`Pre-Spec A1 Policy Management API <./pms-api.html>`_ " + "A1 ADAPTER API (*Internal Only*)", ":download:`link <./swagger/a1-adapter-api.json>`", ":download:`link <./swagger/a1-adapter-api.yaml>`", "`A1 ADAPTER API (Internal Only) <./a1-adapter-api.html>`_" .. _pms_api: -A1 Policy Management Service API -................................ +A1 Policy Management Service APIs +................................. -The new "V3" A1 PolicyManagementService, ServiceRegistry, Configuration, NearRT-RIC Repository, and Health Check APIs (NBI) are described in more detail in `A1 Policy Management Service API (html) <./pms-api.html>`_ +| 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) <./pms-api-v3.html>`_ -The older A1PolicyManagementService, ServiceRegistry, Configuration, NearRT-RIC Repository, Health Check APIs, and Admin/Actuator APIs are described in more detail at `A1 Policy Management Service API "V3" (html) <./pms-api-v3.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) <./pms-api.html>`_ .. _a1_adapter_api: A1 ADAPTER API .............. -The O-RAN A1 Adapter provides an **internal** RESTCONF API that is used by the A1 Policy Management System when accessing the A1 Interface. This API is useful for test and verification but should not be used otherwise. - -The A1 Adapter API is described in more detail in `A1 ADAPTER API (html) <./a1-adapter-api.html>`_ +| 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) <./a1-adapter-api.html>`_ 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 3b6a2658..932756a4 100644 --- a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html +++ b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/custom/index.html @@ -2,7 +2,7 @@ <html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> - <title>A1 policy management API</title> + <title>ONAP CCSDK - A1 Policy Management API</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="UTF-8" /> @@ -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 { <div id="content"> <div id="project"> <div class="pull-left"> - <h1>A1 policy management API</h1> + <h1>ONAP CCSDK - A1 Policy Management API</h1> </div> <div class="clearfix"></div> </div> @@ -1211,7 +1212,7 @@ ul.nav-tabs { <div class="app-desc">Version: 1.0.0</div> <hr> <div id="app-description" class="app-desc"> - <h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p> + <h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies. <br/>This document describes the latest API set to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2> <p>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.'</p> <h3>A1 Policy Management</h3> <p>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:</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy Types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3> <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3> <p>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.</p> </div> </div> @@ -1223,12 +1224,12 @@ ul.nav-tabs { <article id="api-A1PolicyManagement-createPolicy-0" data-group="User" data-name="createPolicy" data-version="0"> <div class="pull-left"> <h1>createPolicy</h1> - <p></p> + <p>Create an A1 Policy Instance (createPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">To create A1 policies</p> + <p class="marked">Create an A1 Policy Instance</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/policies</span></code></pre> @@ -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)'" }' </code></pre> </div> @@ -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 = ; // </div> <div class="tab-pane" id="examples-A1PolicyManagement-createPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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() { <td>Location</td> <td>String</td> <td></td> - <td>Contains the URI of the newly created resource</td> + <td>Contains the URI of the newly created A1 Policy Instances. This URI includes the A1 Policy Instance ID for the newly created policy instance. +</td> </tr> <tr> <td>Content-Type</td> @@ -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() { <article id="api-A1PolicyManagement-deletePolicy-0" data-group="User" data-name="deletePolicy" data-version="0"> <div class="pull-left"> <h1>deletePolicy</h1> - <p>Delete a policy</p> + <p>Delete an A1 Policy instance (deletePolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Deleting the policy using policyId.</p> + <p class="marked">Delete an existing A1 Policy instance using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-deletePolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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)</code></pre> @@ -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 <article id="api-A1PolicyManagement-getAllPolicies-0" data-group="User" data-name="getAllPolicies" data-version="0"> <div class="pull-left"> <h1>getAllPolicies</h1> - <p>Query policy identities</p> + <p>Query for A1 Policy instances (getAllPolicies)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.</p> + <p class="marked">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. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies</span></code></pre> @@ -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 <typename_version>) + 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 <typename_version>) +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 <typename_version>) + 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 <typename_version>) (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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-getAllPolicies-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <typename_version>) + '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 <typename_version>) (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 <typename_version>) +$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 <typename_version>) +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 <typename_version>) (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 </span> <div class="inner description marked"> -Select policies of a given policy type identity. +Select policies with a given A1 Policy Type ID. </div> </div> </div> @@ -4321,7 +4327,7 @@ Select policies of a given policy type identity. </span> <div class="inner description marked"> -Select policies of a given Near-RT RIC identity. +Select policies for a given Near-RT RIC identity. </div> </div> </div> @@ -4341,7 +4347,7 @@ Select policies of a given Near-RT RIC identity. </span> <div class="inner description marked"> -Select policies owned by a given service. +Select policies owned by a given service (registered or unregistered). </div> </div> </div> @@ -4361,7 +4367,7 @@ Select policies owned by a given service. </span> <div class="inner description marked"> -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'). </div> </div> </div> @@ -5142,12 +5148,12 @@ Select policies of types with the given type name (type identity has the format <article id="api-A1PolicyManagement-getPolicy-0" data-group="User" data-name="getPolicy" data-version="0"> <div class="pull-left"> <h1>getPolicy</h1> - <p></p> + <p>Get an A1 Policy's policy data (getPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a policy</p> + <p class="marked">Get an A1 Policy instance's policy data using its policy ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <article id="api-A1PolicyManagement-getPolicyStatus-0" data-group="User" data-name="getPolicyStatus" data-version="0"> <div class="pull-left"> <h1>getPolicyStatus</h1> - <p></p> + <p>Get an A1 Policy Instance's status (getPolicyStatus)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Query a policy status</p> + <p class="marked">Retrieve the status information for an A1 Policy Instance using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies/{policyId}/status</span></code></pre> @@ -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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyStatus-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <article id="api-A1PolicyManagement-getPolicyTypeDefinition-0" data-group="User" data-name="getPolicyTypeDefinition" data-version="0"> <div class="pull-left"> <h1>getPolicyTypeDefinition</h1> - <p></p> + <p>Get an A1 Policy Type definition (getPolicyTypeDefinition)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a policy type definition</p> + <p class="marked">Get an A1 Policy Type definition using its policy type ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policy-types/{policyTypeId}</span></code></pre> @@ -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 </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <h3 id="examples-A1PolicyManagement-getPolicyTypeDefinition-title-200"></h3> <p id="examples-A1PolicyManagement-getPolicyTypeDefinition-description-200" class="marked"></p> <script> - var responseA1PolicyManagement200_description = `OK - schema of the given policy type`; + var responseA1PolicyManagement200_description = `OK - details and schema of the requested A1 Policy Type`; var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n'); if (responseA1PolicyManagement200_description_break == -1) { $("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description); @@ -7672,7 +7687,7 @@ Specifies the content type that the client expects to receive in response to the <script> $(document).ready(function() { var schemaWrapper = { - "description" : "OK - schema of the given policy type", + "description" : "OK - details and schema of the requested A1 Policy Type", "content" : { "application/json" : { "schema" : { @@ -8413,12 +8428,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getPolicyTypes-0" data-group="User" data-name="getPolicyTypes" data-version="0"> <div class="pull-left"> <h1>getPolicyTypes</h1> - <p></p> + <p>Get A1 Policy Types (getPolicyTypes)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Query policy type identities</p> + <p class="marked">Query A1 Policy Type identities using query parameters</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policy-types</span></code></pre> @@ -8463,8 +8478,9 @@ public class A1PolicyManagementApiExample { // Create an instance of the API class A1PolicyManagementApi apiInstance = new A1PolicyManagementApi(); String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. - String typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) - String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') + String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8485,8 +8501,9 @@ public class A1PolicyManagementApiExample { final api_instance = DefaultApi(); final String nearRtRicId = new String(); // String | Select types for the given Near-RT RIC identity. -final String typeName = new String(); // String | Select types with the given type name (type identity has the format <typename_version>) -final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +final String typeName = new String(); // String | Select types compatible with the given type name (type identity has the format 'typename_version') +final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8506,8 +8523,9 @@ public class A1PolicyManagementApiExample { public static void main(String[] args) { A1PolicyManagementApi apiInstance = new A1PolicyManagementApi(); String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. - String typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) - String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') + String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8530,10 +8548,12 @@ public class A1PolicyManagementApiExample { // Create an instance of the API class A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *nearRtRicId = nearRtRicId_example; // Select types for the given Near-RT RIC identity. (optional) (default to null) -String *typeName = typeName_example; // Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) -String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) +String *typeName = typeName_example; // Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) +String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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) +// Get A1 Policy Types (getPolicyTypes) [apiInstance getPolicyTypesWith:nearRtRicId typeName:typeName compatibleWithVersion:compatibleWithVersion @@ -8550,14 +8570,15 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypes-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 = { 'nearRtRicId': nearRtRicId_example, // {String} Select types for the given Near-RT RIC identity. - 'typeName': typeName_example, // {String} Select types with the given type name (type identity has the format <typename_version>) - 'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 'typeName': typeName_example, // {String} Select types compatible with the given type name (type identity has the format 'typename_version') + 'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. }; @@ -8592,11 +8613,13 @@ namespace Example // Create an instance of the API class var apiInstance = new A1PolicyManagementApi(); var nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. (optional) (default to null) - var typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) - var compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) + var typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) + var compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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 { + // Get A1 Policy Types (getPolicyTypes) array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -8615,8 +8638,9 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi(); $nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. -$typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) -$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +$typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') +$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + $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 { @@ -8636,8 +8660,9 @@ use WWW::OPenAPIClient::A1PolicyManagementApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new(); my $nearRtRicId = nearRtRicId_example; # String | Select types for the given Near-RT RIC identity. -my $typeName = typeName_example; # String | Select types with the given type name (type identity has the format <typename_version>) -my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +my $typeName = typeName_example; # String | Select types compatible with the given type name (type identity has the format 'typename_version') +my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8659,11 +8684,13 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.A1PolicyManagementApi() nearRtRicId = nearRtRicId_example # String | Select types for the given Near-RT RIC identity. (optional) (default to null) -typeName = typeName_example # String | Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) -compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) +typeName = typeName_example # String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) +compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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: + # Get A1 Policy Types (getPolicyTypes) api_response = api_instance.get_policy_types(nearRtRicId=nearRtRicId, typeName=typeName, compatibleWithVersion=compatibleWithVersion, accept=accept) pprint(api_response) except ApiException as e: @@ -8764,7 +8791,7 @@ Select types for the given Near-RT RIC identity. </span> <div class="inner description marked"> -Select types with the given type name (type identity has the format <typename_version>) +Select types compatible with the given type name (type identity has the format 'typename_version') </div> </div> </div> @@ -8784,7 +8811,8 @@ Select types with the given type name (type identity has the format <typename </span> <div class="inner description marked"> -Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + </div> </div> </div> @@ -9570,12 +9598,12 @@ Select types that are compatible with the given version. This parameter is only <article id="api-A1PolicyManagement-putPolicy-0" data-group="User" data-name="putPolicy" data-version="0"> <div class="pull-left"> <h1>putPolicy</h1> - <p></p> + <p>Update an A1 Policy's policy data (putPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">update a policy</p> + <p class="marked">Update an existing A1 Policy instance's policy data using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -9685,6 +9713,7 @@ A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *policyId = policyId_example; // (default to null) Object *body = Object; // +// Update an A1 Policy's policy data (putPolicy) [apiInstance putPolicyWith:policyId body:body completionHandler: ^(Object output, NSError* error) { @@ -9699,10 +9728,10 @@ Object *body = Object; // </div> <div class="tab-pane" id="examples-A1PolicyManagement-putPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 body = Object; // {Object} @@ -9740,6 +9769,7 @@ namespace Example var body = Object; // Object | try { + // Update an A1 Policy's policy data (putPolicy) Object result = apiInstance.putPolicy(policyId, body); Debug.WriteLine(result); } catch (Exception e) { @@ -9801,6 +9831,7 @@ policyId = policyId_example # String | (default to null) body = Object # Object | try: + # Update an A1 Policy's policy data (putPolicy) api_response = api_instance.put_policy(policyId, body) pprint(api_response) except ApiException as e: @@ -10640,7 +10671,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." } } } diff --git a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html index c693818d..71e0c49f 100644 --- a/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html +++ b/docs/offeredapis/openapitoolgen/offeredapis/pms-api/v3/index.html @@ -2,7 +2,7 @@ <html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> - <title>A1 policy management API</title> + <title>ONAP CCSDK - A1 Policy Management API</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="UTF-8" /> @@ -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 = {}; @@ -1232,7 +1233,7 @@ ul.nav-tabs { <div id="content"> <div id="project"> <div class="pull-left"> - <h1>A1 policy management API</h1> + <h1>ONAP CCSDK - A1 Policy Management API</h1> </div> <div class="clearfix"></div> </div> @@ -1242,7 +1243,7 @@ ul.nav-tabs { <div class="app-desc">Version: 1.0.0</div> <hr> <div id="app-description" class="app-desc"> - <h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p> + <h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies. <br/>This document describes the latest API set to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2> <p>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.'</p> <h3>A1 Policy Management</h3> <p>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:</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy Types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3> <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3> <p>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.</p> </div> </div> @@ -1254,12 +1255,12 @@ ul.nav-tabs { <article id="api-A1PolicyManagement-createPolicy-0" data-group="User" data-name="createPolicy" data-version="0"> <div class="pull-left"> <h1>createPolicy</h1> - <p></p> + <p>Create an A1 Policy Instance (createPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">To create A1 policies</p> + <p class="marked">Create an A1 Policy Instance</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="post"><code><span class="pln">/policies</span></code></pre> @@ -1289,12 +1290,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)'" }' </code></pre> </div> @@ -1372,6 +1373,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) { @@ -1385,10 +1387,10 @@ PolicyObjectInformation *policyObjectInformation = ; // </div> <div class="tab-pane" id="examples-A1PolicyManagement-createPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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) { @@ -1424,6 +1426,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) { @@ -1482,6 +1485,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: @@ -1601,7 +1605,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, @@ -1674,7 +1678,8 @@ $(document).ready(function() { <td>Location</td> <td>String</td> <td></td> - <td>Contains the URI of the newly created resource</td> + <td>Contains the URI of the newly created A1 Policy Instances. This URI includes the A1 Policy Instance ID for the newly created policy instance. +</td> </tr> <tr> <td>Content-Type</td> @@ -2409,7 +2414,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." } } } @@ -2761,12 +2766,12 @@ $(document).ready(function() { <article id="api-A1PolicyManagement-deletePolicy-0" data-group="User" data-name="deletePolicy" data-version="0"> <div class="pull-left"> <h1>deletePolicy</h1> - <p>Delete a policy</p> + <p>Delete an A1 Policy instance (deletePolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Deleting the policy using policyId.</p> + <p class="marked">Delete an existing A1 Policy instance using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -2872,7 +2877,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) { @@ -2884,10 +2889,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-deletePolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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. @@ -2927,7 +2932,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 ); @@ -2986,7 +2991,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)</code></pre> @@ -3635,7 +3640,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." } } } @@ -3987,12 +3992,13 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getAllPolicies-0" data-group="User" data-name="getAllPolicies" data-version="0"> <div class="pull-left"> <h1>getAllPolicies</h1> - <p>Query policy identities</p> + <p>Query for A1 Policy instances (getAllPolicies)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.</p> + <p class="marked">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. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies</span></code></pre> @@ -4036,10 +4042,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 <typename_version>) + 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 { @@ -4059,10 +4065,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 <typename_version>) +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 { @@ -4081,10 +4087,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 <typename_version>) + 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 { @@ -4106,13 +4112,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 <typename_version>) (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 @@ -4130,15 +4136,15 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getAllPolicies-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 <typename_version>) + '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. }; @@ -4172,14 +4178,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 <typename_version>) (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) { @@ -4197,10 +4203,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 <typename_version>) +$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 { @@ -4219,10 +4225,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 <typename_version>) +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 { @@ -4243,14 +4249,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 <typename_version>) (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: @@ -4332,7 +4338,7 @@ Specifies the content type that the client expects to receive in response to the </span> <div class="inner description marked"> -Select policies of a given policy type identity. +Select policies with a given A1 Policy Type ID. </div> </div> </div> @@ -4352,7 +4358,7 @@ Select policies of a given policy type identity. </span> <div class="inner description marked"> -Select policies of a given Near-RT RIC identity. +Select policies for a given Near-RT RIC identity. </div> </div> </div> @@ -4372,7 +4378,7 @@ Select policies of a given Near-RT RIC identity. </span> <div class="inner description marked"> -Select policies owned by a given service. +Select policies owned by a given service (registered or unregistered). </div> </div> </div> @@ -4392,7 +4398,7 @@ Select policies owned by a given service. </span> <div class="inner description marked"> -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'). </div> </div> </div> @@ -5173,12 +5179,12 @@ Select policies of types with the given type name (type identity has the format <article id="api-A1PolicyManagement-getPolicy-0" data-group="User" data-name="getPolicy" data-version="0"> <div class="pull-left"> <h1>getPolicy</h1> - <p></p> + <p>Get an A1 Policy's policy data (getPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a policy</p> + <p class="marked">Get an A1 Policy instance's policy data using its policy ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -5286,6 +5292,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) { @@ -5300,10 +5307,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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. @@ -5343,6 +5350,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) { @@ -5404,6 +5412,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: @@ -6265,12 +6274,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getPolicyStatus-0" data-group="User" data-name="getPolicyStatus" data-version="0"> <div class="pull-left"> <h1>getPolicyStatus</h1> - <p></p> + <p>Get an A1 Policy Instance's status (getPolicyStatus)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Query a policy status</p> + <p class="marked">Retrieve the status information for an A1 Policy Instance using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policies/{policyId}/status</span></code></pre> @@ -6378,6 +6387,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) { @@ -6392,10 +6402,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyStatus-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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. @@ -6435,6 +6445,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) { @@ -6496,6 +6507,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: @@ -7352,12 +7364,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getPolicyTypeDefinition-0" data-group="User" data-name="getPolicyTypeDefinition" data-version="0"> <div class="pull-left"> <h1>getPolicyTypeDefinition</h1> - <p></p> + <p>Get an A1 Policy Type definition (getPolicyTypeDefinition)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns a policy type definition</p> + <p class="marked">Get an A1 Policy Type definition using its policy type ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policy-types/{policyTypeId}</span></code></pre> @@ -7465,6 +7477,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) { @@ -7479,10 +7492,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypeDefinition-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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. @@ -7522,6 +7535,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) { @@ -7583,6 +7597,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: @@ -7675,7 +7690,7 @@ Specifies the content type that the client expects to receive in response to the <h3 id="examples-A1PolicyManagement-getPolicyTypeDefinition-title-200"></h3> <p id="examples-A1PolicyManagement-getPolicyTypeDefinition-description-200" class="marked"></p> <script> - var responseA1PolicyManagement200_description = `OK - schema of the given policy type`; + var responseA1PolicyManagement200_description = `OK - details and schema of the requested A1 Policy Type`; var responseA1PolicyManagement200_description_break = responseA1PolicyManagement200_description.indexOf('\n'); if (responseA1PolicyManagement200_description_break == -1) { $("#examples-A1PolicyManagement-getPolicyTypeDefinition-title-200").text("Status: 200 - " + responseA1PolicyManagement200_description); @@ -7703,7 +7718,7 @@ Specifies the content type that the client expects to receive in response to the <script> $(document).ready(function() { var schemaWrapper = { - "description" : "OK - schema of the given policy type", + "description" : "OK - details and schema of the requested A1 Policy Type", "content" : { "application/json" : { "schema" : { @@ -8444,12 +8459,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-A1PolicyManagement-getPolicyTypes-0" data-group="User" data-name="getPolicyTypes" data-version="0"> <div class="pull-left"> <h1>getPolicyTypes</h1> - <p></p> + <p>Get A1 Policy Types (getPolicyTypes)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Query policy type identities</p> + <p class="marked">Query A1 Policy Type identities using query parameters</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/policy-types</span></code></pre> @@ -8494,8 +8509,9 @@ public class A1PolicyManagementApiExample { // Create an instance of the API class A1PolicyManagementApi apiInstance = new A1PolicyManagementApi(); String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. - String typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) - String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') + String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8516,8 +8532,9 @@ public class A1PolicyManagementApiExample { final api_instance = DefaultApi(); final String nearRtRicId = new String(); // String | Select types for the given Near-RT RIC identity. -final String typeName = new String(); // String | Select types with the given type name (type identity has the format <typename_version>) -final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +final String typeName = new String(); // String | Select types compatible with the given type name (type identity has the format 'typename_version') +final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8537,8 +8554,9 @@ public class A1PolicyManagementApiExample { public static void main(String[] args) { A1PolicyManagementApi apiInstance = new A1PolicyManagementApi(); String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. - String typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) - String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') + String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8561,10 +8579,12 @@ public class A1PolicyManagementApiExample { // Create an instance of the API class A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *nearRtRicId = nearRtRicId_example; // Select types for the given Near-RT RIC identity. (optional) (default to null) -String *typeName = typeName_example; // Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) -String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) +String *typeName = typeName_example; // Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) +String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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) +// Get A1 Policy Types (getPolicyTypes) [apiInstance getPolicyTypesWith:nearRtRicId typeName:typeName compatibleWithVersion:compatibleWithVersion @@ -8581,14 +8601,15 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-A1PolicyManagement-getPolicyTypes-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 = { 'nearRtRicId': nearRtRicId_example, // {String} Select types for the given Near-RT RIC identity. - 'typeName': typeName_example, // {String} Select types with the given type name (type identity has the format <typename_version>) - 'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 'typeName': typeName_example, // {String} Select types compatible with the given type name (type identity has the format 'typename_version') + 'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. }; @@ -8623,11 +8644,13 @@ namespace Example // Create an instance of the API class var apiInstance = new A1PolicyManagementApi(); var nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. (optional) (default to null) - var typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) - var compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) + var typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) + var compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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 { + // Get A1 Policy Types (getPolicyTypes) array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -8646,8 +8669,9 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi(); $nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity. -$typeName = typeName_example; // String | Select types with the given type name (type identity has the format <typename_version>) -$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +$typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version') +$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + $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 { @@ -8667,8 +8691,9 @@ use WWW::OPenAPIClient::A1PolicyManagementApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new(); my $nearRtRicId = nearRtRicId_example; # String | Select types for the given Near-RT RIC identity. -my $typeName = typeName_example; # String | Select types with the given type name (type identity has the format <typename_version>) -my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +my $typeName = typeName_example; # String | Select types compatible with the given type name (type identity has the format 'typename_version') +my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + 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 { @@ -8690,11 +8715,13 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.A1PolicyManagementApi() nearRtRicId = nearRtRicId_example # String | Select types for the given Near-RT RIC identity. (optional) (default to null) -typeName = typeName_example # String | Select types with the given type name (type identity has the format <typename_version>) (optional) (default to null) -compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. (optional) (default to null) +typeName = typeName_example # String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null) +compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + (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: + # Get A1 Policy Types (getPolicyTypes) api_response = api_instance.get_policy_types(nearRtRicId=nearRtRicId, typeName=typeName, compatibleWithVersion=compatibleWithVersion, accept=accept) pprint(api_response) except ApiException as e: @@ -8795,7 +8822,7 @@ Select types for the given Near-RT RIC identity. </span> <div class="inner description marked"> -Select types with the given type name (type identity has the format <typename_version>) +Select types compatible with the given type name (type identity has the format 'typename_version') </div> </div> </div> @@ -8815,7 +8842,8 @@ Select types with the given type name (type identity has the format <typename </span> <div class="inner description marked"> -Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. +Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. + </div> </div> </div> @@ -9601,12 +9629,12 @@ Select types that are compatible with the given version. This parameter is only <article id="api-A1PolicyManagement-putPolicy-0" data-group="User" data-name="putPolicy" data-version="0"> <div class="pull-left"> <h1>putPolicy</h1> - <p></p> + <p>Update an A1 Policy's policy data (putPolicy)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">update a policy</p> + <p class="marked">Update an existing A1 Policy instance's policy data using its policy ID.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/policies/{policyId}</span></code></pre> @@ -9716,6 +9744,7 @@ A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init]; String *policyId = policyId_example; // (default to null) Object *body = Object; // +// Update an A1 Policy's policy data (putPolicy) [apiInstance putPolicyWith:policyId body:body completionHandler: ^(Object output, NSError* error) { @@ -9730,10 +9759,10 @@ Object *body = Object; // </div> <div class="tab-pane" id="examples-A1PolicyManagement-putPolicy-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">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 body = Object; // {Object} @@ -9771,6 +9800,7 @@ namespace Example var body = Object; // Object | try { + // Update an A1 Policy's policy data (putPolicy) Object result = apiInstance.putPolicy(policyId, body); Debug.WriteLine(result); } catch (Exception e) { @@ -9832,6 +9862,7 @@ policyId = policyId_example # String | (default to null) body = Object # Object | try: + # Update an A1 Policy's policy data (putPolicy) api_response = api_instance.put_policy(policyId, body) pprint(api_response) except ApiException as e: @@ -10671,7 +10702,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." } } } @@ -11026,12 +11057,12 @@ $(document).ready(function() { <article id="api-Configuration-getConfiguration-0" data-group="User" data-name="getConfiguration" data-version="0"> <div class="pull-left"> <h1>getConfiguration</h1> - <p></p> + <p>Get the Application Configuration (getConfiguration)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Returns the contents of the application configuration</p> + <p class="marked">Returns the entire contents of the Application Configuration.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/configuration</span></code></pre> @@ -11131,6 +11162,7 @@ public class ConfigurationApiExample { // Create an instance of the API class ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init]; +// Get the Application Configuration (getConfiguration) [apiInstance getConfigurationWithCompletionHandler: ^('String' output, NSError* error) { if (output) { @@ -11144,10 +11176,10 @@ ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init]; </div> <div class="tab-pane" id="examples-Configuration-getConfiguration-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ConfigurationApi() +var api = new OnapCcsdkA1PolicyManagementApi.ConfigurationApi() var callback = function(error, data, response) { if (error) { console.error(error); @@ -11180,6 +11212,7 @@ namespace Example var apiInstance = new ConfigurationApi(); try { + // Get the Application Configuration (getConfiguration) 'String' result = apiInstance.getConfiguration(); Debug.WriteLine(result); } catch (Exception e) { @@ -11235,6 +11268,7 @@ from pprint import pprint api_instance = openapi_client.ConfigurationApi() try: + # Get the Application Configuration (getConfiguration) api_response = api_instance.get_configuration() pprint(api_response) except ApiException as e: @@ -11427,12 +11461,13 @@ pub fn main() { <article id="api-Configuration-putConfiguration-0" data-group="User" data-name="putConfiguration" data-version="0"> <div class="pull-left"> <h1>putConfiguration</h1> - <p></p> + <p>Set/Replace the Application Configuration (putConfiguration)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Replace the current configuration file with the given configuration</p> + <p class="marked">Replace the current Application Configuration with a new configuration. The new configuration, if accepted, will take effect after a short delay. The new configuration must comply with the Application Configuration schema, which can be found from the the Application Documentation (Developer Guide) +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/configuration</span></code></pre> @@ -11538,6 +11573,7 @@ public class ConfigurationApiExample { ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init]; Object *body = Object; // +// Set/Replace the Application Configuration (putConfiguration) [apiInstance putConfigurationWith:body completionHandler: ^(Object output, NSError* error) { if (output) { @@ -11551,10 +11587,10 @@ Object *body = Object; // </div> <div class="tab-pane" id="examples-Configuration-putConfiguration-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ConfigurationApi() +var api = new OnapCcsdkA1PolicyManagementApi.ConfigurationApi() var body = Object; // {Object} var callback = function(error, data, response) { @@ -11590,6 +11626,7 @@ namespace Example var body = Object; // Object | try { + // Set/Replace the Application Configuration (putConfiguration) Object result = apiInstance.putConfiguration(body); Debug.WriteLine(result); } catch (Exception e) { @@ -11648,6 +11685,7 @@ api_instance = openapi_client.ConfigurationApi() body = Object # Object | try: + # Set/Replace the Application Configuration (putConfiguration) api_response = api_instance.put_configuration(body) pprint(api_response) except ApiException as e: @@ -11892,7 +11930,7 @@ $(document).ready(function() { <article id="api-HealthCheck-getStatus-0" data-group="User" data-name="getStatus" data-version="0"> <div class="pull-left"> <h1>getStatus</h1> - <p></p> + <p>Get Status (getStatus)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> @@ -11997,6 +12035,7 @@ public class HealthCheckApiExample { // Create an instance of the API class HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init]; +// Get Status (getStatus) [apiInstance getStatusWithCompletionHandler: ^(StatusInfo output, NSError* error) { if (output) { @@ -12010,10 +12049,10 @@ HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init]; </div> <div class="tab-pane" id="examples-HealthCheck-getStatus-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.HealthCheckApi() +var api = new OnapCcsdkA1PolicyManagementApi.HealthCheckApi() var callback = function(error, data, response) { if (error) { console.error(error); @@ -12046,6 +12085,7 @@ namespace Example var apiInstance = new HealthCheckApi(); try { + // Get Status (getStatus) StatusInfo result = apiInstance.getStatus(); Debug.WriteLine(result); } catch (Exception e) { @@ -12101,6 +12141,7 @@ from pprint import pprint api_instance = openapi_client.HealthCheckApi() try: + # Get Status (getStatus) api_response = api_instance.get_status() pprint(api_response) except ApiException as e: @@ -12301,12 +12342,12 @@ pub fn main() { <article id="api-NearRTRICRepository-getRic-0" data-group="User" data-name="getRic" data-version="0"> <div class="pull-left"> <h1>getRic</h1> - <p>Returns info for one Near-RT RIC</p> + <p>Get a Near-RT RIC (getRic)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">A ricId path parameter must be specified to retrieve associated ric infomation</p> + <p class="marked">Get information about a Near-RT RIC</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/rics/{ricId}</span></code></pre> @@ -12414,7 +12455,7 @@ NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init]; String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (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) -// Returns info for one Near-RT RIC +// Get a Near-RT RIC (getRic) [apiInstance getRicWith:ricId accept:accept completionHandler: ^(RicInfo output, NSError* error) { @@ -12429,10 +12470,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-NearRTRICRepository-getRic-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.NearRTRICRepositoryApi() +var api = new OnapCcsdkA1PolicyManagementApi.NearRTRICRepositoryApi() var ricId = ricId_example; // {String} The identity of a Near-RT RIC to get information for. 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. @@ -12472,7 +12513,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 { - // Returns info for one Near-RT RIC + // Get a Near-RT RIC (getRic) RicInfo result = apiInstance.getRic(ricId, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -12534,7 +12575,7 @@ ricId = ricId_example # String | The identity of a Near-RT RIC to get informatio 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: - # Returns info for one Near-RT RIC + # Get a Near-RT RIC (getRic) api_response = api_instance.get_ric(ricId, accept=accept) pprint(api_response) except ApiException as e: @@ -12791,12 +12832,12 @@ Specifies the content type that the client expects to receive in response to the <article id="api-NearRTRICRepository-getRics-0" data-group="User" data-name="getRics" data-version="0"> <div class="pull-left"> <h1>getRics</h1> - <p>Query Near-RT RIC information</p> + <p>Get Near-RT RICs for A1 Policy Type (getRics)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">The call returns all Near-RT RICs that supports a given policy type identity</p> + <p class="marked">Get all Near-RT RICs that supports a given A1 Policy Type ID</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/rics</span></code></pre> @@ -12840,7 +12881,8 @@ public class NearRTRICRepositoryApiExample { // Create an instance of the API class NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi(); - String policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned + String policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 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 { @@ -12860,7 +12902,8 @@ public class NearRTRICRepositoryApiExample { final api_instance = DefaultApi(); -final String policyTypeId = new String(); // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +final String policyTypeId = new String(); // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 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 { @@ -12879,7 +12922,8 @@ try { public class NearRTRICRepositoryApiExample { public static void main(String[] args) { NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi(); - String policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned + String policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 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 { @@ -12901,10 +12945,11 @@ public class NearRTRICRepositoryApiExample { // Create an instance of the API class NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init]; -String *policyTypeId = policyTypeId_example; // The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null) +String *policyTypeId = policyTypeId_example; // The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + (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 Near-RT RIC information +// Get Near-RT RICs for A1 Policy Type (getRics) [apiInstance getRicsWith:policyTypeId accept:accept completionHandler: ^(RicInfoList output, NSError* error) { @@ -12919,12 +12964,13 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-NearRTRICRepository-getRics-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.NearRTRICRepositoryApi() +var api = new OnapCcsdkA1PolicyManagementApi.NearRTRICRepositoryApi() var opts = { - 'policyTypeId': policyTypeId_example, // {String} The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned + 'policyTypeId': policyTypeId_example, // {String} The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. }; @@ -12958,11 +13004,12 @@ namespace Example // Create an instance of the API class var apiInstance = new NearRTRICRepositoryApi(); - var policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null) + var policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + (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 Near-RT RIC information + // Get Near-RT RICs for A1 Policy Type (getRics) RicInfoList result = apiInstance.getRics(policyTypeId, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -12980,7 +13027,8 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi(); -$policyTypeId = policyTypeId_example; // String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +$policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + $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 { @@ -12999,7 +13047,8 @@ use WWW::OPenAPIClient::NearRTRICRepositoryApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new(); -my $policyTypeId = policyTypeId_example; # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +my $policyTypeId = policyTypeId_example; # String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + 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 { @@ -13020,11 +13069,12 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.NearRTRICRepositoryApi() -policyTypeId = policyTypeId_example # String | The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned (optional) (default to null) +policyTypeId = policyTypeId_example # String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + (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 Near-RT RIC information + # Get Near-RT RICs for A1 Policy Type (getRics) api_response = api_instance.get_rics(policyTypeId=policyTypeId, accept=accept) pprint(api_response) except ApiException as e: @@ -13103,7 +13153,8 @@ Specifies the content type that the client expects to receive in response to the </span> <div class="inner description marked"> -The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned +The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned. + </div> </div> </div> @@ -13281,12 +13332,13 @@ The identity of a policy type. If given, all Near-RT RICs supporting the policy <article id="api-ServiceRegistryAndSupervision-deleteService-0" data-group="User" data-name="deleteService" data-version="0"> <div class="pull-left"> <h1>deleteService</h1> - <p></p> + <p>Unregister a Service (deleteService)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Unregister a service</p> + <p class="marked">Unregister a registered Service using its service ID. Only registered services can be unregistered. All A1 Policy Instances for the previously registered service will be removed. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="delete"><code><span class="pln">/services/{serviceId}</span></code></pre> @@ -13394,6 +13446,7 @@ ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionA String *serviceId = serviceId_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) +// Unregister a Service (deleteService) [apiInstance deleteServiceWith:serviceId accept:accept completionHandler: ^(Object output, NSError* error) { @@ -13408,10 +13461,10 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-ServiceRegistryAndSupervision-deleteService-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi() +var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi() var serviceId = serviceId_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. @@ -13451,6 +13504,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 { + // Unregister a Service (deleteService) Object result = apiInstance.deleteService(serviceId, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -13512,6 +13566,7 @@ serviceId = serviceId_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: + # Unregister a Service (deleteService) api_response = api_instance.delete_service(serviceId, accept=accept) pprint(api_response) except ApiException as e: @@ -13760,12 +13815,13 @@ Specifies the content type that the client expects to receive in response to the <article id="api-ServiceRegistryAndSupervision-getServices-0" data-group="User" data-name="getServices" data-version="0"> <div class="pull-left"> <h1>getServices</h1> - <p>Returns service information</p> + <p>Get Services (getServices)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Either information about a registered service with given identity or all registered services are returned.</p> + <p class="marked">Get information about all registered services, or a single registered service. If the service ID of a registered service is included in the query, information about that service is returned. Otherwise Information about all registered is returned. This operation does not retrieve information about unregistered services. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/services</span></code></pre> @@ -13809,7 +13865,7 @@ public class ServiceRegistryAndSupervisionApiExample { // Create an instance of the API class ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi(); - String serviceId = serviceId_example; // String | The identity of the service + String serviceId = serviceId_example; // String | The identity of the registered service 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 { @@ -13829,7 +13885,7 @@ public class ServiceRegistryAndSupervisionApiExample { final api_instance = DefaultApi(); -final String serviceId = new String(); // String | The identity of the service +final String serviceId = new String(); // String | The identity of the registered service 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 { @@ -13848,7 +13904,7 @@ try { public class ServiceRegistryAndSupervisionApiExample { public static void main(String[] args) { ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi(); - String serviceId = serviceId_example; // String | The identity of the service + String serviceId = serviceId_example; // String | The identity of the registered service 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 { @@ -13870,10 +13926,10 @@ public class ServiceRegistryAndSupervisionApiExample { // Create an instance of the API class ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init]; -String *serviceId = serviceId_example; // The identity of the service (optional) (default to null) +String *serviceId = serviceId_example; // The identity of the registered service (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) -// Returns service information +// Get Services (getServices) [apiInstance getServicesWith:serviceId accept:accept completionHandler: ^(ServiceStatusList output, NSError* error) { @@ -13888,12 +13944,12 @@ String *accept = application/json; // Specifies the content type that the client </div> <div class="tab-pane" id="examples-ServiceRegistryAndSupervision-getServices-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi() +var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi() var opts = { - 'serviceId': serviceId_example, // {String} The identity of the service + 'serviceId': serviceId_example, // {String} The identity of the registered service 'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. }; @@ -13927,11 +13983,11 @@ namespace Example // Create an instance of the API class var apiInstance = new ServiceRegistryAndSupervisionApi(); - var serviceId = serviceId_example; // String | The identity of the service (optional) (default to null) + var serviceId = serviceId_example; // String | The identity of the registered service (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 { - // Returns service information + // Get Services (getServices) ServiceStatusList result = apiInstance.getServices(serviceId, accept); Debug.WriteLine(result); } catch (Exception e) { @@ -13949,7 +14005,7 @@ require_once(__DIR__ . '/vendor/autoload.php'); // Create an instance of the API class $api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi(); -$serviceId = serviceId_example; // String | The identity of the service +$serviceId = serviceId_example; // String | The identity of the registered service $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 { @@ -13968,7 +14024,7 @@ use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi; # Create an instance of the API class my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new(); -my $serviceId = serviceId_example; # String | The identity of the service +my $serviceId = serviceId_example; # String | The identity of the registered service 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 { @@ -13989,11 +14045,11 @@ from pprint import pprint # Create an instance of the API class api_instance = openapi_client.ServiceRegistryAndSupervisionApi() -serviceId = serviceId_example # String | The identity of the service (optional) (default to null) +serviceId = serviceId_example # String | The identity of the registered service (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: - # Returns service information + # Get Services (getServices) api_response = api_instance.get_services(serviceId=serviceId, accept=accept) pprint(api_response) except ApiException as e: @@ -14072,7 +14128,7 @@ Specifies the content type that the client expects to receive in response to the </span> <div class="inner description marked"> -The identity of the service +The identity of the registered service </div> </div> </div> @@ -14247,12 +14303,12 @@ The identity of the service <article id="api-ServiceRegistryAndSupervision-keepAliveService-0" data-group="User" data-name="keepAliveService" data-version="0"> <div class="pull-left"> <h1>keepAliveService</h1> - <p>Heartbeat indicates that the service is running</p> + <p>Heartbeat message from a service (keepAliveService)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)</p> + <p class="marked">A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/services/{serviceId}/keepalive</span></code></pre> @@ -14366,7 +14422,7 @@ String *serviceId = serviceId_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) String *body = body_example; // (optional) -// Heartbeat indicates that the service is running +// Heartbeat message from a service (keepAliveService) [apiInstance keepAliveServiceWith:serviceId accept:accept body:body @@ -14382,10 +14438,10 @@ String *body = body_example; // (optional) </div> <div class="tab-pane" id="examples-ServiceRegistryAndSupervision-keepAliveService-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi() +var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi() var serviceId = serviceId_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. @@ -14427,7 +14483,7 @@ namespace Example var body = body_example; // String | (optional) try { - // Heartbeat indicates that the service is running + // Heartbeat message from a service (keepAliveService) Object result = apiInstance.keepAliveService(serviceId, accept, body); Debug.WriteLine(result); } catch (Exception e) { @@ -14492,7 +14548,7 @@ accept = application/json # String | Specifies the content type that the client body = body_example # String | (optional) try: - # Heartbeat indicates that the service is running + # Heartbeat message from a service (keepAliveService) api_response = api_instance.keep_alive_service(serviceId, accept=accept, body=body) pprint(api_response) except ApiException as e: @@ -14790,12 +14846,13 @@ $(document).ready(function() { <article id="api-ServiceRegistryAndSupervision-putService-0" data-group="User" data-name="putService" data-version="0"> <div class="pull-left"> <h1>putService</h1> - <p>Register a service</p> + <p>Register or update a Service (putService)</p> </div> <div class="pull-right"></div> <div class="clearfix"></div> <p></p> - <p class="marked">Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><li>Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.</li></ul>Policies can be created even if the service is not registerred. This is a feature which it is optional to use.</p> + <p class="marked">Register a single service, or update a previous registration. Service registration is required to get callbacks about available NearRT RICs and to enable supervision of the service's active status. If a registered service becomes inactive, its policies can be automatically deleted. A1 Policy instances can also be created for unregistered services. If an unregistered service is later registered, the service's policies are retained when the service becomes registered. This feature is optional to use. +</p> <p></p> <br /> <pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/services</span></code></pre> @@ -14905,7 +14962,7 @@ public class ServiceRegistryAndSupervisionApiExample { ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init]; ServiceRegistrationInfo *serviceRegistrationInfo = ; // -// Register a service +// Register or update a Service (putService) [apiInstance putServiceWith:serviceRegistrationInfo completionHandler: ^(Object output, NSError* error) { if (output) { @@ -14919,10 +14976,10 @@ ServiceRegistrationInfo *serviceRegistrationInfo = ; // </div> <div class="tab-pane" id="examples-ServiceRegistryAndSupervision-putService-0-javascript"> - <pre class="prettyprint"><code class="language-js">var A1PolicyManagementApi = require('a1_policy_management_api'); + <pre class="prettyprint"><code class="language-js">var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api'); // Create an instance of the API class -var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi() +var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi() var serviceRegistrationInfo = ; // {ServiceRegistrationInfo} var callback = function(error, data, response) { @@ -14958,7 +15015,7 @@ namespace Example var serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | try { - // Register a service + // Register or update a Service (putService) Object result = apiInstance.putService(serviceRegistrationInfo); Debug.WriteLine(result); } catch (Exception e) { @@ -15017,7 +15074,7 @@ api_instance = openapi_client.ServiceRegistryAndSupervisionApi() serviceRegistrationInfo = # ServiceRegistrationInfo | try: - # Register a service + # Register or update a Service (putService) api_response = api_instance.put_service(serviceRegistrationInfo) pprint(api_response) except ApiException as e: diff --git a/docs/offeredapis/swagger/custom/a1pms-api-custom-v3.json b/docs/offeredapis/swagger/custom/a1pms-api-custom-v3.json index f2141968..ec085700 100644 --- a/docs/offeredapis/swagger/custom/a1pms-api-custom-v3.json +++ b/docs/offeredapis/swagger/custom/a1pms-api-custom-v3.json @@ -5,39 +5,43 @@ "email" : "discuss-list@onap.com", "url" : "https://www.onap.org/" }, - "description" : "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p>", + "description" : "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies. <br/>This document describes the latest API set to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2> <p>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.'</p> <h3>A1 Policy Management</h3> <p>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:</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy Types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3> <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3> <p>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.</p>", "license" : { "name" : "Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License.", "url" : "http://www.apache.org/licenses/LICENSE-2.0" }, - "title" : "A1 policy management API", + "title" : "ONAP CCSDK - A1 Policy Management API", "version" : "1.0.0", - "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8", + "x-api-id" : "e9776a07-0813-4fca-9801-6f892f0a7c13", "x-audience" : "external-public" }, + "externalDocs" : { + "description" : "Based on parts of O-RAN ALLIANCE specification: O-RAN.WG2.R1AP-v07.00", + "url" : "https://www.o-ran.org/specifications" + }, "servers" : [ { "url" : "{apiRoot}/a1-policy-management/v1", "variables" : { "apiRoot" : { "default" : "https://example.com", - "description" : "This is the Host:Port or Address where the A1-Policy Management Service can be accessed. Note: This URL path format aligns with the O-RAN Alliance (r) R1-AP specifiactions for A1 Policy Management" + "description" : "This is the Host:Port or Address where the A1-Policy Management Service can be accessed. Note: This URL path format aligns with the O-RAN Alliance R1-AP specifications for A1 Policy Management" } } } ], "tags" : [ { - "description" : "**(Newer Version)** API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances.", + "description" : "API used to get, create, update and delete A1 Policy Instances. Also used to query A1 Policy Types.\n", "name" : "A1 Policy Management" }, { - "description" : "API used to get the NearRT-RIC for the managed element.", + "description" : "API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "API used to keep the service Alive with in the timeout period", + "description" : "API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { - "description" : "API used to get the health status and statistics of this service", + "description" : "API used to get the health status and statistics of this service.\n", "name" : "Health Check" }, { - "description" : "API used to create or fetch the application configuration.", + "description" : "API used to create or fetch the application configuration.\n", "name" : "Configuration" } ], "paths" : { @@ -72,12 +76,13 @@ "description" : "Not Found" } }, + "summary" : "Get Status (getStatus)", "tags" : [ "Health Check" ] } }, "/rics/{ricId}" : { "get" : { - "description" : "A ricId path parameter must be specified to retrieve associated ric infomation", + "description" : "Get information about a Near-RT RIC", "operationId" : "getRic", "parameters" : [ { "description" : "The identity of a Near-RT RIC to get information for.", @@ -89,7 +94,7 @@ "nullable" : false, "type" : "string" }, - "style" : "form" + "style" : "simple" }, { "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", "explode" : false, @@ -129,16 +134,16 @@ "description" : "Not Found" } }, - "summary" : "Returns info for one Near-RT RIC", + "summary" : "Get a Near-RT RIC (getRic)", "tags" : [ "NearRT-RIC Repository" ] } }, "/rics" : { "get" : { - "description" : "The call returns all Near-RT RICs that supports a given policy type identity", + "description" : "Get all Near-RT RICs that supports a given A1 Policy Type ID", "operationId" : "getRics", "parameters" : [ { - "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned", + "description" : "The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.\n", "explode" : true, "in" : "query", "name" : "policyTypeId", @@ -186,13 +191,13 @@ "description" : "Not Found" } }, - "summary" : "Query Near-RT RIC information", + "summary" : "Get Near-RT RICs for A1 Policy Type (getRics)", "tags" : [ "NearRT-RIC Repository" ] } }, "/policy-types" : { "get" : { - "description" : "Query policy type identities", + "description" : "Query A1 Policy Type identities using query parameters", "operationId" : "getPolicyTypes", "parameters" : [ { "description" : "Select types for the given Near-RT RIC identity.", @@ -205,7 +210,7 @@ }, "style" : "form" }, { - "description" : "Select types with the given type name (type identity has the format <typename_version>)", + "description" : "Select types compatible with the given type name (type identity has the format 'typename_version')", "explode" : true, "in" : "query", "name" : "typeName", @@ -215,7 +220,7 @@ }, "style" : "form" }, { - "description" : "Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.", + "description" : "Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.\n", "explode" : true, "in" : "query", "name" : "compatibleWithVersion", @@ -346,12 +351,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Get A1 Policy Types (getPolicyTypes)", "tags" : [ "A1 Policy Management" ] } }, "/policy-types/{policyTypeId}" : { "get" : { - "description" : "Returns a policy type definition", + "description" : "Get an A1 Policy Type definition using its policy type ID", "operationId" : "getPolicyTypeDefinition", "parameters" : [ { "explode" : false, @@ -388,7 +394,7 @@ } } }, - "description" : "OK - schema of the given policy type" + "description" : "OK - details and schema of the requested A1 Policy Type" }, "400" : { "content" : { @@ -481,12 +487,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy Type definition (getPolicyTypeDefinition)", "tags" : [ "A1 Policy Management" ] } }, "/policies/{policyId}" : { "delete" : { - "description" : "Deleting the policy using policyId.", + "description" : "Delete an existing A1 Policy instance using its policy ID.", "operationId" : "deletePolicy", "parameters" : [ { "explode" : false, @@ -579,7 +586,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -629,11 +636,11 @@ "description" : "Service Unavailable" } }, - "summary" : "Delete a policy", + "summary" : "Delete an A1 Policy instance (deletePolicy)", "tags" : [ "A1 Policy Management" ] }, "get" : { - "description" : "Returns a policy", + "description" : "Get an A1 Policy instance's policy data using its policy ID", "operationId" : "getPolicy", "parameters" : [ { "explode" : false, @@ -763,10 +770,11 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy's policy data (getPolicy)", "tags" : [ "A1 Policy Management" ] }, "put" : { - "description" : "update a policy", + "description" : "Update an existing A1 Policy instance's policy data using its policy ID.", "operationId" : "putPolicy", "parameters" : [ { "explode" : false, @@ -890,7 +898,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -940,12 +948,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Update an A1 Policy's policy data (putPolicy)", "tags" : [ "A1 Policy Management" ] } }, "/policies/{policyId}/status" : { "get" : { - "description" : "Query a policy status", + "description" : "Retrieve the status information for an A1 Policy Instance using its policy ID.", "operationId" : "getPolicyStatus", "parameters" : [ { "explode" : false, @@ -1070,15 +1079,16 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy Instance's status (getPolicyStatus)", "tags" : [ "A1 Policy Management" ] } }, "/policies" : { "get" : { - "description" : "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.", + "description" : "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.\n", "operationId" : "getAllPolicies", "parameters" : [ { - "description" : "Select policies of a given policy type identity.", + "description" : "Select policies with a given A1 Policy Type ID.", "explode" : true, "in" : "query", "name" : "policyTypeId", @@ -1088,7 +1098,7 @@ }, "style" : "form" }, { - "description" : "Select policies of a given Near-RT RIC identity.", + "description" : "Select policies for a given Near-RT RIC identity.", "explode" : true, "in" : "query", "name" : "nearRtRicId", @@ -1098,7 +1108,7 @@ }, "style" : "form" }, { - "description" : "Select policies owned by a given service.", + "description" : "Select policies owned by a given service (registered or unregistered).", "explode" : true, "in" : "query", "name" : "serviceId", @@ -1108,7 +1118,7 @@ }, "style" : "form" }, { - "description" : "Select policies of types with the given type name (type identity has the format <typename_version>)", + "description" : "Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').", "explode" : true, "in" : "query", "name" : "typeName", @@ -1234,11 +1244,11 @@ "description" : "Service Unavailable" } }, - "summary" : "Query policy identities", + "summary" : "Query for A1 Policy instances (getAllPolicies)", "tags" : [ "A1 Policy Management" ] }, "post" : { - "description" : "To create A1 policies", + "description" : "Create an A1 Policy Instance", "operationId" : "createPolicy", "requestBody" : { "content" : { @@ -1262,7 +1272,7 @@ "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", "explode" : false, "required" : true, "schema" : { @@ -1377,7 +1387,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -1427,12 +1437,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Create an A1 Policy Instance (createPolicy)", "tags" : [ "A1 Policy Management" ] } }, "/configuration" : { "get" : { - "description" : "Returns the contents of the application configuration", + "description" : "Returns the entire contents of the Application Configuration.", "operationId" : "getConfiguration", "responses" : { "200" : { @@ -1456,10 +1467,11 @@ "description" : "Not Found" } }, + "summary" : "Get the Application Configuration (getConfiguration)", "tags" : [ "Configuration" ] }, "put" : { - "description" : "Replace the current configuration file with the given configuration", + "description" : "Replace the current Application Configuration with a new configuration. The new configuration, if accepted, will take effect after a short delay. The new configuration must comply with the Application Configuration schema, which can be found from the the Application Documentation (Developer Guide) \n", "operationId" : "putConfiguration", "requestBody" : { "content" : { @@ -1493,12 +1505,13 @@ "description" : "Bad Request" } }, + "summary" : "Set/Replace the Application Configuration (putConfiguration)", "tags" : [ "Configuration" ] } }, "/services/{serviceId}/keepalive" : { "put" : { - "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)", + "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.", "operationId" : "keepAliveService", "parameters" : [ { "explode" : false, @@ -1553,16 +1566,16 @@ "description" : "Not Found" } }, - "summary" : "Heartbeat indicates that the service is running", + "summary" : "Heartbeat message from a service (keepAliveService)", "tags" : [ "Service Registry and Supervision" ] } }, "/services" : { "get" : { - "description" : "Either information about a registered service with given identity or all registered services are returned.", + "description" : "Get information about all registered services, or a single registered service. If the service ID of a registered service is included in the query, information about that service is returned. Otherwise Information about all registered is returned. This operation does not retrieve information about unregistered services.\n", "operationId" : "getServices", "parameters" : [ { - "description" : "The identity of the service", + "description" : "The identity of the registered service", "explode" : true, "in" : "query", "name" : "serviceId", @@ -1610,7 +1623,7 @@ "description" : "Not Found" } }, - "summary" : "Returns service information", + "summary" : "Get Services (getServices)", "tags" : [ "Service Registry and Supervision" ] }, "put" : { @@ -1618,7 +1631,7 @@ "RICStatus" : { "{$request.body#/callback_url}" : { "post" : { - "description" : "The URL to this call is registered at Service registration. <br>Callouts to indicate status changes relevant for Services. Note that these calls are called by A1-PMS and they are not provided.", + "description" : "Callouts to indicate Near-RT RIC status changes relevant for Services. \nThe URL invoked by this callback is provided at Service registration.\n", "operationId" : "serviceCallback", "requestBody" : { "content" : { @@ -1652,12 +1665,13 @@ "description" : "Not Found" } }, - "summary" : "Callback for Near-RT RIC status." + "summary" : "Callback for Near-RT RIC status (serviceCallback)", + "tags" : [ "Service Registry and Supervision" ] } } } }, - "description" : "Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><li>Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.</li></ul>Policies can be created even if the service is not registerred. This is a feature which it is optional to use.", + "description" : "Register a single service, or update a previous registration. Service registration is required to get callbacks about available NearRT RICs and to enable supervision of the service's active status. If a registered service becomes inactive, its policies can be automatically deleted. A1 Policy instances can also be created for unregistered services. If an unregistered service is later registered, the service's policies are retained when the service becomes registered. This feature is optional to use.\n", "operationId" : "putService", "requestBody" : { "content" : { @@ -1701,13 +1715,13 @@ "description" : "Bad Request" } }, - "summary" : "Register a service", + "summary" : "Register or update a Service (putService)", "tags" : [ "Service Registry and Supervision" ] } }, "/services/{serviceId}" : { "delete" : { - "description" : "Unregister a service", + "description" : "Unregister a registered Service using its service ID. Only registered services can be unregistered. All A1 Policy Instances for the previously registered service will be removed.\n", "operationId" : "deleteService", "parameters" : [ { "explode" : false, @@ -1752,6 +1766,7 @@ "description" : "Not Found" } }, + "summary" : "Unregister a Service (deleteService)", "tags" : [ "Service Registry and Supervision" ] } } @@ -1762,43 +1777,43 @@ "description" : "List of service information", "value" : { "serviceList" : [ { - "callbackUrl" : "callbackUrl", - "serviceId" : "serviceId", + "callbackUrl" : "http://callback.url", + "serviceId" : "serviceId1", "keepAliveIntervalSeconds" : 0, "timeSinceLastActivitySeconds" : 6 }, { - "callbackUrl" : "callbackUrl", - "serviceId" : "serviceId", - "keepAliveIntervalSeconds" : 0, - "timeSinceLastActivitySeconds" : 6 + "callbackUrl" : "http://callback.url", + "serviceId" : "serviceId2", + "keepAliveIntervalSeconds" : 500, + "timeSinceLastActivitySeconds" : 401 } ] } }, "StatusInfo" : { "value" : { - "status" : "status" + "status" : "success" } }, "RicInfo" : { "value" : { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId1", + "managedElementIds" : [ "Note #1", "Athlone small cells", "Some optional string" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] } }, "RicInfoList" : { "value" : { "rics" : [ { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId1", + "managedElementIds" : [ "Note #1", "Athlone small cells", "Fake Cells" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] }, { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId2", + "managedElementIds" : [ "My test element", "Another test element" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId3", "policyTypeId4" ] } ] } }, @@ -1847,16 +1862,16 @@ "PolicyTypeInformation" : { "value" : [ { "policyTypeId" : "STD_QOS2_0.1.0", - "nearRtRicId" : "ricsim_g3_2" + "nearRtRicId" : "ric_g3_2" }, { "policyTypeId" : "STD_QOS_0_2_0", - "nearRtRicId" : "ricsim_g3_2" + "nearRtRicId" : "ric_g3_2" }, { "policyTypeId" : "STD_QOS2_0.1.0", - "nearRtRicId" : "ricsim_g3_1" + "nearRtRicId" : "ric_g3_1" }, { "policyTypeId" : "STD_QOS_0_2_0", - "nearRtRicId" : "ricsim_g3_1" + "nearRtRicId" : "ric_g3_1" } ] }, "PolicyTypeObject" : { @@ -2042,7 +2057,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -2054,14 +2069,14 @@ }, "schemas" : { "PolicyTypeInformation" : { - "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" }, "properties" : { "policyTypeId" : { - "description" : "Identity of the policy type", + "description" : "A1 Policy Type identifier", "type" : "string" }, "nearRtRicId" : { @@ -2072,36 +2087,36 @@ "type" : "object" }, "PolicyObjectInformation" : { - "description" : "Information related to the creation of the policy", + "description" : "Information to create an A1 Policy Instance", "properties" : { "nearRtRicId" : { "description" : "Identity of the target Near-RT RIC", - "example" : "Near-RT-Ric-ID", + "example" : "Near-RT-Ric-ID1", "type" : "string" }, "transient" : { "default" : false, - "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, "type" : "boolean" }, "policyId" : { - "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", "type" : "string" }, "serviceId" : { "default" : "", - "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", "type" : "string" }, "policyObject" : { "$ref" : "#/components/schemas/PolicyObject" }, "policyTypeId" : { - "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)'", "type" : "string" } }, @@ -2112,7 +2127,7 @@ "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807", "properties" : { "detail" : { - "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", "type" : "string" }, @@ -2122,7 +2137,7 @@ "type" : "string" }, "status" : { - "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", "example" : 404, "format" : "int32", "type" : "integer" @@ -2131,16 +2146,16 @@ "type" : "object" }, "PolicyObject" : { - "description" : "Policy Object is a JSON representation of an A1 policy", + "description" : "Policy Object is a JSON representation policy data for an A1 Policy Instance. The schema for this policy data is defined in the corresponding A1 Policy Type. \n", "type" : "object" }, "PolicyTypeObject" : { - "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" : { @@ -2171,7 +2186,7 @@ "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" : { @@ -2197,15 +2212,15 @@ "type" : "object" }, "PolicySchema" : { - "description" : "The schemas are policy type specific", + "description" : "A schema to define the policy data contents of A1 Policy Instances. Policy data schemas are Policy Type specific. All A1 Policy Instances of an A1 Policy Type should comply with the type's policy data schema.\n", "type" : "object" }, "StatusSchema" : { - "description" : "The optional schema for policy status", + "description" : "A schema to define the contents of the status information for A1 Policy Instances. Status schemas are Policy Type specific. All status information for all A1 Policy Instances of an A1 Policy Type should comply with the type's status schema.\n", "type" : "object" }, "PolicyStatusObject" : { - "description" : "A generic policy status object that can be used to transport any policy status. Additionally, a policy status shall be valid according to the schema of its specific policy type.", + "description" : "A generic policy status object that can be used to transport any policy status. Additionally, a schema for policy status can be defined in the corresponding A1 Policy Type.\n", "type" : "object" }, "void" : { @@ -2215,7 +2230,7 @@ "StatusInfo" : { "properties" : { "status" : { - "description" : "status text", + "description" : "Status text", "type" : "string" } }, @@ -2229,22 +2244,22 @@ "type" : "string" }, "managedElementIds" : { - "description" : "O1 identities for managed entities", + "description" : "Identities for managed entities", "items" : { - "description" : "O1 identities for managed entities", + "description" : "Identity for a managed entity", "type" : "string" }, "type" : "array" }, "state" : { - "description" : "Represents the states for a Near-RT RIC", + "description" : "Represents the state of a Near-RT RIC", "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ], "type" : "string" }, "policyTypeIds" : { - "description" : "supported policy types", + "description" : "Supported A1 Policy Types", "items" : { - "description" : "supported policy types", + "description" : "Supported A1 Policy Type ID", "type" : "string" }, "type" : "array" @@ -2253,10 +2268,10 @@ "type" : "object" }, "ServiceRegistrationInfo" : { - "description" : "Information for one service", + "description" : "Information for a service to be registered", "properties" : { "callbackUrl" : { - "description" : "callback for notifying of Near-RT RIC state changes", + "description" : "Callback URL for notifying of Near-RT RIC state changes", "type" : "string" }, "serviceId" : { @@ -2264,7 +2279,7 @@ "type" : "string" }, "keepAliveIntervalSeconds" : { - "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", "type" : "integer" } @@ -2273,9 +2288,10 @@ "type" : "object" }, "ServiceStatus" : { + "description" : "Information about a previously registered service", "properties" : { "callbackUrl" : { - "description" : "callback for notifying of RIC synchronization", + "description" : "Callback URL for notifying of Near-RT RIC state changes", "type" : "string" }, "serviceId" : { @@ -2283,12 +2299,12 @@ "type" : "string" }, "keepAliveIntervalSeconds" : { - "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", "type" : "integer" }, "timeSinceLastActivitySeconds" : { - "description" : "time since last invocation by the service", + "description" : "Time (seconds) since last recorded operation by the service", "format" : "int64", "type" : "integer" } @@ -2296,10 +2312,10 @@ "type" : "object" }, "RicInfoList" : { - "description" : "List of Near-RT RIC information", + "description" : "Collection of Near-RT RIC information objects", "properties" : { "rics" : { - "description" : "List of Near-RT RIC information", + "description" : "List of Near-RT RIC information objects", "items" : { "$ref" : "#/components/schemas/RicInfo" }, @@ -2309,14 +2325,14 @@ "type" : "object" }, "NearRtRicId" : { - "description" : "Identity of the policy", + "description" : "Identity of the Near-RT RIC", "type" : "string" }, "PolicyInformation" : { - "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", "properties" : { "policyId" : { - "description" : "Identity of the policy", + "description" : "Identity of the A1 Policy Instance", "type" : "string" }, "nearRtRicId" : { @@ -2329,7 +2345,7 @@ "ServiceStatusList" : { "properties" : { "serviceList" : { - "description" : "List of service information", + "description" : "List of Service Status objects, describing a collection of registered services.", "items" : { "$ref" : "#/components/schemas/ServiceStatus" }, @@ -2339,14 +2355,14 @@ "type" : "object" }, "ServiceCallbackInfo" : { - "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", "properties" : { "ricId" : { "description" : "Identity of a Near-RT RIC", "type" : "string" }, "eventType" : { - "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" ], "type" : "string" } @@ -2355,22 +2371,22 @@ "type" : "object" }, "ProblemDetails" : { - "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", "properties" : { "type" : { - "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", "type" : "string" }, "title" : { - "description" : "human-readable summary of the problem type", + "description" : "Human-readable summary of the problem type", "type" : "string" }, "status" : { - "description" : "the HTTP status code", + "description" : "HTTP status code", "type" : "number" }, "detail" : { - "description" : "human-readable explanation ", + "description" : "Human-readable explanation", "type" : "string" }, "instance" : { diff --git a/docs/offeredapis/swagger/pms-api-v3.json b/docs/offeredapis/swagger/pms-api-v3.json index f2141968..ec085700 100644 --- a/docs/offeredapis/swagger/pms-api-v3.json +++ b/docs/offeredapis/swagger/pms-api-v3.json @@ -5,39 +5,43 @@ "email" : "discuss-list@onap.com", "url" : "https://www.onap.org/" }, - "description" : "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p>", + "description" : "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service provides a REST API for managing A1 policies. <br/>This document describes the latest API set to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs provided or defined by the service</h2> <p>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.'</p> <h3>A1 Policy Management</h3> <p>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:</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy Types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3> <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3> <p>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.</p>", "license" : { "name" : "Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License.", "url" : "http://www.apache.org/licenses/LICENSE-2.0" }, - "title" : "A1 policy management API", + "title" : "ONAP CCSDK - A1 Policy Management API", "version" : "1.0.0", - "x-api-id" : "a31c510b-20e6-4a08-af16-368c44d7fba8", + "x-api-id" : "e9776a07-0813-4fca-9801-6f892f0a7c13", "x-audience" : "external-public" }, + "externalDocs" : { + "description" : "Based on parts of O-RAN ALLIANCE specification: O-RAN.WG2.R1AP-v07.00", + "url" : "https://www.o-ran.org/specifications" + }, "servers" : [ { "url" : "{apiRoot}/a1-policy-management/v1", "variables" : { "apiRoot" : { "default" : "https://example.com", - "description" : "This is the Host:Port or Address where the A1-Policy Management Service can be accessed. Note: This URL path format aligns with the O-RAN Alliance (r) R1-AP specifiactions for A1 Policy Management" + "description" : "This is the Host:Port or Address where the A1-Policy Management Service can be accessed. Note: This URL path format aligns with the O-RAN Alliance R1-AP specifications for A1 Policy Management" } } } ], "tags" : [ { - "description" : "**(Newer Version)** API used to create polices, Policy Instances and get them as individual using an ID or get all policies/Instances.", + "description" : "API used to get, create, update and delete A1 Policy Instances. Also used to query A1 Policy Types.\n", "name" : "A1 Policy Management" }, { - "description" : "API used to get the NearRT-RIC for the managed element.", + "description" : "API used to get information about registered Near-RT RICs.\n", "name" : "NearRT-RIC Repository" }, { - "description" : "API used to keep the service Alive with in the timeout period", + "description" : "API used to manage registered services, and control their keep-alive status via heart-beat messages.\n", "name" : "Service Registry and Supervision" }, { - "description" : "API used to get the health status and statistics of this service", + "description" : "API used to get the health status and statistics of this service.\n", "name" : "Health Check" }, { - "description" : "API used to create or fetch the application configuration.", + "description" : "API used to create or fetch the application configuration.\n", "name" : "Configuration" } ], "paths" : { @@ -72,12 +76,13 @@ "description" : "Not Found" } }, + "summary" : "Get Status (getStatus)", "tags" : [ "Health Check" ] } }, "/rics/{ricId}" : { "get" : { - "description" : "A ricId path parameter must be specified to retrieve associated ric infomation", + "description" : "Get information about a Near-RT RIC", "operationId" : "getRic", "parameters" : [ { "description" : "The identity of a Near-RT RIC to get information for.", @@ -89,7 +94,7 @@ "nullable" : false, "type" : "string" }, - "style" : "form" + "style" : "simple" }, { "description" : "Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.", "explode" : false, @@ -129,16 +134,16 @@ "description" : "Not Found" } }, - "summary" : "Returns info for one Near-RT RIC", + "summary" : "Get a Near-RT RIC (getRic)", "tags" : [ "NearRT-RIC Repository" ] } }, "/rics" : { "get" : { - "description" : "The call returns all Near-RT RICs that supports a given policy type identity", + "description" : "Get all Near-RT RICs that supports a given A1 Policy Type ID", "operationId" : "getRics", "parameters" : [ { - "description" : "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned", + "description" : "The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.\n", "explode" : true, "in" : "query", "name" : "policyTypeId", @@ -186,13 +191,13 @@ "description" : "Not Found" } }, - "summary" : "Query Near-RT RIC information", + "summary" : "Get Near-RT RICs for A1 Policy Type (getRics)", "tags" : [ "NearRT-RIC Repository" ] } }, "/policy-types" : { "get" : { - "description" : "Query policy type identities", + "description" : "Query A1 Policy Type identities using query parameters", "operationId" : "getPolicyTypes", "parameters" : [ { "description" : "Select types for the given Near-RT RIC identity.", @@ -205,7 +210,7 @@ }, "style" : "form" }, { - "description" : "Select types with the given type name (type identity has the format <typename_version>)", + "description" : "Select types compatible with the given type name (type identity has the format 'typename_version')", "explode" : true, "in" : "query", "name" : "typeName", @@ -215,7 +220,7 @@ }, "style" : "form" }, { - "description" : "Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.", + "description" : "Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.\n", "explode" : true, "in" : "query", "name" : "compatibleWithVersion", @@ -346,12 +351,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Get A1 Policy Types (getPolicyTypes)", "tags" : [ "A1 Policy Management" ] } }, "/policy-types/{policyTypeId}" : { "get" : { - "description" : "Returns a policy type definition", + "description" : "Get an A1 Policy Type definition using its policy type ID", "operationId" : "getPolicyTypeDefinition", "parameters" : [ { "explode" : false, @@ -388,7 +394,7 @@ } } }, - "description" : "OK - schema of the given policy type" + "description" : "OK - details and schema of the requested A1 Policy Type" }, "400" : { "content" : { @@ -481,12 +487,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy Type definition (getPolicyTypeDefinition)", "tags" : [ "A1 Policy Management" ] } }, "/policies/{policyId}" : { "delete" : { - "description" : "Deleting the policy using policyId.", + "description" : "Delete an existing A1 Policy instance using its policy ID.", "operationId" : "deletePolicy", "parameters" : [ { "explode" : false, @@ -579,7 +586,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -629,11 +636,11 @@ "description" : "Service Unavailable" } }, - "summary" : "Delete a policy", + "summary" : "Delete an A1 Policy instance (deletePolicy)", "tags" : [ "A1 Policy Management" ] }, "get" : { - "description" : "Returns a policy", + "description" : "Get an A1 Policy instance's policy data using its policy ID", "operationId" : "getPolicy", "parameters" : [ { "explode" : false, @@ -763,10 +770,11 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy's policy data (getPolicy)", "tags" : [ "A1 Policy Management" ] }, "put" : { - "description" : "update a policy", + "description" : "Update an existing A1 Policy instance's policy data using its policy ID.", "operationId" : "putPolicy", "parameters" : [ { "explode" : false, @@ -890,7 +898,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -940,12 +948,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Update an A1 Policy's policy data (putPolicy)", "tags" : [ "A1 Policy Management" ] } }, "/policies/{policyId}/status" : { "get" : { - "description" : "Query a policy status", + "description" : "Retrieve the status information for an A1 Policy Instance using its policy ID.", "operationId" : "getPolicyStatus", "parameters" : [ { "explode" : false, @@ -1070,15 +1079,16 @@ "description" : "Service Unavailable" } }, + "summary" : "Get an A1 Policy Instance's status (getPolicyStatus)", "tags" : [ "A1 Policy Management" ] } }, "/policies" : { "get" : { - "description" : "Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.", + "description" : "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.\n", "operationId" : "getAllPolicies", "parameters" : [ { - "description" : "Select policies of a given policy type identity.", + "description" : "Select policies with a given A1 Policy Type ID.", "explode" : true, "in" : "query", "name" : "policyTypeId", @@ -1088,7 +1098,7 @@ }, "style" : "form" }, { - "description" : "Select policies of a given Near-RT RIC identity.", + "description" : "Select policies for a given Near-RT RIC identity.", "explode" : true, "in" : "query", "name" : "nearRtRicId", @@ -1098,7 +1108,7 @@ }, "style" : "form" }, { - "description" : "Select policies owned by a given service.", + "description" : "Select policies owned by a given service (registered or unregistered).", "explode" : true, "in" : "query", "name" : "serviceId", @@ -1108,7 +1118,7 @@ }, "style" : "form" }, { - "description" : "Select policies of types with the given type name (type identity has the format <typename_version>)", + "description" : "Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').", "explode" : true, "in" : "query", "name" : "typeName", @@ -1234,11 +1244,11 @@ "description" : "Service Unavailable" } }, - "summary" : "Query policy identities", + "summary" : "Query for A1 Policy instances (getAllPolicies)", "tags" : [ "A1 Policy Management" ] }, "post" : { - "description" : "To create A1 policies", + "description" : "Create an A1 Policy Instance", "operationId" : "createPolicy", "requestBody" : { "content" : { @@ -1262,7 +1272,7 @@ "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", "explode" : false, "required" : true, "schema" : { @@ -1377,7 +1387,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -1427,12 +1437,13 @@ "description" : "Service Unavailable" } }, + "summary" : "Create an A1 Policy Instance (createPolicy)", "tags" : [ "A1 Policy Management" ] } }, "/configuration" : { "get" : { - "description" : "Returns the contents of the application configuration", + "description" : "Returns the entire contents of the Application Configuration.", "operationId" : "getConfiguration", "responses" : { "200" : { @@ -1456,10 +1467,11 @@ "description" : "Not Found" } }, + "summary" : "Get the Application Configuration (getConfiguration)", "tags" : [ "Configuration" ] }, "put" : { - "description" : "Replace the current configuration file with the given configuration", + "description" : "Replace the current Application Configuration with a new configuration. The new configuration, if accepted, will take effect after a short delay. The new configuration must comply with the Application Configuration schema, which can be found from the the Application Documentation (Developer Guide) \n", "operationId" : "putConfiguration", "requestBody" : { "content" : { @@ -1493,12 +1505,13 @@ "description" : "Bad Request" } }, + "summary" : "Set/Replace the Application Configuration (putConfiguration)", "tags" : [ "Configuration" ] } }, "/services/{serviceId}/keepalive" : { "put" : { - "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)", + "description" : "A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.", "operationId" : "keepAliveService", "parameters" : [ { "explode" : false, @@ -1553,16 +1566,16 @@ "description" : "Not Found" } }, - "summary" : "Heartbeat indicates that the service is running", + "summary" : "Heartbeat message from a service (keepAliveService)", "tags" : [ "Service Registry and Supervision" ] } }, "/services" : { "get" : { - "description" : "Either information about a registered service with given identity or all registered services are returned.", + "description" : "Get information about all registered services, or a single registered service. If the service ID of a registered service is included in the query, information about that service is returned. Otherwise Information about all registered is returned. This operation does not retrieve information about unregistered services.\n", "operationId" : "getServices", "parameters" : [ { - "description" : "The identity of the service", + "description" : "The identity of the registered service", "explode" : true, "in" : "query", "name" : "serviceId", @@ -1610,7 +1623,7 @@ "description" : "Not Found" } }, - "summary" : "Returns service information", + "summary" : "Get Services (getServices)", "tags" : [ "Service Registry and Supervision" ] }, "put" : { @@ -1618,7 +1631,7 @@ "RICStatus" : { "{$request.body#/callback_url}" : { "post" : { - "description" : "The URL to this call is registered at Service registration. <br>Callouts to indicate status changes relevant for Services. Note that these calls are called by A1-PMS and they are not provided.", + "description" : "Callouts to indicate Near-RT RIC status changes relevant for Services. \nThe URL invoked by this callback is provided at Service registration.\n", "operationId" : "serviceCallback", "requestBody" : { "content" : { @@ -1652,12 +1665,13 @@ "description" : "Not Found" } }, - "summary" : "Callback for Near-RT RIC status." + "summary" : "Callback for Near-RT RIC status (serviceCallback)", + "tags" : [ "Service Registry and Supervision" ] } } } }, - "description" : "Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><li>Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.</li></ul>Policies can be created even if the service is not registerred. This is a feature which it is optional to use.", + "description" : "Register a single service, or update a previous registration. Service registration is required to get callbacks about available NearRT RICs and to enable supervision of the service's active status. If a registered service becomes inactive, its policies can be automatically deleted. A1 Policy instances can also be created for unregistered services. If an unregistered service is later registered, the service's policies are retained when the service becomes registered. This feature is optional to use.\n", "operationId" : "putService", "requestBody" : { "content" : { @@ -1701,13 +1715,13 @@ "description" : "Bad Request" } }, - "summary" : "Register a service", + "summary" : "Register or update a Service (putService)", "tags" : [ "Service Registry and Supervision" ] } }, "/services/{serviceId}" : { "delete" : { - "description" : "Unregister a service", + "description" : "Unregister a registered Service using its service ID. Only registered services can be unregistered. All A1 Policy Instances for the previously registered service will be removed.\n", "operationId" : "deleteService", "parameters" : [ { "explode" : false, @@ -1752,6 +1766,7 @@ "description" : "Not Found" } }, + "summary" : "Unregister a Service (deleteService)", "tags" : [ "Service Registry and Supervision" ] } } @@ -1762,43 +1777,43 @@ "description" : "List of service information", "value" : { "serviceList" : [ { - "callbackUrl" : "callbackUrl", - "serviceId" : "serviceId", + "callbackUrl" : "http://callback.url", + "serviceId" : "serviceId1", "keepAliveIntervalSeconds" : 0, "timeSinceLastActivitySeconds" : 6 }, { - "callbackUrl" : "callbackUrl", - "serviceId" : "serviceId", - "keepAliveIntervalSeconds" : 0, - "timeSinceLastActivitySeconds" : 6 + "callbackUrl" : "http://callback.url", + "serviceId" : "serviceId2", + "keepAliveIntervalSeconds" : 500, + "timeSinceLastActivitySeconds" : 401 } ] } }, "StatusInfo" : { "value" : { - "status" : "status" + "status" : "success" } }, "RicInfo" : { "value" : { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId1", + "managedElementIds" : [ "Note #1", "Athlone small cells", "Some optional string" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] } }, "RicInfoList" : { "value" : { "rics" : [ { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId1", + "managedElementIds" : [ "Note #1", "Athlone small cells", "Fake Cells" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId1", "policyTypeId2" ] }, { - "ricId" : "ricId", - "managedElementIds" : [ "managedElementId", "managedElementId" ], + "ricId" : "ricId2", + "managedElementIds" : [ "My test element", "Another test element" ], "state" : "UNAVAILABLE", - "policyTypeIds" : [ "policyTypeId", "policyTypeId" ] + "policyTypeIds" : [ "policyTypeId3", "policyTypeId4" ] } ] } }, @@ -1847,16 +1862,16 @@ "PolicyTypeInformation" : { "value" : [ { "policyTypeId" : "STD_QOS2_0.1.0", - "nearRtRicId" : "ricsim_g3_2" + "nearRtRicId" : "ric_g3_2" }, { "policyTypeId" : "STD_QOS_0_2_0", - "nearRtRicId" : "ricsim_g3_2" + "nearRtRicId" : "ric_g3_2" }, { "policyTypeId" : "STD_QOS2_0.1.0", - "nearRtRicId" : "ricsim_g3_1" + "nearRtRicId" : "ric_g3_1" }, { "policyTypeId" : "STD_QOS_0_2_0", - "nearRtRicId" : "ricsim_g3_1" + "nearRtRicId" : "ric_g3_1" } ] }, "PolicyTypeObject" : { @@ -2042,7 +2057,7 @@ "example" : { "status" : 423, "title" : "Locked", - "detail" : "State is Locked in the provided request." + "detail" : "State is Locked in the provided request." }, "schema" : { "$ref" : "#/components/schemas/ErrorInformation" @@ -2054,14 +2069,14 @@ }, "schemas" : { "PolicyTypeInformation" : { - "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" }, "properties" : { "policyTypeId" : { - "description" : "Identity of the policy type", + "description" : "A1 Policy Type identifier", "type" : "string" }, "nearRtRicId" : { @@ -2072,36 +2087,36 @@ "type" : "object" }, "PolicyObjectInformation" : { - "description" : "Information related to the creation of the policy", + "description" : "Information to create an A1 Policy Instance", "properties" : { "nearRtRicId" : { "description" : "Identity of the target Near-RT RIC", - "example" : "Near-RT-Ric-ID", + "example" : "Near-RT-Ric-ID1", "type" : "string" }, "transient" : { "default" : false, - "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, "type" : "boolean" }, "policyId" : { - "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", "type" : "string" }, "serviceId" : { "default" : "", - "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", "type" : "string" }, "policyObject" : { "$ref" : "#/components/schemas/PolicyObject" }, "policyTypeId" : { - "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)'", "type" : "string" } }, @@ -2112,7 +2127,7 @@ "description" : "Problem as defined in https://tools.ietf.org/html/rfc7807", "properties" : { "detail" : { - "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", "type" : "string" }, @@ -2122,7 +2137,7 @@ "type" : "string" }, "status" : { - "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", "example" : 404, "format" : "int32", "type" : "integer" @@ -2131,16 +2146,16 @@ "type" : "object" }, "PolicyObject" : { - "description" : "Policy Object is a JSON representation of an A1 policy", + "description" : "Policy Object is a JSON representation policy data for an A1 Policy Instance. The schema for this policy data is defined in the corresponding A1 Policy Type. \n", "type" : "object" }, "PolicyTypeObject" : { - "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" : { @@ -2171,7 +2186,7 @@ "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" : { @@ -2197,15 +2212,15 @@ "type" : "object" }, "PolicySchema" : { - "description" : "The schemas are policy type specific", + "description" : "A schema to define the policy data contents of A1 Policy Instances. Policy data schemas are Policy Type specific. All A1 Policy Instances of an A1 Policy Type should comply with the type's policy data schema.\n", "type" : "object" }, "StatusSchema" : { - "description" : "The optional schema for policy status", + "description" : "A schema to define the contents of the status information for A1 Policy Instances. Status schemas are Policy Type specific. All status information for all A1 Policy Instances of an A1 Policy Type should comply with the type's status schema.\n", "type" : "object" }, "PolicyStatusObject" : { - "description" : "A generic policy status object that can be used to transport any policy status. Additionally, a policy status shall be valid according to the schema of its specific policy type.", + "description" : "A generic policy status object that can be used to transport any policy status. Additionally, a schema for policy status can be defined in the corresponding A1 Policy Type.\n", "type" : "object" }, "void" : { @@ -2215,7 +2230,7 @@ "StatusInfo" : { "properties" : { "status" : { - "description" : "status text", + "description" : "Status text", "type" : "string" } }, @@ -2229,22 +2244,22 @@ "type" : "string" }, "managedElementIds" : { - "description" : "O1 identities for managed entities", + "description" : "Identities for managed entities", "items" : { - "description" : "O1 identities for managed entities", + "description" : "Identity for a managed entity", "type" : "string" }, "type" : "array" }, "state" : { - "description" : "Represents the states for a Near-RT RIC", + "description" : "Represents the state of a Near-RT RIC", "enum" : [ "UNAVAILABLE", "AVAILABLE", "SYNCHRONIZING", "CONSISTENCY_CHECK" ], "type" : "string" }, "policyTypeIds" : { - "description" : "supported policy types", + "description" : "Supported A1 Policy Types", "items" : { - "description" : "supported policy types", + "description" : "Supported A1 Policy Type ID", "type" : "string" }, "type" : "array" @@ -2253,10 +2268,10 @@ "type" : "object" }, "ServiceRegistrationInfo" : { - "description" : "Information for one service", + "description" : "Information for a service to be registered", "properties" : { "callbackUrl" : { - "description" : "callback for notifying of Near-RT RIC state changes", + "description" : "Callback URL for notifying of Near-RT RIC state changes", "type" : "string" }, "serviceId" : { @@ -2264,7 +2279,7 @@ "type" : "string" }, "keepAliveIntervalSeconds" : { - "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", "type" : "integer" } @@ -2273,9 +2288,10 @@ "type" : "object" }, "ServiceStatus" : { + "description" : "Information about a previously registered service", "properties" : { "callbackUrl" : { - "description" : "callback for notifying of RIC synchronization", + "description" : "Callback URL for notifying of Near-RT RIC state changes", "type" : "string" }, "serviceId" : { @@ -2283,12 +2299,12 @@ "type" : "string" }, "keepAliveIntervalSeconds" : { - "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", "type" : "integer" }, "timeSinceLastActivitySeconds" : { - "description" : "time since last invocation by the service", + "description" : "Time (seconds) since last recorded operation by the service", "format" : "int64", "type" : "integer" } @@ -2296,10 +2312,10 @@ "type" : "object" }, "RicInfoList" : { - "description" : "List of Near-RT RIC information", + "description" : "Collection of Near-RT RIC information objects", "properties" : { "rics" : { - "description" : "List of Near-RT RIC information", + "description" : "List of Near-RT RIC information objects", "items" : { "$ref" : "#/components/schemas/RicInfo" }, @@ -2309,14 +2325,14 @@ "type" : "object" }, "NearRtRicId" : { - "description" : "Identity of the policy", + "description" : "Identity of the Near-RT RIC", "type" : "string" }, "PolicyInformation" : { - "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", "properties" : { "policyId" : { - "description" : "Identity of the policy", + "description" : "Identity of the A1 Policy Instance", "type" : "string" }, "nearRtRicId" : { @@ -2329,7 +2345,7 @@ "ServiceStatusList" : { "properties" : { "serviceList" : { - "description" : "List of service information", + "description" : "List of Service Status objects, describing a collection of registered services.", "items" : { "$ref" : "#/components/schemas/ServiceStatus" }, @@ -2339,14 +2355,14 @@ "type" : "object" }, "ServiceCallbackInfo" : { - "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", "properties" : { "ricId" : { "description" : "Identity of a Near-RT RIC", "type" : "string" }, "eventType" : { - "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" ], "type" : "string" } @@ -2355,22 +2371,22 @@ "type" : "object" }, "ProblemDetails" : { - "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", "properties" : { "type" : { - "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", "type" : "string" }, "title" : { - "description" : "human-readable summary of the problem type", + "description" : "Human-readable summary of the problem type", "type" : "string" }, "status" : { - "description" : "the HTTP status code", + "description" : "HTTP status code", "type" : "number" }, "detail" : { - "description" : "human-readable explanation ", + "description" : "Human-readable explanation", "type" : "string" }, "instance" : { diff --git a/docs/offeredapis/swagger/pms-api-v3.yaml b/docs/offeredapis/swagger/pms-api-v3.yaml index 4df9d61a..e08bea1a 100644 --- a/docs/offeredapis/swagger/pms-api-v3.yaml +++ b/docs/offeredapis/swagger/pms-api-v3.yaml @@ -1,5 +1,6 @@ # ============LICENSE_START======================================================= -# Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. All rights reserved. +# Copyright (C) 2020-2023 Nordix Foundation. 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. @@ -18,62 +19,76 @@ openapi: 3.0.3 info: - title: 'A1 policy management API' + title: ONAP CCSDK - A1 Policy Management API version: 1.0.0 - x-api-id: a31c510b-20e6-4a08-af16-368c44d7fba8 + x-api-id: e9776a07-0813-4fca-9801-6f892f0a7c13 x-audience: external-public description: "<h2>General</h2><p>The ONAP CCSDK A1 Policy Management Service\ - \ provides a REST API for managemecnt of A1 policies. <br/>The main tasks of the\ - \ service are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring\ - \ and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining\ - \ a view of supported Near-RT RIC policy types</li><li>Supervision of using services\ - \ (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs\ - \ provided or defined by the service</h2><h3>A1 Policy Management</h3><p>This\ - \ is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation,\ - \ modification and deletion.</li><li>Retrieval of supported A1 Policy types for\ - \ a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management\ - \ of configuration</h3><p>API for updating and retrieval of the component configuration.\ - \ Note that there other ways to maintain the configuration.</p><h3>Service callbacks</h3><p>These\ - \ are endpoints that are invoked by this service. The callbacks are registered\ - \ in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This\ - \ is an API that provides support for looking up a NearRT-RIC. Each A1 policy\ - \ is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision\ - \ of the PMS component.</p><h3>Service Registry and Supervision</h3><p>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.</p><h3>Authorization API</h3><p>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.</p>" + \ provides a REST API for managing A1 policies. <br/>This document describes the latest API set + \ to perform tasks for: </p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring\ + \ and maintaining consistency of the SMO view of A1 Policies and the Near-RT RICs</li><li>Maintaining\ + \ a view of each Near-RT RIC's supported A1 Policy Types</li><li>Supervision of registered services\ + \ (rApps). When a registered service is unavailable, its policies are removed.</li></ul><h2>APIs\ + \ provided or defined by the service</h2>\ + \ <p>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.'</p>\ + \ <h3>A1 Policy Management</h3>\ + \ <p>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:</p><ul><li>A1 Policy retrieval, creation,\ + \ modification and deletion.</li><li>Retrieval of supported A1 Policy Types for\ + \ a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management\ + \ of configuration</h3><p>API for updating and retrieval of the component configuration.\ + \ Note that there other ways to maintain the configuration.</p><h3>Service Callbacks</h3><p>These\ + \ are endpoints that are invoked by this service. The callbacks are registered\ + \ in this service at service registration.</p><h3>NearRT-RIC Repository (Older version)</h3>\ + \ <p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy\ + \ is targeted towards one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision\ + \ of the A1 Policy Management Service.</p><h3>Service Registry and Supervision</h3>\ + \ <p>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.</p>" license: name: Copyright (C) 2024 - 2025 OpenInfra Foundation Europe. Licensed under the Apache 2 License. url: http://www.apache.org/licenses/LICENSE-2.0 contact: url: https://www.onap.org/ email: discuss-list@onap.com +externalDocs: + description: 'Based on parts of O-RAN ALLIANCE specification: O-RAN.WG2.R1AP-v07.00' + url: 'https://www.o-ran.org/specifications' servers: - url: '{apiRoot}/a1-policy-management/v1' variables: apiRoot: default: 'https://example.com' description: 'This is the Host:Port or Address where the A1-Policy Management Service can be accessed. - Note: This URL path format aligns with the O-RAN Alliance (r) R1-AP specifiactions for A1 Policy Management' + Note: This URL path format aligns with the O-RAN Alliance R1-AP specifications for A1 Policy Management' tags: - name: A1 Policy Management - description: "**(Newer Version)** API used to create polices, Policy Instances and get \ them as individual using an ID or get all policies/Instances." + description: > + API used to get, create, update and delete A1 Policy Instances. Also used to query A1 Policy Types. - name: NearRT-RIC Repository - description: "API used to get the NearRT-RIC for the managed element." + description: > + API used to get information about registered Near-RT RICs. - name: Service Registry and Supervision - description: "API used to keep the service Alive with in the timeout period" + description: > + API used to manage registered services, and control their keep-alive status via heart-beat messages. - name: Health Check - description: "API used to get the health status and statistics of this service" + description: > + API used to get the health status and statistics of this service. - name: Configuration - description: "API used to create or fetch the application configuration." + description: > + API used to create or fetch the application configuration. paths: /status: get: operationId: getStatus + description: Returns status and statistics of this service + summary: Get Status (getStatus) + tags: + - Health Check responses: "200": content: @@ -86,13 +101,13 @@ paths: description: OK- Service is living Ok "404": $ref: '#/components/responses/404' - description: Returns status and statistics of this service - tags: - - Health Check /rics/{ricId}: get: - description: A ricId path parameter must be specified to retrieve associated ric infomation operationId: getRic + description: Get information about a Near-RT RIC + summary: Get a Near-RT RIC (getRic) + tags: + - NearRT-RIC Repository parameters: - description: The identity of a Near-RT RIC to get information for. explode: true @@ -102,7 +117,6 @@ paths: schema: type: string nullable: false - style: form - description: Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. in: header @@ -122,16 +136,17 @@ paths: description: OK - Near-RT RIC is found OK "404": $ref: '#/components/responses/404' - summary: Returns info for one Near-RT RIC - tags: - - NearRT-RIC Repository /rics: get: - description: The call returns all Near-RT RICs that supports a given policy - type identity operationId: getRics + description: Get all Near-RT RICs that supports a given A1 Policy Type ID + summary: Get Near-RT RICs for A1 Policy Type (getRics) + tags: + - NearRT-RIC Repository parameters: - - description: "The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned" + - description: > + The identity of an A1 Policy Type. If given, all Near-RT RICs supporting + the A1 Policy Type are returned. explode: true in: query name: policyTypeId @@ -158,12 +173,13 @@ paths: description: OK "404": $ref: '#/components/responses/404' - summary: Query Near-RT RIC information - tags: - - NearRT-RIC Repository /policy-types: get: + description: Query A1 Policy Type identities using query parameters operationId: getPolicyTypes + summary: Get A1 Policy Types (getPolicyTypes) + tags: + - A1 Policy Management parameters: - description: Select types for the given Near-RT RIC identity. explode: true @@ -173,8 +189,7 @@ paths: schema: type: string style: form - - description: Select types with the given type name (type identity has the - format <typename_version>) + - description: Select types compatible with the given type name (type identity has the format 'typename_version') explode: true in: query name: typeName @@ -182,8 +197,9 @@ paths: schema: type: string style: form - - description: Select types that are compatible with the given version. This - parameter is only applicable in conjunction with type_name. As an example + - description: > + Select types that are compatible with the given version. This + parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order. explode: true @@ -230,12 +246,13 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: Query policy type identities - tags: - - A1 Policy Management /policy-types/{policyTypeId}: get: operationId: getPolicyTypeDefinition + description: Get an A1 Policy Type definition using its policy type ID + summary: Get an A1 Policy Type definition (getPolicyTypeDefinition) + tags: + - A1 Policy Management parameters: - explode: false in: path @@ -260,7 +277,7 @@ paths: examples: PolicyTypeObject: $ref: '#/components/examples/PolicyTypeObject' - description: OK - schema of the given policy type + description: OK - details and schema of the requested A1 Policy Type '400': $ref: '#/components/responses/400' '401': @@ -279,12 +296,13 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: Returns a policy type definition - tags: - - A1 Policy Management /policies/{policyId}: put: operationId: putPolicy + description: Update an existing A1 Policy instance's policy data using its policy ID. + summary: Update an A1 Policy's policy data (putPolicy) + tags: + - A1 Policy Management parameters: - name: policyId in: path @@ -333,12 +351,12 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: update a policy - tags: - - A1 Policy Management delete: - description: Deleting the policy using policyId. operationId: deletePolicy + description: Delete an existing A1 Policy instance using its policy ID. + summary: Delete an A1 Policy instance (deletePolicy) + tags: + - A1 Policy Management parameters: - explode: false in: path @@ -379,11 +397,12 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - summary: Delete a policy - tags: - - A1 Policy Management get: operationId: getPolicy + description: Get an A1 Policy instance's policy data using its policy ID + summary: Get an A1 Policy's policy data (getPolicy) + tags: + - A1 Policy Management parameters: - explode: false in: path @@ -427,12 +446,13 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: Returns a policy - tags: - - A1 Policy Management /policies/{policyId}/status: get: operationId: getPolicyStatus + description: Retrieve the status information for an A1 Policy Instance using its policy ID. + summary: Get an A1 Policy Instance's status (getPolicyStatus) + tags: + - A1 Policy Management parameters: - explode: false in: path @@ -473,18 +493,17 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: 'Query a policy status' - tags: - - A1 Policy Management - /policies: get: - description: "Returns a list of A1 policies matching given search criteria.\ - \ <br>If several query parameters are defined, the policies matching all conditions\ - \ are returned." operationId: getAllPolicies + description: > + 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. + summary: Query for A1 Policy instances (getAllPolicies) + tags: + - A1 Policy Management parameters: - - description: Select policies of a given policy type identity. + - description: Select policies with a given A1 Policy Type ID. explode: true in: query name: policyTypeId @@ -492,7 +511,7 @@ paths: schema: type: string style: form - - description: Select policies of a given Near-RT RIC identity. + - description: Select policies for a given Near-RT RIC identity. explode: true in: query name: nearRtRicId @@ -500,7 +519,7 @@ paths: schema: type: string style: form - - description: Select policies owned by a given service. + - description: Select policies owned by a given service (registered or unregistered). explode: true in: query name: serviceId @@ -508,8 +527,7 @@ paths: schema: type: string style: form - - description: Select policies of types with the given type name (type identity - has the format <typename_version>) + - description: Select policies of a given A1 Policy Type name (type identity has the format 'typename_version'). explode: true in: query name: typeName @@ -551,11 +569,12 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - summary: Query policy identities - tags: - - A1 Policy Management post: operationId: createPolicy + description: Create an A1 Policy Instance + summary: Create an A1 Policy Instance (createPolicy) + tags: + - A1 Policy Management requestBody: required: true content: @@ -571,7 +590,10 @@ paths: $ref: '#/components/schemas/PolicyObjectInformation' 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. required: true schema: type: string @@ -609,12 +631,13 @@ paths: $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' - description: 'To create A1 policies' - tags: - - A1 Policy Management /configuration: get: operationId: getConfiguration + description: Returns the entire contents of the Application Configuration. + tags: + - Configuration + summary: Get the Application Configuration (getConfiguration) responses: "200": content: @@ -624,12 +647,16 @@ paths: description: OK - Application configuration received "404": $ref: '#/components/responses/404' - - description: Returns the contents of the application configuration - tags: - - Configuration put: operationId: putConfiguration + description: > + Replace the current Application Configuration with a new configuration. + The new configuration, if accepted, will take effect after a short delay. + The new configuration must comply with the Application Configuration schema, + which can be found from the the Application Documentation (Developer Guide) + tags: + - Configuration + summary: Set/Replace the Application Configuration (putConfiguration) requestBody: content: application/json: @@ -645,17 +672,19 @@ paths: description: OK - Configuration updated "400": $ref: '#/components/responses/400' - description: Replace the current configuration file with the given configuration - tags: - - Configuration /services/{serviceId}/keepalive: put: - description: A registered service should invoke this operation regularly to - indicate that it is still alive. If a registered service fails to invoke this - operation before the end of a timeout period the service will be deregistered - and all its A1 policies wil be removed. (This timeout can be set or disabled - when each service is initially registered) operationId: keepAliveService + description: A registered service should invoke this operation regularly to + indicate that it is still alive. If a registered service fails to invoke some operation, + or this operation, before the end of a timeout period the service will be deregistered + and all its A1 policies wil be removed and the service is deleted. + This operation is only intended for registered services. (This timeout can be set or disabled when + each service is initially registered). Unregistered services do not need to invoke this operation, + since the optional keep-alive monitoring feature can only be enabled for registered services. + summary: Heartbeat message from a service (keepAliveService) + tags: + - Service Registry and Supervision parameters: - explode: false in: path @@ -683,19 +712,22 @@ paths: 'application/json': schema: type: object - description: "OK - Service supervision timer refreshed, OK" + description: OK - Service supervision timer refreshed, OK "404": $ref: '#/components/responses/404' - summary: Heartbeat indicates that the service is running - tags: - - Service Registry and Supervision /services: get: - description: Either information about a registered service with given identity - or all registered services are returned. operationId: getServices + description: > + Get information about all registered services, or a single registered service. + If the service ID of a registered service is included in the query, information about that + service is returned. Otherwise Information about all registered is returned. + This operation does not retrieve information about unregistered services. + summary: Get Services (getServices) + tags: + - Service Registry and Supervision parameters: - - description: The identity of the service + - description: The identity of the registered service explode: true in: query name: serviceId @@ -722,16 +754,19 @@ paths: description: OK "404": $ref: '#/components/responses/404' - summary: Returns service information - tags: - - Service Registry and Supervision put: - description: "Registering a service is needed to:<ul><li>Get callbacks about\ - \ available NearRT RICs.</li><li>Activate supervision of the service. If a\ - \ service is inactive, its policies will automatically be deleted.</li></ul>Policies\ - \ can be created even if the service is not registerred. This is a feature\ - \ which it is optional to use." operationId: putService + description: > + Register a single service, or update a previous registration. + Service registration is required to get callbacks about available NearRT RICs + and to enable supervision of the service's active status. If a registered + service becomes inactive, its policies can be automatically deleted. + A1 Policy instances can also be created for unregistered services. + If an unregistered service is later registered, the service's policies are + retained when the service becomes registered. This feature is optional to use. + summary: Register or update a Service (putService) + tags: + - Service Registry and Supervision requestBody: content: application/json: @@ -753,15 +788,17 @@ paths: description: Created - Service created "400": $ref: '#/components/responses/400' - summary: Register a service - tags: - - Service Registry and Supervision callbacks: RICStatus: "{$request.body#/callback_url}": post: - description: 'The URL to this call is registered at Service registration. <br>Callouts to indicate status changes relevant for Services. Note that these calls are called by A1-PMS and they are not provided.' operationId: serviceCallback + description: | + Callouts to indicate Near-RT RIC status changes relevant for Services. + The URL invoked by this callback is provided at Service registration. + summary: Callback for Near-RT RIC status (serviceCallback) + tags: + - Service Registry and Supervision requestBody: content: application/json: @@ -777,10 +814,16 @@ paths: description: OK "404": $ref: '#/components/responses/404' - summary: "Callback for Near-RT RIC status." /services/{serviceId}: delete: operationId: deleteService + description: > + Unregister a registered Service using its service ID. + Only registered services can be unregistered. All A1 Policy Instances + for the previously registered service will be removed. + tags: + - Service Registry and Supervision + summary: Unregister a Service (deleteService) parameters: - explode: false in: path @@ -805,55 +848,56 @@ paths: description: No Content - Service unregistered "404": $ref: '#/components/responses/404' - description: Unregister a service - tags: - - Service Registry and Supervision + components: + examples: ServiceStatusList: description: List of service information value: serviceList: - - callbackUrl: callbackUrl - serviceId: serviceId - keepAliveIntervalSeconds: 0 - timeSinceLastActivitySeconds: 6 - - callbackUrl: callbackUrl - serviceId: serviceId + - callbackUrl: http://callback.url + serviceId: serviceId1 keepAliveIntervalSeconds: 0 timeSinceLastActivitySeconds: 6 + - callbackUrl: http://callback.url + serviceId: serviceId2 + keepAliveIntervalSeconds: 500 + timeSinceLastActivitySeconds: 401 StatusInfo: value: - status: status + status: success RicInfo: value: - ricId: ricId + ricId: ricId1 managedElementIds: - - managedElementId - - managedElementId + - "Note #1" + - "Athlone small cells" + - "Some optional string" state: UNAVAILABLE policyTypeIds: - - policyTypeId - - policyTypeId + - policyTypeId1 + - policyTypeId2 RicInfoList: value: rics: - - ricId: ricId + - ricId: ricId1 managedElementIds: - - managedElementId - - managedElementId + - "Note #1" + - "Athlone small cells" + - "Fake Cells" state: UNAVAILABLE policyTypeIds: - - policyTypeId - - policyTypeId - - ricId: ricId + - policyTypeId1 + - policyTypeId2 + - ricId: ricId2 managedElementIds: - - managedElementId - - managedElementId + - "My test element" + - "Another test element" state: UNAVAILABLE policyTypeIds: - - policyTypeId - - policyTypeId + - policyTypeId3 + - policyTypeId4 PolicyObject: value: scope: @@ -885,13 +929,13 @@ components: PolicyTypeInformation: value: - policyTypeId: STD_QOS2_0.1.0 - nearRtRicId: ricsim_g3_2 + nearRtRicId: ric_g3_2 - policyTypeId: STD_QOS_0_2_0 - nearRtRicId: ricsim_g3_2 + nearRtRicId: ric_g3_2 - policyTypeId: STD_QOS2_0.1.0 - nearRtRicId: ricsim_g3_1 + nearRtRicId: ric_g3_1 - policyTypeId: STD_QOS_0_2_0 - nearRtRicId: ricsim_g3_1 + nearRtRicId: ric_g3_1 PolicyTypeObject: value: policySchema: @@ -919,16 +963,15 @@ components: additionalProperties: false required: - priorityLevel + schemas: PolicyTypeInformation: 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 + A data tuple to indicate that an identified A1 Policy Type is supported at an identified Near-RT RIC. type: object properties: policyTypeId: - description: Identity of the policy type + description: A1 Policy Type identifier type: string nearRtRicId: $ref: '#/components/schemas/NearRtRicId' @@ -937,42 +980,50 @@ components: - nearRtRicId example: policyTypeId: STD_QOS2_0.1.0 - nearRtRicId: ricsim_g3_2 + nearRtRicId: ric_g3_2 PolicyObjectInformation: - description: Information related to the creation of the policy + description: Information to create an A1 Policy Instance type: object properties: nearRtRicId: description: Identity of the target Near-RT RIC type: string example: - 'Near-RT-Ric-ID' + 'Near-RT-Ric-ID1' transient: default: false - 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. nullable: false type: boolean policyId: - description: The identity of the Policy. If this value is present, it must be unique; otherwise, a random UUID is generated. + 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. type: string example: - 'POLICY-ID' + 'POLICY-ID1' serviceId: 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. + 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. type: string example: - 'rApp ID' + 'rApp 1' default: "" policyObject: $ref: '#/components/schemas/PolicyObject' policyTypeId: - description: Identity of the policy type + description: A1 Policy Type identity type: string - example: 'ORAN_QOS_1.0.0(typeName_SemVersion)' + example: ORAN_QOS_1.0.0 '(typeName_SemVersion)' required: - nearRtRicId - policyObject @@ -981,26 +1032,27 @@ components: description: Problem as defined in https://tools.ietf.org/html/rfc7807 properties: detail: - 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 type: string title: - description: 'A specific error name' + description: A specific error name type: string example: Not Found status: - 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. example: 404 format: int32 type: integer type: object PolicyObject: - description: 'Policy Object is a JSON representation of an A1 policy' + description: > + Policy Object is a JSON representation policy data for an A1 Policy Instance. + The schema for this policy data is defined in the corresponding A1 Policy Type. type: object PolicyTypeObject: - description: 'policy type object as defined in A1TD' + description: An A1 Policy Type, as defined in O-RAN Alliance A1TD type: object properties: policySchema: @@ -1008,12 +1060,12 @@ components: statusSchema: $ref: '#/components/schemas/StatusSchema' required: - - "policySchema" + - policySchema 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: @@ -1038,7 +1090,7 @@ components: 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: @@ -1049,13 +1101,22 @@ components: required: - enforceStatus PolicySchema: - description: 'The schemas are policy type specific' + description: > + A schema to define the policy data contents of A1 Policy Instances. + Policy data schemas are Policy Type specific. + All A1 Policy Instances of an A1 Policy Type should comply with the type's policy data schema. type: object StatusSchema: - description: 'The optional schema for policy status' + description: > + A schema to define the contents of the status information for A1 Policy Instances. + Status schemas are Policy Type specific. + All status information for all A1 Policy Instances of an A1 Policy Type should comply + with the type's status schema. type: object PolicyStatusObject: - description: 'A generic policy status object that can be used to transport any policy status. Additionally, a policy status shall be valid according to the schema of its specific policy type.' + description: > + A generic policy status object that can be used to transport any policy status. + Additionally, a schema for policy status can be defined in the corresponding A1 Policy Type. type: object void: description: Void/empty @@ -1063,7 +1124,7 @@ components: StatusInfo: properties: status: - description: status text + description: Status text type: string type: object RicInfo: @@ -1073,13 +1134,13 @@ components: description: Identity of the Near-RT RIC type: string managedElementIds: - description: O1 identities for managed entities + description: Identities for managed entities items: - description: O1 identities for managed entities + description: Identity for a managed entity type: string type: array state: - description: Represents the states for a Near-RT RIC + description: Represents the state of a Near-RT RIC enum: - UNAVAILABLE - AVAILABLE @@ -1087,72 +1148,80 @@ components: - CONSISTENCY_CHECK type: string policyTypeIds: - description: supported policy types + description: Supported A1 Policy Types items: - description: supported policy types + description: Supported A1 Policy Type ID type: string type: array type: object ServiceRegistrationInfo: - description: Information for one service + description: Information for a service to be registered properties: callbackUrl: - description: callback for notifying of Near-RT RIC state changes + description: Callback URL for notifying of Near-RT RIC state changes type: string serviceId: description: Identity of the service type: string keepAliveIntervalSeconds: - 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. format: int64 type: integer required: - serviceId type: object ServiceStatus: + description: Information about a previously registered service properties: callbackUrl: - description: callback for notifying of RIC synchronization + description: Callback URL for notifying of Near-RT RIC state changes type: string serviceId: description: Identity of the service type: string keepAliveIntervalSeconds: - 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. format: int64 type: integer timeSinceLastActivitySeconds: - description: time since last invocation by the service + description: Time (seconds) since last recorded operation by the service format: int64 type: integer type: object RicInfoList: - description: List of Near-RT RIC information + description: Collection of Near-RT RIC information objects properties: rics: - description: List of Near-RT RIC information + description: List of Near-RT RIC information objects items: $ref: '#/components/schemas/RicInfo' type: array type: object NearRtRicId: - description: Identity of the policy + description: Identity of the Near-RT RIC type: string PolicyInformation: - 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. type: object properties: policyId: - description: Identity of the policy + description: Identity of the A1 Policy Instance type: string nearRtRicId: $ref: '#/components/schemas/NearRtRicId' @@ -1162,20 +1231,23 @@ components: ServiceStatusList: properties: serviceList: - description: List of service information + description: List of Service Status objects, describing a collection of registered services. items: $ref: '#/components/schemas/ServiceStatus' type: array type: object ServiceCallbackInfo: - description: Information transferred as in Service callbacks (callback_url) + description: | + Information transferred in Service callbacks, + if a callback URL was provided for a registered service properties: ricId: description: Identity of a Near-RT RIC type: string eventType: - description: "values:\nAVAILABLE: the Near-RT RIC has become available\ - \ for A1 Policy management" + description: > + values: + AVAILABLE: the Near-RT RIC has become available for A1 Policy management enum: - AVAILABLE type: string @@ -1184,28 +1256,25 @@ components: - ricId type: object ProblemDetails: - 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 type: object properties: type: - 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 type: string title: - description: human-readable summary of the problem type + description: Human-readable summary of the problem type type: string status: - description: the HTTP status code + description: HTTP status code type: number detail: - description: 'human-readable explanation ' + description: Human-readable explanation type: string instance: description: URI reference that identifies the specific occurrence of the problem type: string + responses: '400': description: Bad Request @@ -1292,7 +1361,7 @@ components: schema: $ref: '#/components/schemas/ProblemDetails' Locked: - description: "Locked - HTTP Status code which can be used when the state is Locked" + description: Locked - HTTP Status code which can be used when the state is Locked content: application/problem+json: schema: @@ -1300,4 +1369,4 @@ components: example: status: 423 title: Locked - detail: State is Locked in the provided request. + detail: State is Locked in the provided request. |
