docs/pap/swagger/policy-status-pap.json

   1 {
   2   "swagger": "2.0",
   3   "info": {
   4     "title": "The APIs listed here are used to fetch status of policies in PdpGroups",
   5     "version": "v1"
   6   },
   7   "basePath": "/",
   8   "tags": [
   9     {
  10       "name": "Policy Status"
  11     }
  12   ],
  13   "schemes": [
  14     "http",
  15     "https"
  16   ],
  17   "consumes": [
  18     "application/json",
  19     "application/yaml"
  20   ],
  21   "produces": [
  22     "application/json",
  23     "application/yaml"
  24   ],
  25   "paths": {
  26     "/policy/pap/v1/policies/status": {
  27       "get": {
  28         "tags": [
  29           "Status of policies in all PdpGroups"
  30         ],
  31         "summary": "Queries status of policies in all PdpGroups",
  32         "description": "Queries status of policies in all PdpGroups, returning status of policies in all the PDPs belonging to all PdpGroups",
  33         "operationId": "queryAllPolicies",
  34         "produces": [
  35           "application/json",
  36           "application/yaml"
  37         ],
  38         "parameters": [
  39           {
  40             "name": "X-ONAP-RequestID",
  41             "in": "header",
  42             "description": "RequestID for http transaction",
  43             "required": false,
  44             "type": "string",
  45             "format": "uuid"
  46           }
  47         ],
  48         "responses": {
  49           "200": {
  50             "description": "successful operation",
  51             "headers": {
  52               "X-MinorVersion": {
  53                 "type": "string",
  54                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
  55               },
  56               "X-PatchVersion": {
  57                 "type": "string",
  58                 "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"
  59               },
  60               "X-LatestVersion": {
  61                 "type": "string",
  62                 "description": "Used only to communicate an API's latest version"
  63               },
  64               "X-ONAP-RequestID": {
  65                 "type": "string",
  66                 "format": "uuid",
  67                 "description": "Used to track REST transactions for logging purpose"
  68               }
  69             },
  70             "schema": {
  71               "type": "array",
  72               "items": {
  73                 "$ref": "#/definitions/PdpPolicyStatus"
  74               }
  75             }
  76           },
  77           "401": {
  78             "description": "Authentication Error"
  79           },
  80           "403": {
  81             "description": "Authorization Error"
  82           },
  83           "500": {
  84             "description": "Internal Server Error"
  85           }
  86         },
  87         "security": [
  88           {
  89             "basicAuth": []
  90           }
  91         ],
  92         "x-interface info": {
  93           "api-version": "1.0.0",
  94           "last-mod-release": "Honolulu"
  95         }
  96       }
  97     },
  98     "/policy/pap/v1/policies/status/{pdpGroupName}": {
  99       "get": {
 100         "tags": [
 101           "Status of policies in a PdpGroup"
 102         ],
 103         "summary": "Queries status of policies in a specific PdpGroup",
 104         "description": "Queries status of policies in a specific PdpGroup, returning status of policies in all the PDPs belonging to the PdpGroup",
 105         "operationId": "queryAllPoliciesInPdpGroup",
 106         "produces": [
 107           "application/json",
 108           "application/yaml"
 109         ],
 110         "parameters": [
 111           {
 112             "name": "pdpGroupName",
 113             "in": "path",
 114             "description": "Name of the PdpGroup",
 115             "required": true,
 116             "type": "string"
 117           },
 118           {
 119             "name": "X-ONAP-RequestID",
 120             "in": "header",
 121             "description": "RequestID for http transaction",
 122             "required": false,
 123             "type": "string",
 124             "format": "uuid"
 125           }
 126         ],
 127         "responses": {
 128           "200": {
 129             "description": "successful operation",
 130             "headers": {
 131               "X-MinorVersion": {
 132                 "type": "string",
 133                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 134               },
 135               "X-PatchVersion": {
 136                 "type": "string",
 137                 "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"
 138               },
 139               "X-LatestVersion": {
 140                 "type": "string",
 141                 "description": "Used only to communicate an API's latest version"
 142               },
 143               "X-ONAP-RequestID": {
 144                 "type": "string",
 145                 "format": "uuid",
 146                 "description": "Used to track REST transactions for logging purpose"
 147               }
 148             },
 149             "schema": {
 150               "type": "array",
 151               "items": {
 152                 "$ref": "#/definitions/PdpPolicyStatus"
 153               }
 154             }
 155           },
 156           "401": {
 157             "description": "Authentication Error"
 158           },
 159           "403": {
 160             "description": "Authorization Error"
 161           },
 162           "500": {
 163             "description": "Internal Server Error"
 164           }
 165         },
 166         "security": [
 167           {
 168             "basicAuth": []
 169           }
 170         ],
 171         "x-interface info": {
 172           "api-version": "1.0.0",
 173           "last-mod-release": "Honolulu"
 174         }
 175       }
 176     },
 177     "/policy/pap/v1/policies/status/{pdpGroupName}/{policyName}": {
 178       "get": {
 179         "tags": [
 180           "Status of all versions of a policy in a PdpGroup"
 181         ],
 182         "summary": "Queries status of all versions of a specific policy in a specific PdpGroup",
 183         "description": "Queries status of all versions of a specific policy in a specific PdpGroup, returning status of all versions of the policy in the PDPs belonging to the PdpGroup",
 184         "operationId": "queryAllVersionPolicy",
 185         "produces": [
 186           "application/json",
 187           "application/yaml"
 188         ],
 189         "parameters": [
 190           {
 191             "name": "pdpGroupName",
 192             "in": "path",
 193             "description": "Name of the PdpGroup",
 194             "required": true,
 195             "type": "string"
 196           },
 197           {
 198             "name": "policyName",
 199             "in": "path",
 200             "description": "Name of the Policy",
 201             "required": true,
 202             "type": "string"
 203           },
 204           {
 205             "name": "X-ONAP-RequestID",
 206             "in": "header",
 207             "description": "RequestID for http transaction",
 208             "required": false,
 209             "type": "string",
 210             "format": "uuid"
 211           }
 212         ],
 213         "responses": {
 214           "200": {
 215             "description": "successful operation",
 216             "headers": {
 217               "X-MinorVersion": {
 218                 "type": "string",
 219                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 220               },
 221               "X-PatchVersion": {
 222                 "type": "string",
 223                 "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"
 224               },
 225               "X-LatestVersion": {
 226                 "type": "string",
 227                 "description": "Used only to communicate an API's latest version"
 228               },
 229               "X-ONAP-RequestID": {
 230                 "type": "string",
 231                 "format": "uuid",
 232                 "description": "Used to track REST transactions for logging purpose"
 233               }
 234             },
 235             "schema": {
 236               "type": "array",
 237               "items": {
 238                 "$ref": "#/definitions/PdpPolicyStatus"
 239               }
 240             }
 241           },
 242           "401": {
 243             "description": "Authentication Error"
 244           },
 245           "403": {
 246             "description": "Authorization Error"
 247           },
 248           "500": {
 249             "description": "Internal Server Error"
 250           }
 251         },
 252         "security": [
 253           {
 254             "basicAuth": []
 255           }
 256         ],
 257         "x-interface info": {
 258           "api-version": "1.0.0",
 259           "last-mod-release": "Honolulu"
 260         }
 261       }
 262     },
 263     "/policy/pap/v1/policies/status/{pdpGroupName}/{policyName}/{policyVersion}": {
 264       "get": {
 265         "tags": [
 266           "Status of a version of a policy in a PdpGroup"
 267         ],
 268         "summary": "Queries status of a specific version of a specific policy in a specific PdpGroup",
 269         "description": "Queries status of a specific version of a specific policy in a specific PdpGroup, returning status of the policy in the PDPs belonging to the PdpGroup",
 270         "operationId": "querySpecificVersionPolicy",
 271         "produces": [
 272           "application/json",
 273           "application/yaml"
 274         ],
 275         "parameters": [
 276           {
 277             "name": "pdpGroupName",
 278             "in": "path",
 279             "description": "Name of the PdpGroup",
 280             "required": true,
 281             "type": "string"
 282           },
 283           {
 284             "name": "policyName",
 285             "in": "path",
 286             "description": "Name of the Policy",
 287             "required": true,
 288             "type": "string"
 289           },
 290           {
 291             "name": "policyVersion",
 292             "in": "path",
 293             "description": "Version of the Policy",
 294             "required": true,
 295             "type": "string"
 296           },
 297           {
 298             "name": "X-ONAP-RequestID",
 299             "in": "header",
 300             "description": "RequestID for http transaction",
 301             "required": false,
 302             "type": "string",
 303             "format": "uuid"
 304           }
 305         ],
 306         "responses": {
 307           "200": {
 308             "description": "successful operation",
 309             "headers": {
 310               "X-MinorVersion": {
 311                 "type": "string",
 312                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 313               },
 314               "X-PatchVersion": {
 315                 "type": "string",
 316                 "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"
 317               },
 318               "X-LatestVersion": {
 319                 "type": "string",
 320                 "description": "Used only to communicate an API's latest version"
 321               },
 322               "X-ONAP-RequestID": {
 323                 "type": "string",
 324                 "format": "uuid",
 325                 "description": "Used to track REST transactions for logging purpose"
 326               }
 327             },
 328             "schema": {
 329               "type": "array",
 330               "items": {
 331                 "$ref": "#/definitions/PdpPolicyStatus"
 332               }
 333             }
 334           },
 335           "401": {
 336             "description": "Authentication Error"
 337           },
 338           "403": {
 339             "description": "Authorization Error"
 340           },
 341           "500": {
 342             "description": "Internal Server Error"
 343           }
 344         },
 345         "security": [
 346           {
 347             "basicAuth": []
 348           }
 349         ],
 350         "x-interface info": {
 351           "api-version": "1.0.0",
 352           "last-mod-release": "Honolulu"
 353         }
 354       }
 355     }
 356   },
 357   "securityDefinitions": {
 358     "basicAuth": {
 359       "description": "",
 360       "type": "basic"
 361     }
 362   },
 363   "definitions": {
 364     "PdpPolicyStatus": {
 365       "type": "object",
 366       "properties": {
 367         "pdpGroup": {
 368           "type": "string"
 369         },
 370         "pdpType": {
 371           "type": "string"
 372         },
 373         "pdpId": {
 374           "type": "string"
 375         },
 376         "policy": {
 377           "$ref": "#/definitions/ToscaConceptIdentifier"
 378         },
 379         "policyType": {
 380           "$ref": "#/definitions/ToscaConceptIdentifier"
 381         },
 382         "deploy": {
 383           "type": "boolean"
 384         },
 385         "state": {
 386           "type": "string"
 387         }
 388       }
 389     },
 390     "ToscaConceptIdentifier": {
 391       "type": "object",
 392       "properties": {
 393         "name": {
 394           "type": "string"
 395         },
 396         "version": {
 397           "type": "string"
 398         }
 399       }
 400     }
 401   }
 402 }