From 606e13641be5bd07e0e9fed7775598d450860275 Mon Sep 17 00:00:00 2001 From: FrancescoFioraEst Date: Fri, 22 Aug 2025 13:02:25 +0100 Subject: [PATCH] Add docs for /instances endpoint in ACM-r Issue-ID: POLICY-5434 Change-Id: I86b82728b119f272a8c1b0618e1086309d8f13ae Signed-off-by: FrancescoFioraEst --- docs/clamp/acm/design-impl/clamp-runtime-acm.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/clamp/acm/design-impl/clamp-runtime-acm.rst b/docs/clamp/acm/design-impl/clamp-runtime-acm.rst index 784ec4aa..5c6359ad 100644 --- a/docs/clamp/acm/design-impl/clamp-runtime-acm.rst +++ b/docs/clamp/acm/design-impl/clamp-runtime-acm.rst @@ -104,6 +104,27 @@ 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. +- GUI calls GET "/onap/policy/clamp/acm/v2/instances" endpoint and receives all instances as response. The end point supports filter by list of instanceId, list of deployState, list of stateChangeResult and pagination by parameters "size", "page" and "sortOrder" + +Examples for GET "/onap/policy/clamp/acm/v2/instances": + +----------------------------------------------------+------------------------------------------------------+ + | Query Parameters | result | + +====================================================+======================================================+ + | | all instances | + +----------------------------------------------------+------------------------------------------------------+ + | ?page=1&size=4 | 4 instances at page 1 if present | + +----------------------------------------------------+------------------------------------------------------+ + | ?size=4 | all instances because page is missing | + +----------------------------------------------------+------------------------------------------------------+ + | ?sort=name&sortOrder=DESC | instances ordered by name in DESC order | + +----------------------------------------------------+------------------------------------------------------+ + | ?stateChangeResult=FAILED,TIMEOUT | instances failed or in timeout | + +----------------------------------------------------+------------------------------------------------------+ + | ?stateChangeResult=NO_ERROR&deployState=UNDEPLOYED | instances undeployed with success | + +----------------------------------------------------+------------------------------------------------------+ + | ?instanceIds={instances1},{instances2} | instance1 and instance2 | + +----------------------------------------------------+------------------------------------------------------+ + Update of a Automation Composition Instance +++++++++++++++++++++++++++++++++++++++++++ -- 2.16.6