aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json
diff options
context:
space:
mode:
Diffstat (limited to 'docs/clamp/acm/api-protocol/swagger/acm-monitoring.json')
-rw-r--r--docs/clamp/acm/api-protocol/swagger/acm-monitoring.json521
1 files changed, 521 insertions, 0 deletions
diff --git a/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json b/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json
new file mode 100644
index 00000000..2c177fa9
--- /dev/null
+++ b/docs/clamp/acm/api-protocol/swagger/acm-monitoring.json
@@ -0,0 +1,521 @@
+{
+ "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/automationcomposition/v2/monitoring/acelement": {
+ "get": {
+ "tags": [
+ "Clamp Automation Composition Monitoring API"
+ ],
+ "summary": "Query details of the requested acElement stats",
+ "description": "Queries details of the requested acElement stats, returning all acElement stats",
+ "operationId": "queryElementStatisticsUsingGET",
+ "produces": [
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters": [
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "end time",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "query",
+ "description": "Automation composition element id",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "query",
+ "description": "Participant name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "recordCount",
+ "in": "query",
+ "description": "Record count",
+ "required": false,
+ "type": "integer",
+ "default": 0,
+ "format": "int32"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "start time",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "query",
+ "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": {
+ "$ref": "#/definitions/AcElementStatisticsList",
+ "originalRef": "AcElementStatisticsList"
+ }
+ },
+ "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/monitoring/acelements/automationcomposition": {
+ "get": {
+ "tags": [
+ "Clamp Automation Composition Monitoring API"
+ ],
+ "summary": "Query details of the requested acElement stats in a automation composition",
+ "description": "Queries details of the requested acElement stats, returning all acElement stats",
+ "operationId": "queryElementStatisticsPerAutomationCompositionUsingGET",
+ "produces": [
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters": [
+ {
+ "name": "name",
+ "in": "query",
+ "description": "Automation composition name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "query",
+ "description": "Automation composition 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/AcElementStatisticsList",
+ "originalRef": "AcElementStatisticsList"
+ }
+ },
+ "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/monitoring/participant": {
+ "get": {
+ "tags": [
+ "Clamp Automation Composition Monitoring API"
+ ],
+ "summary": "Query details of the requested participant stats",
+ "description": "Queries details of the requested participant stats, returning all participant stats",
+ "operationId": "queryParticipantStatisticsUsingGET",
+ "produces": [
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters": [
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "end time",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "query",
+ "description": "Automation composition participant name",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "recordCount",
+ "in": "query",
+ "description": "Record count",
+ "required": false,
+ "type": "integer",
+ "default": 0,
+ "format": "int32"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "start time",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "query",
+ "description": "Automation composition participant 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/ParticipantStatisticsList",
+ "originalRef": "ParticipantStatisticsList"
+ }
+ },
+ "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/monitoring/participants/automationcomposition": {
+ "get": {
+ "tags": [
+ "Clamp Automation Composition Monitoring API"
+ ],
+ "summary": "Query details of all the participant stats in a automation composition",
+ "description": "Queries details of the participant stats, returning all participant stats",
+ "operationId": "queryParticipantStatisticsPerAutomationCompositionUsingGET",
+ "produces": [
+ "application/json",
+ "application/yaml"
+ ],
+ "parameters": [
+ {
+ "name": "name",
+ "in": "query",
+ "description": "Automation composition name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "query",
+ "description": "Automation composition 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/ParticipantStatisticsList",
+ "originalRef": "ParticipantStatisticsList"
+ }
+ },
+ "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