Update docs for pagination support in ACM-r endpoints

Issue-ID: POLICY-5366
Change-Id: I2a815cc3106e3730e990af8bde0ea50a41cd0e38
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>

diff --git a/docs/clamp/acm/design-impl/clamp-runtime-acm.rst b/docs/clamp/acm/design-impl/clamp-runtime-acm.rst
index 9204e4c..37dbd31 100644 (file)
--- a/docs/clamp/acm/design-impl/clamp-runtime-acm.rst
+++ b/docs/clamp/acm/design-impl/clamp-runtime-acm.rst
@@ -27,7 +27,8 @@ Design of Rest Api
 Check CLAMP Runtime and Participants
 ++++++++++++++++++++++++++++++++++++
 - GUI calls GET "/onap/policy/clamp/acm/health" endpoint and receives the "UP" status as response
-- GUI calls GET "/onap/policy/clamp/acm/v2/participants" endpoint and receives all participants registered with supported Element Types as response
+- GUI calls GET "/onap/policy/clamp/acm/v2/participants" endpoint and receives as response: all participants with supported Element Types, all replicas registered, and all compositions and instances connected. The end point supports the pagination by parameters "size" and "page"
+- GUI calls GET "/onap/policy/clamp/acm/v2/participants/{participantId}" endpoint and receives as response: the participant with supported Element Types, all replicas registered, and all compositions and instances connected. The end point supports the pagination by parameters "size" and "page"
 
 Order an immediate Participant Report from all participants
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -43,6 +44,11 @@ Create of a Automation Composition Definition Type
 - It saves to DB the Tosca Service Template using AcDefinitionProvider with new compositionId and COMMISSIONED status
 - the Rest-Api call returns the compositionId generated and the list of Element Definition Type
 
+Fetch of Automation Composition Definition Type
++++++++++++++++++++++++++++++++++++++++++++++++
+- GUI calls GET "/onap/policy/clamp/acm/v2/compositions" endpoint and receives all compositions as response. The end point supports the pagination by parameters "size" and "page"
+- GUI calls GET "/onap/policy/clamp/acm/v2/compositions/{compositionId}" endpoint and receives the composition as response.
+
 Update of a Automation Composition Definition Type
 ++++++++++++++++++++++++++++++++++++++++++++++++++
 - GUI calls POST "/onap/policy/clamp/acm/v2/compositions" endpoint with a Automation Composition Type Definition (Tosca Service Template) as body. It have to contain the compositionId
@@ -71,6 +77,11 @@ Create of a Automation Composition Instance
 - It saves the Automation Composition to DB with UNDEPLOYED deployState and NONE lockState
 - the Rest-Api call returns the instanceId and the list of AC Element Instance
 
+Fetch of Automation Composition Instance
+++++++++++++++++++++++++++++++++++++++++
+- GUI calls GET "/onap/policy/clamp/acm/v2/compositions/{compositionId}/instances" endpoint and receives all instances of a composition as response. The end point supports the pagination by parameters "size" and "page"
+- GUI calls GET "/onap/policy/clamp/acm/v2/compositions/{compositionId}/instances/{instanceId}" endpoint and receives the instance as response.
+
 Update of a Automation Composition Instance
 +++++++++++++++++++++++++++++++++++++++++++
 - GUI calls POST "/onap/policy/clamp/acm/v2/compositions/{compositionId}/instances" endpoint with a Automation Composition Instance as body. It have to contain the compositionId and the instanceId