aboutsummaryrefslogtreecommitdiffstats
path: root/a1-policy-management/api/pms-api.yaml
diff options
context:
space:
mode:
authorJohnKeeney <john.keeney@est.tech>2022-05-24 12:34:49 +0100
committerJohnKeeney <john.keeney@est.tech>2022-05-25 16:26:44 +0100
commit08486cf3a7972219c3d017d5e47a2c802b225794 (patch)
tree871ede7b291e9d7b94544fd091a29d8494a9ef9e /a1-policy-management/api/pms-api.yaml
parentca9a543e882c0fa891230d72311d5f7631d099bc (diff)
Attempt to get stdout&stderr for CSIT tests
Also small tweak for RTD documentation Issue-ID: CCSDK-3675 Change-Id: Idd8acca0e07dc45c6f76a78a321b1075f3ee31ef Signed-off-by: JohnKeeney <john.keeney@est.tech>
Diffstat (limited to 'a1-policy-management/api/pms-api.yaml')
-rw-r--r--a1-policy-management/api/pms-api.yaml23
1 files changed, 13 insertions, 10 deletions
diff --git a/a1-policy-management/api/pms-api.yaml b/a1-policy-management/api/pms-api.yaml
index 3fd496bd..1f84399e 100644
--- a/a1-policy-management/api/pms-api.yaml
+++ b/a1-policy-management/api/pms-api.yaml
@@ -1,6 +1,6 @@
openapi: 3.0.1
info:
- title: A1 Policy management service
+ title: A1 Policy Management Service
description: <h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides
a REST API for management 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
@@ -434,9 +434,11 @@ paths:
tags:
- Service Registry and Supervision
summary: Heartbeat indicates that the service is running
- description: A registered service must call this in regular intervals to indicate
- that it is in operation. Absence of this call will lead to that the service
- will be deregistered and all its policies are removed.
+ 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
parameters:
- name: service_id
@@ -896,12 +898,13 @@ components:
description: identity of the service
keep_alive_interval_seconds:
type: integer
- description: keep alive interval for the service. This is a heartbeat supervision
- of the service, which in regular intervals must invoke a 'keepalive' REST
- call. When a service does not invoke this call within the given time,
- it is considered unavailable. An unavailable service will be automatically
- deregistered and its policies will be deleted. Value 0 means no timeout
- supervision.
+ 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
description: Information for one service
policy_info_list_v2: