From: FrancescoFioraEst Date: Fri, 22 Aug 2025 12:02:25 +0000 (+0100) Subject: Add docs for /instances endpoint in ACM-r X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F94%2F141894%2F2;p=policy%2Fparent.git Add docs for /instances endpoint in ACM-r Issue-ID: POLICY-5434 Change-Id: I86b82728b119f272a8c1b0618e1086309d8f13ae Signed-off-by: FrancescoFioraEst --- 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 +++++++++++++++++++++++++++++++++++++++++++