aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/swagger
diff options
context:
space:
mode:
authorDan Timoney <dtimoney@att.com>2023-08-10 17:05:46 -0400
committerDan Timoney <dtimoney@att.com>2023-08-10 17:05:46 -0400
commit42477eb05ce4599a13814ee47f1bf21afc21714d (patch)
tree00471164e95b73bcda64a35e26a5d9f70f601115 /docs/offeredapis/swagger
parentc86b5aeaba70df89d89bdeec1f77ebea5a9efe7b (diff)
Update parent pom version to 2.6.0
Update parent pom version to Montreal / ODL Argon version (2.6.0) Issue-ID: CCSDK-3928 Signed-off-by: Dan Timoney <dtimoney@att.com> Change-Id: Ie073750372797d80f144351a3e4e1cad63291eb9
Diffstat (limited to 'docs/offeredapis/swagger')
-rw-r--r--docs/offeredapis/swagger/pms-api.yaml37
1 files changed, 20 insertions, 17 deletions
diff --git a/docs/offeredapis/swagger/pms-api.yaml b/docs/offeredapis/swagger/pms-api.yaml
index a905c40e..44dc2ba4 100644
--- a/docs/offeredapis/swagger/pms-api.yaml
+++ b/docs/offeredapis/swagger/pms-api.yaml
@@ -6,28 +6,31 @@ info:
\ 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 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>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\
+ \ 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>Spring Boot Actuator</h3><p>Provides\
- \ generic functions used to monitor and manage the Spring web application.</p>"
+ \ 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><h3>Spring Boot\
+ \ Actuator</h3><p>Provides generic functions used to monitor and manage the Spring\
+ \ web application.</p>"
license:
name: Copyright (C) 2020-2023 Nordix Foundation. Licensed under the Apache License.
url: http://www.apache.org/licenses/LICENSE-2.0
title: A1 Policy Management Service
- version: 1.1.0
+ version: 1.2.0
servers:
- url: /
tags:
@@ -879,7 +882,7 @@ paths:
description: OK
summary: Callback for Near-RT RIC status
tags:
- - Callbacks
+ - Service callbacks
/a1-policy/v2/services/{service_id}:
delete:
operationId: deleteService