summaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/api-protocol/swagger
diff options
context:
space:
mode:
Diffstat (limited to 'docs/clamp/acm/api-protocol/swagger')
-rw-r--r--docs/clamp/acm/api-protocol/swagger/acm-comissioning.json114
-rw-r--r--docs/clamp/acm/api-protocol/swagger/acm-instantiation.json931
-rw-r--r--docs/clamp/acm/api-protocol/swagger/acm-monitoring.json8
-rw-r--r--docs/clamp/acm/api-protocol/swagger/k8sparticipant.json392
-rw-r--r--docs/clamp/acm/api-protocol/swagger/participant-sim.json478
5 files changed, 937 insertions, 986 deletions
diff --git a/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json b/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json
index ab77bd9e..3ab03bc0 100644
--- a/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json
+++ b/docs/clamp/acm/api-protocol/swagger/acm-comissioning.json
@@ -12,7 +12,7 @@
}
},
"paths": {
- "/onap/automationcomposition/v2/commission": {
+ "/onap/policy/clamp/acm/v2/commission": {
"get": {
"tags": [
"Clamp Automation Composition Commissioning API"
@@ -353,7 +353,7 @@
}
}
},
- "/onap/automationcomposition/v2/commission/elements": {
+ "/onap/policy/clamp/acm/v2/commission/elements": {
"get": {
"tags": [
"Clamp Automation Composition Commissioning API"
@@ -469,7 +469,7 @@
}
}
},
- "/onap/automationcomposition/v2/commission/getCommonOrInstanceProperties": {
+ "/onap/policy/clamp/acm/v2/commission/getCommonOrInstanceProperties": {
"get": {
"tags": [
"Clamp Automation Composition Commissioning API"
@@ -593,113 +593,7 @@
}
}
},
- "/onap/automationcomposition/v2/commission/toscaServiceTemplateSchema": {
- "get": {
- "tags": [
- "Clamp Automation Composition Commissioning API"
- ],
- "summary": "Query details of the requested tosca service template json schema",
- "description": "Queries details of the requested commissioned tosca service template json schema, returning all tosca service template json schema details",
- "operationId": "queryToscaServiceTemplateJsonSchemaUsingGET",
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "section",
- "in": "query",
- "description": "Section of Template schema is desired for",
- "required": false,
- "type": "string",
- "default": "all"
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "string"
- }
- },
- "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/automationcomposition/v2/commission/toscaservicetemplate": {
+ "/onap/policy/clamp/acm/v2/commission/toscaservicetemplate": {
"get": {
"tags": [
"Clamp Automation Composition Commissioning API"
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
diff --git a/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json b/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json
index 2c177fa9..2c23abec 100644
--- a/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json
+++ b/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json
@@ -12,7 +12,7 @@
}
},
"paths": {
- "/onap/automationcomposition/v2/monitoring/acelement": {
+ "/onap/policy/clamp/acm/v2/monitoring/acelement": {
"get": {
"tags": [
"Clamp Automation Composition Monitoring API"
@@ -155,7 +155,7 @@
}
}
},
- "/onap/automationcomposition/v2/monitoring/acelements/automationcomposition": {
+ "/onap/policy/clamp/acm/v2/monitoring/acelements/automationcomposition": {
"get": {
"tags": [
"Clamp Automation Composition Monitoring API"
@@ -268,7 +268,7 @@
}
}
},
- "/onap/automationcomposition/v2/monitoring/participant": {
+ "/onap/policy/clamp/acm/v2/monitoring/participant": {
"get": {
"tags": [
"Clamp Automation Composition Monitoring API"
@@ -404,7 +404,7 @@
}
}
},
- "/onap/automationcomposition/v2/monitoring/participants/automationcomposition": {
+ "/onap/policy/clamp/acm/v2/monitoring/participants/automationcomposition": {
"get": {
"tags": [
"Clamp Automation Composition Monitoring API"
diff --git a/docs/clamp/acm/api-protocol/swagger/k8sparticipant.json b/docs/clamp/acm/api-protocol/swagger/k8sparticipant.json
deleted file mode 100644
index ae06b06d..00000000
--- a/docs/clamp/acm/api-protocol/swagger/k8sparticipant.json
+++ /dev/null
@@ -1,392 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "description": "Api Documentation",
- "version": "1.0",
- "title": "Api Documentation",
- "termsOfService": "urn:tos",
- "contact": {},
- "license": {
- "name": "Apache 2.0",
- "url": "http://www.apache.org/licenses/LICENSE-2.0"
- }
- },
- "paths": {
- "/onap/k8sparticipant/helm/chart/{name}/{version}": {
- "delete": {
- "tags": [
- "k8s-participant"
- ],
- "summary": "Delete the chart",
- "operationId": "deleteChartUsingDELETE",
- "produces": [
- "*/*"
- ],
- "parameters": [
- {
- "name": "name",
- "in": "path",
- "description": "name",
- "required": true,
- "type": "string"
- },
- {
- "name": "version",
- "in": "path",
- "description": "version",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "object"
- }
- },
- "204": {
- "description": "Chart Deleted"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/charts": {
- "get": {
- "tags": [
- "k8s-participant"
- ],
- "summary": "Return all Charts",
- "operationId": "getAllChartsUsingGET",
- "produces": [
- "application/json"
- ],
- "responses": {
- "200": {
- "description": "chart List",
- "schema": {
- "$ref": "#/definitions/ChartList",
- "originalRef": "ChartList"
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/install": {
- "post": {
- "tags": [
- "k8s-participant"
- ],
- "summary": "Install the chart",
- "operationId": "installChartUsingPOST",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "info",
- "description": "info",
- "required": true,
- "schema": {
- "$ref": "#/definitions/InstallationInfo",
- "originalRef": "InstallationInfo"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "object"
- }
- },
- "201": {
- "description": "chart Installed",
- "schema": {
- "type": "object"
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/onboard/chart": {
- "post": {
- "tags": [
- "k8s-participant"
- ],
- "summary": "Onboard the Chart",
- "operationId": "onboardChartUsingPOST",
- "consumes": [
- "multipart/form-data"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "name": "chart",
- "in": "formData",
- "required": false,
- "type": "file"
- },
- {
- "name": "info",
- "in": "formData",
- "required": false,
- "type": "string"
- },
- {
- "in": "body",
- "name": "values",
- "description": "values",
- "required": false,
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "string"
- }
- },
- "201": {
- "description": "Chart Onboarded",
- "schema": {
- "type": "string"
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/repo": {
- "post": {
- "tags": [
- "k8s-participant"
- ],
- "summary": "Configure helm repository",
- "operationId": "configureRepoUsingPOST",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "repo",
- "description": "repo",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "object"
- }
- },
- "201": {
- "description": "Repository added",
- "schema": {
- "type": "object"
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/uninstall/{name}/{version}": {
- "delete": {
- "tags": [
- "k8s-participant"
- ],
- "summary": "Uninstall the Chart",
- "operationId": "uninstallChartUsingDELETE",
- "produces": [
- "application/json"
- ],
- "parameters": [
- {
- "name": "name",
- "in": "path",
- "description": "name",
- "required": true,
- "type": "string"
- },
- {
- "name": "version",
- "in": "path",
- "description": "version",
- "required": true,
- "type": "string"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "object"
- }
- },
- "201": {
- "description": "chart Uninstalled",
- "schema": {
- "type": "object"
- }
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- }
- }
- }
- },
- "definitions": {
- "ChartInfo": {
- "type": "object",
- "properties": {
- "chartId": {
- "$ref": "#/definitions/ToscaConceptIdentifier",
- "originalRef": "ToscaConceptIdentifier"
- },
- "namespace": {
- "type": "string"
- },
- "overrideParams": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "releaseName": {
- "type": "string"
- },
- "repository": {
- "$ref": "#/definitions/HelmRepository",
- "originalRef": "HelmRepository"
- }
- },
- "title": "ChartInfo"
- },
- "ChartList": {
- "type": "object",
- "properties": {
- "charts": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ChartInfo",
- "originalRef": "ChartInfo"
- }
- }
- },
- "title": "ChartList"
- },
- "HelmRepository": {
- "type": "object",
- "properties": {
- "address": {
- "type": "string"
- },
- "password": {
- "type": "string"
- },
- "port": {
- "type": "string"
- },
- "protocol": {
- "type": "string"
- },
- "repoName": {
- "type": "string"
- },
- "userName": {
- "type": "string"
- }
- },
- "title": "HelmRepository"
- },
- "InstallationInfo": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "title": "InstallationInfo"
- },
- "ToscaConceptIdentifier": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "title": "ToscaConceptIdentifier"
- }
- }
-} \ No newline at end of file
diff --git a/docs/clamp/acm/api-protocol/swagger/participant-sim.json b/docs/clamp/acm/api-protocol/swagger/participant-sim.json
deleted file mode 100644
index 2111b607..00000000
--- a/docs/clamp/acm/api-protocol/swagger/participant-sim.json
+++ /dev/null
@@ -1,478 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "description": "Api Documentation",
- "version": "1.0",
- "title": "Api Documentation",
- "termsOfService": "urn:tos",
- "contact": {},
- "license": {
- "name": "Apache 2.0",
- "url": "http://www.apache.org/licenses/LICENSE-2.0"
- }
- },
- "paths": {
- "/onap/participantsim/v2/elements": {
- "put": {
- "tags": [
- "Clamp Automation Composition Participant Simulator API"
- ],
- "summary": "Updates simulated automation composition elements",
- "description": "Updates simulated automation composition elements, returning the updated automation composition definition IDs",
- "operationId": "updateUsingPUT",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "body",
- "description": "Body of a automation composition element",
- "required": true,
- "schema": {
- "$ref": "#/definitions/AutomationCompositionElementReq",
- "originalRef": "AutomationCompositionElementReq"
- }
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/TypedSimpleResponse«AutomationCompositionElement»",
- "originalRef": "TypedSimpleResponse«AutomationCompositionElement»"
- }
- },
- "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": "Dublin"
- }
- }
- },
- "/onap/participantsim/v2/elements/{name}/{version}": {
- "get": {
- "tags": [
- "Clamp Automation Composition Participant Simulator API"
- ],
- "summary": "Query details of the requested simulated automation composition elements",
- "description": "Queries details of the requested simulated automation composition elements, returning all automation composition element details",
- "operationId": "elementsUsingGET",
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "name",
- "in": "path",
- "description": "Automation composition element name",
- "required": true,
- "type": "string"
- },
- {
- "name": "version",
- "in": "path",
- "description": "Automation composition element 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": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/AutomationCompositionElementRes",
- "originalRef": "AutomationCompositionElementRes"
- }
- }
- },
- "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": "Dublin"
- }
- }
- },
- "/onap/participantsim/v2/participants": {
- "put": {
- "tags": [
- "Clamp Automation Composition Participant Simulator API"
- ],
- "summary": "Updates simulated participants",
- "description": "Updates simulated participants, returning the updated automation composition definition IDs",
- "operationId": "updateUsingPUT_1",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "body",
- "description": "Body of a participant",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ParticipantReq",
- "originalRef": "ParticipantReq"
- }
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/TypedSimpleResponse«Participant»",
- "originalRef": "TypedSimpleResponse«Participant»"
- }
- },
- "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": "Dublin"
- }
- }
- },
- "/onap/participantsim/v2/participants/{name}/{version}": {
- "get": {
- "tags": [
- "Clamp Automation Composition Participant Simulator API"
- ],
- "summary": "Query details of the requested simulated participants",
- "description": "Queries details of the requested simulated participants, returning all participant details",
- "operationId": "participantsUsingGET",
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "name",
- "in": "path",
- "description": "Participant name",
- "required": true,
- "type": "string"
- },
- {
- "name": "version",
- "in": "path",
- "description": "Participant 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": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ParticipantRes",
- "originalRef": "ParticipantRes"
- }
- }
- },
- "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": "Dublin"
- }
- }
- }
- }
-} \ No newline at end of file