docs/pap/swagger/pdp-statistics-pap.json

   1 {
   2   "swagger": "2.0",
   3   "basePath": "/",
   4   "tags": [
   5     {
   6       "name": "PDP Statistics"
   7     }
   8   ],
   9   "schemes": [
  10     "http",
  11     "https"
  12   ],
  13   "consumes": [
  14     "application/json",
  15     "application/yaml"
  16   ],
  17   "produces": [
  18     "application/json",
  19     "application/yaml"
  20   ],
  21   "paths": {
  22     "/policy/pap/v1/pdps/statistics": {
  23       "get": {
  24         "tags": [
  25           "PDP Statistics"
  26         ],
  27         "summary": "Fetch  statistics for all PDP Groups and subgroups in the system",
  28         "description": "Returns for all PDP Groups and subgroups statistics of the Policy Administration component",
  29         "operationId": "pdpStatistics",
  30         "produces": [
  31           "application/json",
  32           "application/yaml"
  33         ],
  34         "parameters": [
  35           {
  36             "name": "X-ONAP-RequestID",
  37             "in": "header",
  38             "description": "RequestID for http transaction",
  39             "required": false,
  40             "type": "string",
  41             "format": "uuid"
  42           },
  43           {
  44             "name": "recordCount",
  45             "in": "query",
  46             "description": "Record count between 1-100",
  47             "required": false,
  48             "type": "integer",
  49             "format": "int32"
  50           },
  51           {
  52             "name": "startTime",
  53             "in": "query",
  54             "description": "Start time in epoch timestamp",
  55             "required": false,
  56             "type": "integer",
  57             "format": "int64"
  58           },
  59           {
  60             "name": "endTime",
  61             "in": "query",
  62             "description": "End time in epoch timestamp",
  63             "required": false,
  64             "type": "integer",
  65             "format": "int64"
  66           }
  67         ],
  68         "responses": {
  69           "200": {
  70             "description": "successful operation",
  71             "headers": {
  72               "X-MinorVersion": {
  73                 "type": "string",
  74                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
  75               },
  76               "X-PatchVersion": {
  77                 "type": "string",
  78                 "description": "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
  79               },
  80               "X-LatestVersion": {
  81                 "type": "string",
  82                 "description": "Used only to communicate an API's latest version"
  83               },
  84               "X-ONAP-RequestID": {
  85                 "type": "string",
  86                 "format": "uuid",
  87                 "description": "Used to track REST transactions for logging purpose"
  88               }
  89             },
  90             "schema": {
  91               "type": "object",
  92               "additionalProperties": {
  93                 "type": "object"
  94               }
  95             }
  96           },
  97           "401": {
  98             "description": "Authentication Error"
  99           },
 100           "403": {
 101             "description": "Authorization Error"
 102           },
 103           "500": {
 104             "description": "Internal Server Error"
 105           }
 106         },
 107         "security": [
 108           {
 109             "basicAuth": []
 110           }
 111         ],
 112         "x-interface info": {
 113           "api-version": "1.0.0",
 114           "last-mod-release": "Dublin"
 115         }
 116       }
 117     },
 118     "/policy/pap/v1/pdps/statistics/{group}": {
 119       "get": {
 120         "tags": [
 121           "PDP Statistics"
 122         ],
 123         "summary": "Fetch current statistics for given PDP Group",
 124         "description": "Returns statistics for given PDP Group of the Policy Administration component",
 125         "operationId": "pdpGroupStatistics",
 126         "produces": [
 127           "application/json",
 128           "application/yaml"
 129         ],
 130         "parameters": [
 131           {
 132             "name": "X-ONAP-RequestID",
 133             "in": "header",
 134             "description": "RequestID for http transaction",
 135             "required": false,
 136             "type": "string",
 137             "format": "uuid"
 138           },
 139           {
 140             "name": "group",
 141             "in": "path",
 142             "description": "PDP Group Name",
 143             "required": true,
 144             "type": "string"
 145           },
 146           {
 147             "name": "recordCount",
 148             "in": "query",
 149             "description": "Record count between 1-100",
 150             "required": false,
 151             "type": "integer",
 152             "format": "int32"
 153           },
 154           {
 155             "name": "startTime",
 156             "in": "query",
 157             "description": "Start time in epoch timestamp",
 158             "required": false,
 159             "type": "integer",
 160             "format": "int64"
 161           },
 162           {
 163             "name": "endTime",
 164             "in": "query",
 165             "description": "End time in epoch timestamp",
 166             "required": false,
 167             "type": "integer",
 168             "format": "int64"
 169           }
 170         ],
 171         "responses": {
 172           "200": {
 173             "description": "successful operation",
 174             "headers": {
 175               "X-MinorVersion": {
 176                 "type": "string",
 177                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 178               },
 179               "X-PatchVersion": {
 180                 "type": "string",
 181                 "description": "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
 182               },
 183               "X-LatestVersion": {
 184                 "type": "string",
 185                 "description": "Used only to communicate an API's latest version"
 186               },
 187               "X-ONAP-RequestID": {
 188                 "type": "string",
 189                 "format": "uuid",
 190                 "description": "Used to track REST transactions for logging purpose"
 191               }
 192             },
 193             "schema": {
 194               "type": "object",
 195               "additionalProperties": {
 196                 "type": "object"
 197               }
 198             }
 199           },
 200           "401": {
 201             "description": "Authentication Error"
 202           },
 203           "403": {
 204             "description": "Authorization Error"
 205           },
 206           "500": {
 207             "description": "Internal Server Error"
 208           }
 209         },
 210         "security": [
 211           {
 212             "basicAuth": []
 213           }
 214         ],
 215         "x-interface info": {
 216           "api-version": "1.0.0",
 217           "last-mod-release": "Dublin"
 218         }
 219       }
 220     },
 221     "/policy/pap/v1/pdps/statistics/{group}/{type}": {
 222       "get": {
 223         "tags": [
 224           "PDP Statistics"
 225         ],
 226         "summary": "Fetch statistics for the specified subgroup",
 227         "description": "Returns  statistics for the specified subgroup of the Policy Administration component",
 228         "operationId": "pdpSubGroupStatistics",
 229         "produces": [
 230           "application/json",
 231           "application/yaml"
 232         ],
 233         "parameters": [
 234           {
 235             "name": "X-ONAP-RequestID",
 236             "in": "header",
 237             "description": "RequestID for http transaction",
 238             "required": false,
 239             "type": "string",
 240             "format": "uuid"
 241           },
 242           {
 243             "name": "group",
 244             "in": "path",
 245             "description": "PDP Group Name",
 246             "required": true,
 247             "type": "string"
 248           },
 249           {
 250             "name": "type",
 251             "in": "path",
 252             "description": "PDP SubGroup type",
 253             "required": true,
 254             "type": "string"
 255           },
 256           {
 257             "name": "recordCount",
 258             "in": "query",
 259             "description": "Record count between 1-100",
 260             "required": false,
 261             "type": "integer",
 262             "format": "int32"
 263           },
 264           {
 265             "name": "startTime",
 266             "in": "query",
 267             "description": "Start time in epoch timestamp",
 268             "required": false,
 269             "type": "integer",
 270             "format": "int64"
 271           },
 272           {
 273             "name": "endTime",
 274             "in": "query",
 275             "description": "End time in epoch timestamp",
 276             "required": false,
 277             "type": "integer",
 278             "format": "int64"
 279           }
 280         ],
 281         "responses": {
 282           "200": {
 283             "description": "successful operation",
 284             "headers": {
 285               "X-MinorVersion": {
 286                 "type": "string",
 287                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 288               },
 289               "X-PatchVersion": {
 290                 "type": "string",
 291                 "description": "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
 292               },
 293               "X-LatestVersion": {
 294                 "type": "string",
 295                 "description": "Used only to communicate an API's latest version"
 296               },
 297               "X-ONAP-RequestID": {
 298                 "type": "string",
 299                 "format": "uuid",
 300                 "description": "Used to track REST transactions for logging purpose"
 301               }
 302             },
 303             "schema": {
 304               "type": "object",
 305               "additionalProperties": {
 306                 "type": "object"
 307               }
 308             }
 309           },
 310           "401": {
 311             "description": "Authentication Error"
 312           },
 313           "403": {
 314             "description": "Authorization Error"
 315           },
 316           "500": {
 317             "description": "Internal Server Error"
 318           }
 319         },
 320         "security": [
 321           {
 322             "basicAuth": []
 323           }
 324         ],
 325         "x-interface info": {
 326           "api-version": "1.0.0",
 327           "last-mod-release": "Dublin"
 328         }
 329       }
 330     },
 331     "/policy/pap/v1/pdps/statistics/{group}/{type}/{pdp}": {
 332       "get": {
 333         "tags": [
 334           "PDP Statistics"
 335         ],
 336         "summary": "Fetch statistics for the specified pdp",
 337         "description": "Returns  statistics for the specified pdp of the Policy Administration component",
 338         "operationId": "pdpInstanceStatistics",
 339         "produces": [
 340           "application/json",
 341           "application/yaml"
 342         ],
 343         "parameters": [
 344           {
 345             "name": "X-ONAP-RequestID",
 346             "in": "header",
 347             "description": "RequestID for http transaction",
 348             "required": false,
 349             "type": "string",
 350             "format": "uuid"
 351           },
 352           {
 353             "name": "group",
 354             "in": "path",
 355             "description": "PDP Group Name",
 356             "required": true,
 357             "type": "string"
 358           },
 359           {
 360             "name": "type",
 361             "in": "path",
 362             "description": "PDP SubGroup type",
 363             "required": true,
 364             "type": "string"
 365           },
 366           {
 367             "name": "pdp",
 368             "in": "path",
 369             "description": "PDP Instance name",
 370             "required": true,
 371             "type": "string"
 372           },
 373           {
 374             "name": "recordCount",
 375             "in": "query",
 376             "description": "Record count between 1-100",
 377             "required": false,
 378             "type": "integer",
 379             "format": "int32"
 380           },
 381           {
 382             "name": "startTime",
 383             "in": "query",
 384             "description": "Start time in epoch timestamp",
 385             "required": false,
 386             "type": "integer",
 387             "format": "int64"
 388           },
 389           {
 390             "name": "endTime",
 391             "in": "query",
 392             "description": "End time in epoch timestamp",
 393             "required": false,
 394             "type": "integer",
 395             "format": "int64"
 396           }
 397         ],
 398         "responses": {
 399           "200": {
 400             "description": "successful operation",
 401             "headers": {
 402               "X-MinorVersion": {
 403                 "type": "string",
 404                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 405               },
 406               "X-PatchVersion": {
 407                 "type": "string",
 408                 "description": "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
 409               },
 410               "X-LatestVersion": {
 411                 "type": "string",
 412                 "description": "Used only to communicate an API's latest version"
 413               },
 414               "X-ONAP-RequestID": {
 415                 "type": "string",
 416                 "format": "uuid",
 417                 "description": "Used to track REST transactions for logging purpose"
 418               }
 419             },
 420             "schema": {
 421               "type": "object",
 422               "additionalProperties": {
 423                 "type": "object"
 424               }
 425             }
 426           },
 427           "401": {
 428             "description": "Authentication Error"
 429           },
 430           "403": {
 431             "description": "Authorization Error"
 432           },
 433           "500": {
 434             "description": "Internal Server Error"
 435           }
 436         },
 437         "security": [
 438           {
 439             "basicAuth": []
 440           }
 441         ],
 442         "x-interface info": {
 443           "api-version": "1.0.0",
 444           "last-mod-release": "Dublin"
 445         }
 446       }
 447     }
 448   },
 449   "securityDefinitions": {
 450     "basicAuth": {
 451       "description": "",
 452       "type": "basic"
 453     }
 454   }
 455 }