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         "responses": {
  45           "200": {
  46             "description": "successful operation",
  47             "headers": {
  48               "X-MinorVersion": {
  49                 "type": "string",
  50                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
  51               },
  52               "X-PatchVersion": {
  53                 "type": "string",
  54                 "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"
  55               },
  56               "X-LatestVersion": {
  57                 "type": "string",
  58                 "description": "Used only to communicate an API's latest version"
  59               },
  60               "X-ONAP-RequestID": {
  61                 "type": "string",
  62                 "format": "uuid",
  63                 "description": "Used to track REST transactions for logging purpose"
  64               }
  65             },
  66             "schema": {
  67               "type": "object",
  68               "additionalProperties": {
  69                 "type": "object"
  70               }
  71             }
  72           },
  73           "401": {
  74             "description": "Authentication Error"
  75           },
  76           "403": {
  77             "description": "Authorization Error"
  78           },
  79           "500": {
  80             "description": "Internal Server Error"
  81           }
  82         },
  83         "security": [
  84           {
  85             "basicAuth": []
  86           }
  87         ],
  88         "x-interface info": {
  89           "api-version": "1.0.0",
  90           "last-mod-release": "Dublin"
  91         }
  92       }
  93     },
  94     "/policy/pap/v1/pdps/statistics/{group}": {
  95       "get": {
  96         "tags": [
  97           "PDP Statistics"
  98         ],
  99         "summary": "Fetch current statistics for given PDP Group",
 100         "description": "Returns statistics for given PDP Group of the Policy Administration component",
 101         "operationId": "pdpGroupStatistics",
 102         "produces": [
 103           "application/json",
 104           "application/yaml"
 105         ],
 106         "parameters": [
 107           {
 108             "name": "X-ONAP-RequestID",
 109             "in": "header",
 110             "description": "RequestID for http transaction",
 111             "required": false,
 112             "type": "string",
 113             "format": "uuid"
 114           },
 115           {
 116             "name": "group",
 117             "in": "path",
 118             "description": "PDP Group Name",
 119             "required": true,
 120             "type": "string"
 121           }
 122         ],
 123         "responses": {
 124           "200": {
 125             "description": "successful operation",
 126             "headers": {
 127               "X-MinorVersion": {
 128                 "type": "string",
 129                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 130               },
 131               "X-PatchVersion": {
 132                 "type": "string",
 133                 "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"
 134               },
 135               "X-LatestVersion": {
 136                 "type": "string",
 137                 "description": "Used only to communicate an API's latest version"
 138               },
 139               "X-ONAP-RequestID": {
 140                 "type": "string",
 141                 "format": "uuid",
 142                 "description": "Used to track REST transactions for logging purpose"
 143               }
 144             },
 145             "schema": {
 146               "type": "object",
 147               "additionalProperties": {
 148                 "type": "object"
 149               }
 150             }
 151           },
 152           "401": {
 153             "description": "Authentication Error"
 154           },
 155           "403": {
 156             "description": "Authorization Error"
 157           },
 158           "500": {
 159             "description": "Internal Server Error"
 160           }
 161         },
 162         "security": [
 163           {
 164             "basicAuth": []
 165           }
 166         ],
 167         "x-interface info": {
 168           "api-version": "1.0.0",
 169           "last-mod-release": "Dublin"
 170         }
 171       }
 172     },
 173     "/policy/pap/v1/pdps/statistics/{group}/{type}": {
 174       "get": {
 175         "tags": [
 176           "PDP Statistics"
 177         ],
 178         "summary": "Fetch statistics for the specified subgroup",
 179         "description": "Returns  statistics for the specified subgroup of the Policy Administration component",
 180         "operationId": "pdpSubGroupStatistics",
 181         "produces": [
 182           "application/json",
 183           "application/yaml"
 184         ],
 185         "parameters": [
 186           {
 187             "name": "X-ONAP-RequestID",
 188             "in": "header",
 189             "description": "RequestID for http transaction",
 190             "required": false,
 191             "type": "string",
 192             "format": "uuid"
 193           },
 194           {
 195             "name": "group",
 196             "in": "path",
 197             "description": "PDP Group Name",
 198             "required": true,
 199             "type": "string"
 200           },
 201           {
 202             "name": "type",
 203             "in": "path",
 204             "description": "PDP SubGroup type",
 205             "required": true,
 206             "type": "string"
 207           }
 208         ],
 209         "responses": {
 210           "200": {
 211             "description": "successful operation",
 212             "headers": {
 213               "X-MinorVersion": {
 214                 "type": "string",
 215                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 216               },
 217               "X-PatchVersion": {
 218                 "type": "string",
 219                 "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"
 220               },
 221               "X-LatestVersion": {
 222                 "type": "string",
 223                 "description": "Used only to communicate an API's latest version"
 224               },
 225               "X-ONAP-RequestID": {
 226                 "type": "string",
 227                 "format": "uuid",
 228                 "description": "Used to track REST transactions for logging purpose"
 229               }
 230             },
 231             "schema": {
 232               "type": "object",
 233               "additionalProperties": {
 234                 "type": "object"
 235               }
 236             }
 237           },
 238           "401": {
 239             "description": "Authentication Error"
 240           },
 241           "403": {
 242             "description": "Authorization Error"
 243           },
 244           "500": {
 245             "description": "Internal Server Error"
 246           }
 247         },
 248         "security": [
 249           {
 250             "basicAuth": []
 251           }
 252         ],
 253         "x-interface info": {
 254           "api-version": "1.0.0",
 255           "last-mod-release": "Dublin"
 256         }
 257       }
 258     },
 259     "/policy/pap/v1/pdps/statistics/{group}/{type}/{pdp}": {
 260       "get": {
 261         "tags": [
 262           "PDP Statistics"
 263         ],
 264         "summary": "Fetch statistics for the specified pdp",
 265         "description": "Returns  statistics for the specified pdp of the Policy Administration component",
 266         "operationId": "pdpInstanceStatistics",
 267         "produces": [
 268           "application/json",
 269           "application/yaml"
 270         ],
 271         "parameters": [
 272           {
 273             "name": "X-ONAP-RequestID",
 274             "in": "header",
 275             "description": "RequestID for http transaction",
 276             "required": false,
 277             "type": "string",
 278             "format": "uuid"
 279           },
 280           {
 281             "name": "group",
 282             "in": "path",
 283             "description": "PDP Group Name",
 284             "required": true,
 285             "type": "string"
 286           },
 287           {
 288             "name": "type",
 289             "in": "path",
 290             "description": "PDP SubGroup type",
 291             "required": true,
 292             "type": "string"
 293           },
 294           {
 295             "name": "pdp",
 296             "in": "path",
 297             "description": "PDP Instance name",
 298             "required": true,
 299             "type": "string"
 300           },
 301           {
 302             "name": "recordCount",
 303             "in": "query",
 304             "description": "Record Count",
 305             "required": false,
 306             "type": "integer",
 307             "default": 0,
 308             "format": "int32"
 309           }
 310         ],
 311         "responses": {
 312           "200": {
 313             "description": "successful operation",
 314             "headers": {
 315               "X-MinorVersion": {
 316                 "type": "string",
 317                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 318               },
 319               "X-PatchVersion": {
 320                 "type": "string",
 321                 "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"
 322               },
 323               "X-LatestVersion": {
 324                 "type": "string",
 325                 "description": "Used only to communicate an API's latest version"
 326               },
 327               "X-ONAP-RequestID": {
 328                 "type": "string",
 329                 "format": "uuid",
 330                 "description": "Used to track REST transactions for logging purpose"
 331               }
 332             },
 333             "schema": {
 334               "type": "object",
 335               "additionalProperties": {
 336                 "type": "object"
 337               }
 338             }
 339           },
 340           "401": {
 341             "description": "Authentication Error"
 342           },
 343           "403": {
 344             "description": "Authorization Error"
 345           },
 346           "500": {
 347             "description": "Internal Server Error"
 348           }
 349         },
 350         "security": [
 351           {
 352             "basicAuth": []
 353           }
 354         ],
 355         "x-interface info": {
 356           "api-version": "1.0.0",
 357           "last-mod-release": "Dublin"
 358         }
 359       }
 360     }
 361   },
 362   "securityDefinitions": {
 363     "basicAuth": {
 364       "description": "",
 365       "type": "basic"
 366     }
 367   }
 368 }