docs/clamp/acm/api-protocol/swagger/acm-monitoring.json

   1 {
   2   "swagger": "2.0",
   3   "info": {
   4     "description": "Api Documentation",
   5     "version": "1.0",
   6     "title": "Api Documentation",
   7     "termsOfService": "urn:tos",
   8     "contact": {},
   9     "license": {
  10       "name": "Apache 2.0",
  11       "url": "http://www.apache.org/licenses/LICENSE-2.0"
  12     }
  13   },
  14   "paths": {
  15     "/onap/policy/clamp/acm/v2/monitoring/acelement": {
  16       "get": {
  17         "tags": [
  18           "Clamp Automation Composition Monitoring API"
  19         ],
  20         "summary": "Query details of the requested acElement stats",
  21         "description": "Queries details of the requested acElement stats, returning all acElement stats",
  22         "operationId": "queryElementStatisticsUsingGET",
  23         "produces": [
  24           "application/json",
  25           "application/yaml"
  26         ],
  27         "parameters": [
  28           {
  29             "name": "endTime",
  30             "in": "query",
  31             "description": "end time",
  32             "required": false,
  33             "type": "string"
  34           },
  35           {
  36             "name": "id",
  37             "in": "query",
  38             "description": "Automation composition  element id",
  39             "required": false,
  40             "type": "string"
  41           },
  42           {
  43             "name": "name",
  44             "in": "query",
  45             "description": "Participant name",
  46             "required": true,
  47             "type": "string"
  48           },
  49           {
  50             "name": "recordCount",
  51             "in": "query",
  52             "description": "Record count",
  53             "required": false,
  54             "type": "integer",
  55             "default": 0,
  56             "format": "int32"
  57           },
  58           {
  59             "name": "startTime",
  60             "in": "query",
  61             "description": "start time",
  62             "required": false,
  63             "type": "string"
  64           },
  65           {
  66             "name": "version",
  67             "in": "query",
  68             "description": "Participant version",
  69             "required": true,
  70             "type": "string"
  71           },
  72           {
  73             "name": "X-ONAP-RequestID",
  74             "in": "header",
  75             "description": "RequestID for http transaction",
  76             "required": false,
  77             "type": "string",
  78             "format": "uuid"
  79           }
  80         ],
  81         "responses": {
  82           "200": {
  83             "description": "OK",
  84             "schema": {
  85               "$ref": "#/definitions/AcElementStatisticsList",
  86               "originalRef": "AcElementStatisticsList"
  87             }
  88           },
  89           "401": {
  90             "description": "Authentication Error",
  91             "headers": {
  92               "X-LatestVersion": {
  93                 "type": "string"
  94               },
  95               "X-PatchVersion": {
  96                 "type": "string"
  97               },
  98               "X-MinorVersion": {
  99                 "type": "string"
 100               },
 101               "X-ONAP-RequestID": {
 102                 "type": "string",
 103                 "format": "uuid"
 104               }
 105             }
 106           },
 107           "403": {
 108             "description": "Authorization Error",
 109             "headers": {
 110               "X-LatestVersion": {
 111                 "type": "string"
 112               },
 113               "X-PatchVersion": {
 114                 "type": "string"
 115               },
 116               "X-MinorVersion": {
 117                 "type": "string"
 118               },
 119               "X-ONAP-RequestID": {
 120                 "type": "string",
 121                 "format": "uuid"
 122               }
 123             }
 124           },
 125           "404": {
 126             "description": "Not Found"
 127           },
 128           "500": {
 129             "description": "Internal Server Error",
 130             "headers": {
 131               "X-LatestVersion": {
 132                 "type": "string"
 133               },
 134               "X-PatchVersion": {
 135                 "type": "string"
 136               },
 137               "X-MinorVersion": {
 138                 "type": "string"
 139               },
 140               "X-ONAP-RequestID": {
 141                 "type": "string",
 142                 "format": "uuid"
 143               }
 144             }
 145           }
 146         },
 147         "security": [
 148           {
 149             "basicAuth": []
 150           }
 151         ],
 152         "x-interface info": {
 153           "api-version": "1.0.0",
 154           "last-mod-release": "Istanbul"
 155         }
 156       }
 157     },
 158     "/onap/policy/clamp/acm/v2/monitoring/acelements/automationcomposition": {
 159       "get": {
 160         "tags": [
 161           "Clamp Automation Composition Monitoring API"
 162         ],
 163         "summary": "Query details of the requested acElement stats in a automation composition",
 164         "description": "Queries details of the requested acElement stats, returning all acElement stats",
 165         "operationId": "queryElementStatisticsPerAutomationCompositionUsingGET",
 166         "produces": [
 167           "application/json",
 168           "application/yaml"
 169         ],
 170         "parameters": [
 171           {
 172             "name": "name",
 173             "in": "query",
 174             "description": "Automation composition  name",
 175             "required": true,
 176             "type": "string"
 177           },
 178           {
 179             "name": "version",
 180             "in": "query",
 181             "description": "Automation composition  version",
 182             "required": true,
 183             "type": "string"
 184           },
 185           {
 186             "name": "X-ONAP-RequestID",
 187             "in": "header",
 188             "description": "RequestID for http transaction",
 189             "required": false,
 190             "type": "string",
 191             "format": "uuid"
 192           }
 193         ],
 194         "responses": {
 195           "200": {
 196             "description": "OK",
 197             "schema": {
 198               "$ref": "#/definitions/AcElementStatisticsList",
 199               "originalRef": "AcElementStatisticsList"
 200             }
 201           },
 202           "401": {
 203             "description": "Authentication Error",
 204             "headers": {
 205               "X-LatestVersion": {
 206                 "type": "string"
 207               },
 208               "X-PatchVersion": {
 209                 "type": "string"
 210               },
 211               "X-MinorVersion": {
 212                 "type": "string"
 213               },
 214               "X-ONAP-RequestID": {
 215                 "type": "string",
 216                 "format": "uuid"
 217               }
 218             }
 219           },
 220           "403": {
 221             "description": "Authorization Error",
 222             "headers": {
 223               "X-LatestVersion": {
 224                 "type": "string"
 225               },
 226               "X-PatchVersion": {
 227                 "type": "string"
 228               },
 229               "X-MinorVersion": {
 230                 "type": "string"
 231               },
 232               "X-ONAP-RequestID": {
 233                 "type": "string",
 234                 "format": "uuid"
 235               }
 236             }
 237           },
 238           "404": {
 239             "description": "Not Found"
 240           },
 241           "500": {
 242             "description": "Internal Server Error",
 243             "headers": {
 244               "X-LatestVersion": {
 245                 "type": "string"
 246               },
 247               "X-PatchVersion": {
 248                 "type": "string"
 249               },
 250               "X-MinorVersion": {
 251                 "type": "string"
 252               },
 253               "X-ONAP-RequestID": {
 254                 "type": "string",
 255                 "format": "uuid"
 256               }
 257             }
 258           }
 259         },
 260         "security": [
 261           {
 262             "basicAuth": []
 263           }
 264         ],
 265         "x-interface info": {
 266           "api-version": "1.0.0",
 267           "last-mod-release": "Istanbul"
 268         }
 269       }
 270     },
 271     "/onap/policy/clamp/acm/v2/monitoring/participant": {
 272       "get": {
 273         "tags": [
 274           "Clamp Automation Composition Monitoring API"
 275         ],
 276         "summary": "Query details of the requested participant stats",
 277         "description": "Queries details of the requested participant stats, returning all participant stats",
 278         "operationId": "queryParticipantStatisticsUsingGET",
 279         "produces": [
 280           "application/json",
 281           "application/yaml"
 282         ],
 283         "parameters": [
 284           {
 285             "name": "endTime",
 286             "in": "query",
 287             "description": "end time",
 288             "required": false,
 289             "type": "string"
 290           },
 291           {
 292             "name": "name",
 293             "in": "query",
 294             "description": "Automation composition  participant name",
 295             "required": false,
 296             "type": "string"
 297           },
 298           {
 299             "name": "recordCount",
 300             "in": "query",
 301             "description": "Record count",
 302             "required": false,
 303             "type": "integer",
 304             "default": 0,
 305             "format": "int32"
 306           },
 307           {
 308             "name": "startTime",
 309             "in": "query",
 310             "description": "start time",
 311             "required": false,
 312             "type": "string"
 313           },
 314           {
 315             "name": "version",
 316             "in": "query",
 317             "description": "Automation composition  participant version",
 318             "required": false,
 319             "type": "string"
 320           },
 321           {
 322             "name": "X-ONAP-RequestID",
 323             "in": "header",
 324             "description": "RequestID for http transaction",
 325             "required": false,
 326             "type": "string",
 327             "format": "uuid"
 328           }
 329         ],
 330         "responses": {
 331           "200": {
 332             "description": "OK",
 333             "schema": {
 334               "$ref": "#/definitions/ParticipantStatisticsList",
 335               "originalRef": "ParticipantStatisticsList"
 336             }
 337           },
 338           "401": {
 339             "description": "Authentication Error",
 340             "headers": {
 341               "X-LatestVersion": {
 342                 "type": "string"
 343               },
 344               "X-PatchVersion": {
 345                 "type": "string"
 346               },
 347               "X-MinorVersion": {
 348                 "type": "string"
 349               },
 350               "X-ONAP-RequestID": {
 351                 "type": "string",
 352                 "format": "uuid"
 353               }
 354             }
 355           },
 356           "403": {
 357             "description": "Authorization Error",
 358             "headers": {
 359               "X-LatestVersion": {
 360                 "type": "string"
 361               },
 362               "X-PatchVersion": {
 363                 "type": "string"
 364               },
 365               "X-MinorVersion": {
 366                 "type": "string"
 367               },
 368               "X-ONAP-RequestID": {
 369                 "type": "string",
 370                 "format": "uuid"
 371               }
 372             }
 373           },
 374           "404": {
 375             "description": "Not Found"
 376           },
 377           "500": {
 378             "description": "Internal Server Error",
 379             "headers": {
 380               "X-LatestVersion": {
 381                 "type": "string"
 382               },
 383               "X-PatchVersion": {
 384                 "type": "string"
 385               },
 386               "X-MinorVersion": {
 387                 "type": "string"
 388               },
 389               "X-ONAP-RequestID": {
 390                 "type": "string",
 391                 "format": "uuid"
 392               }
 393             }
 394           }
 395         },
 396         "security": [
 397           {
 398             "basicAuth": []
 399           }
 400         ],
 401         "x-interface info": {
 402           "api-version": "1.0.0",
 403           "last-mod-release": "Istanbul"
 404         }
 405       }
 406     },
 407     "/onap/policy/clamp/acm/v2/monitoring/participants/automationcomposition": {
 408       "get": {
 409         "tags": [
 410           "Clamp Automation Composition Monitoring API"
 411         ],
 412         "summary": "Query details of all the participant stats in a automation composition",
 413         "description": "Queries details of the participant stats, returning all participant stats",
 414         "operationId": "queryParticipantStatisticsPerAutomationCompositionUsingGET",
 415         "produces": [
 416           "application/json",
 417           "application/yaml"
 418         ],
 419         "parameters": [
 420           {
 421             "name": "name",
 422             "in": "query",
 423             "description": "Automation composition  name",
 424             "required": true,
 425             "type": "string"
 426           },
 427           {
 428             "name": "version",
 429             "in": "query",
 430             "description": "Automation composition  version",
 431             "required": true,
 432             "type": "string"
 433           },
 434           {
 435             "name": "X-ONAP-RequestID",
 436             "in": "header",
 437             "description": "RequestID for http transaction",
 438             "required": false,
 439             "type": "string",
 440             "format": "uuid"
 441           }
 442         ],
 443         "responses": {
 444           "200": {
 445             "description": "OK",
 446             "schema": {
 447               "$ref": "#/definitions/ParticipantStatisticsList",
 448               "originalRef": "ParticipantStatisticsList"
 449             }
 450           },
 451           "401": {
 452             "description": "Authentication Error",
 453             "headers": {
 454               "X-LatestVersion": {
 455                 "type": "string"
 456               },
 457               "X-PatchVersion": {
 458                 "type": "string"
 459               },
 460               "X-MinorVersion": {
 461                 "type": "string"
 462               },
 463               "X-ONAP-RequestID": {
 464                 "type": "string",
 465                 "format": "uuid"
 466               }
 467             }
 468           },
 469           "403": {
 470             "description": "Authorization Error",
 471             "headers": {
 472               "X-LatestVersion": {
 473                 "type": "string"
 474               },
 475               "X-PatchVersion": {
 476                 "type": "string"
 477               },
 478               "X-MinorVersion": {
 479                 "type": "string"
 480               },
 481               "X-ONAP-RequestID": {
 482                 "type": "string",
 483                 "format": "uuid"
 484               }
 485             }
 486           },
 487           "404": {
 488             "description": "Not Found"
 489           },
 490           "500": {
 491             "description": "Internal Server Error",
 492             "headers": {
 493               "X-LatestVersion": {
 494                 "type": "string"
 495               },
 496               "X-PatchVersion": {
 497                 "type": "string"
 498               },
 499               "X-MinorVersion": {
 500                 "type": "string"
 501               },
 502               "X-ONAP-RequestID": {
 503                 "type": "string",
 504                 "format": "uuid"
 505               }
 506             }
 507           }
 508         },
 509         "security": [
 510           {
 511             "basicAuth": []
 512           }
 513         ],
 514         "x-interface info": {
 515           "api-version": "1.0.0",
 516           "last-mod-release": "Istanbul"
 517         }
 518       }
 519     }
 520   }
 521 }