From 19d451d0b657d7d33a126434f036d6489e1d3b89 Mon Sep 17 00:00:00 2001 From: rameshiyer27 Date: Wed, 5 Oct 2022 15:56:48 +0100 Subject: Update ACM documentation for Kohn release Removed participant simulator and k8s ppnt standalone endpoints. Updated REST endpoints of ACM Issue-ID: POLICY-4382 Signed-off-by: zrrmmua Change-Id: Ib31253952a32b33b2e193293b0b1775fcb35054b --- .../api-protocol/swagger/acm-instantiation.json | 931 ++++++++++++++++++++- 1 file changed, 929 insertions(+), 2 deletions(-) (limited to 'docs/clamp/acm/api-protocol/swagger/acm-instantiation.json') diff --git a/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json b/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json index cdad2b61..092b6ea6 100644 --- a/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json +++ b/docs/clamp/acm/api-protocol/swagger/acm-instantiation.json @@ -12,7 +12,7 @@ } }, "paths": { - "/onap/automationcomposition/v2/instantiation": { + "/onap/policy/clamp/acm/v2/instantiation": { "get": { "tags": [ "Clamp Automation Composition Instantiation API" @@ -464,7 +464,7 @@ } } }, - "/onap/automationcomposition/v2/instantiation/command": { + "/onap/policy/clamp/acm/v2/instantiation/command": { "put": { "tags": [ "Clamp Automation Composition Instantiation API" @@ -579,6 +579,933 @@ "last-mod-release": "Istanbul" } } + }, + "/onap/policy/clamp/acm/v2/instantiationState":{ + "get":{ + "tags":[ + "Clamp Automation Composition Instantiation API" + ], + "summary":"Query details of the requested automation compositions", + "description":"Queries details of requested automation compositions, returning all automation composition details", + "operationId":"getInstantiationOrderStateUsingGET", + "produces":[ + "application/json", + "application/yaml" + ], + "parameters":[ + { + "name":"name", + "in":"query", + "description":"Automation composition name", + "required":false, + "type":"string" + }, + { + "name":"version", + "in":"query", + "description":"Automation composition version", + "required":false, + "type":"string" + }, + { + "name":"X-ONAP-RequestID", + "in":"header", + "description":"RequestID for http transaction", + "required":false, + "type":"string", + "format":"uuid" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/AutomationCompositionOrderStateResponse", + "originalRef":"AutomationCompositionOrderStateResponse" + } + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "404":{ + "description":"Not Found" + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "responsesObject":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/AutomationCompositionOrderStateResponse", + "originalRef":"AutomationCompositionOrderStateResponse" + } + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "404":{ + "description":"Not Found" + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "security":[ + { + "basicAuth":[ + + ] + } + ], + "x-interface info":{ + "api-version":"1.0.0", + "last-mod-release":"Istanbul" + } + } + }, + "/onap/policy/clamp/acm/v2/instanceProperties":{ + "post":{ + "tags":[ + "Clamp Automation Composition Instantiation API" + ], + "summary":"Saves instance properties", + "description":"Saves instance properties, returning the saved instances properties and it's version", + "operationId":"createInstancePropertiesUsingPOST", + "consumes":[ + "application/json", + "application/yaml" + ], + "produces":[ + "application/json", + "application/yaml" + ], + "parameters":[ + { + "in":"body", + "name":"body", + "description":"Body of instance properties", + "required":true, + "schema":{ + "$ref":"#/definitions/ToscaServiceTemplateReq", + "originalRef":"ToscaServiceTemplateReq" + } + }, + { + "name":"X-ONAP-RequestID", + "in":"header", + "description":"RequestID for http transaction", + "required":false, + "type":"string", + "format":"uuid" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/InstancePropertiesResponse", + "originalRef":"InstancePropertiesResponse" + } + }, + "201":{ + "description":"Created" + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "404":{ + "description":"Not Found" + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "responsesObject":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/InstancePropertiesResponse", + "originalRef":"InstancePropertiesResponse" + } + }, + "201":{ + "description":"Created" + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "404":{ + "description":"Not Found" + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "security":[ + { + "basicAuth":[ + + ] + } + ], + "x-interface info":{ + "api-version":"1.0.0", + "last-mod-release":"Istanbul" + } + }, + "put":{ + "tags":[ + "Clamp Automation Composition Instantiation API" + ], + "summary":"Updates instance properties", + "description":"Updates instance properties, returning the saved instances properties and it's version", + "operationId":"updatesInstancePropertiesUsingPUT", + "consumes":[ + "application/json", + "application/yaml" + ], + "produces":[ + "application/json", + "application/yaml" + ], + "parameters":[ + { + "in":"body", + "name":"body", + "description":"Body of instance properties", + "required":true, + "schema":{ + "$ref":"#/definitions/ToscaServiceTemplateReq", + "originalRef":"ToscaServiceTemplateReq" + } + }, + { + "name":"name", + "in":"query", + "description":"Automation composition definition name", + "required":true, + "type":"string" + }, + { + "name":"version", + "in":"query", + "description":"Automation composition definition version", + "required":true, + "type":"string" + }, + { + "name":"X-ONAP-RequestID", + "in":"header", + "description":"RequestID for http transaction", + "required":false, + "type":"string", + "format":"uuid" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/InstancePropertiesResponse", + "originalRef":"InstancePropertiesResponse" + } + }, + "201":{ + "description":"Created" + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "404":{ + "description":"Not Found" + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "responsesObject":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/InstancePropertiesResponse", + "originalRef":"InstancePropertiesResponse" + } + }, + "201":{ + "description":"Created" + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "404":{ + "description":"Not Found" + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "security":[ + { + "basicAuth":[ + + ] + } + ], + "x-interface info":{ + "api-version":"1.0.0", + "last-mod-release":"Istanbul" + } + }, + "delete":{ + "tags":[ + "Clamp Automation Composition Instantiation API" + ], + "summary":"Delete a automation composition and instance properties", + "description":"Deletes a automation composition and instance properties, returning optional error details", + "operationId":"deleteInstancePropertiesUsingDELETE", + "produces":[ + "application/json", + "application/yaml" + ], + "parameters":[ + { + "name":"name", + "in":"query", + "description":"Automation composition definition name", + "required":true, + "type":"string" + }, + { + "name":"version", + "in":"query", + "description":"Automation composition definition version", + "required":true, + "type":"string" + }, + { + "name":"X-ONAP-RequestID", + "in":"header", + "description":"RequestID for http transaction", + "required":false, + "type":"string", + "format":"uuid" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/InstantiationResponse", + "originalRef":"InstantiationResponse" + } + }, + "204":{ + "description":"No Content" + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "responsesObject":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/InstantiationResponse", + "originalRef":"InstantiationResponse" + } + }, + "204":{ + "description":"No Content" + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "security":[ + { + "basicAuth":[ + + ] + } + ], + "x-interface info":{ + "api-version":"1.0.0", + "last-mod-release":"Istanbul" + } + } + }, + "/onap/policy/clamp/acm/v2/automationCompositionPriming":{ + "get":{ + "tags":[ + "Clamp Automation Composition Instantiation API" + ], + "summary":"Query priming details of the requested automation compositions", + "description":"Queries priming details of requested automation compositions, returning primed/deprimed compositions", + "operationId":"getAutomationCompositionPrimingUsingGET", + "produces":[ + "application/json", + "application/yaml" + ], + "parameters":[ + { + "name":"name", + "in":"query", + "description":"Automation composition definition name", + "required":false, + "type":"string" + }, + { + "name":"version", + "in":"query", + "description":"Automation composition definition version", + "required":false, + "type":"string" + }, + { + "name":"X-ONAP-RequestID", + "in":"header", + "description":"RequestID for http transaction", + "required":false, + "type":"string", + "format":"uuid" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/AutomationCompositionPrimedResponse", + "originalRef":"AutomationCompositionPrimedResponse" + } + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "404":{ + "description":"Not Found" + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "responsesObject":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/AutomationCompositionPrimedResponse", + "originalRef":"AutomationCompositionPrimedResponse" + } + }, + "401":{ + "description":"Authentication Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "403":{ + "description":"Authorization Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + }, + "404":{ + "description":"Not Found" + }, + "500":{ + "description":"Internal Server Error", + "headers":{ + "X-LatestVersion":{ + "type":"string" + }, + "X-PatchVersion":{ + "type":"string" + }, + "X-MinorVersion":{ + "type":"string" + }, + "X-ONAP-RequestID":{ + "type":"string", + "format":"uuid" + } + } + } + }, + "security":[ + { + "basicAuth":[ + + ] + } + ], + "x-interface info":{ + "api-version":"1.0.0", + "last-mod-release":"Istanbul" + } + } } } } \ No newline at end of file -- cgit 1.2.3-korg