docs/pap/swagger/group-query-pap.json

   1 {
   2   "swagger" : "2.0",
   3   "basePath" : "/",
   4   "tags" : [ {
   5     "name" : "PdpGroup Query"
   6   } ],
   7   "schemes" : [ "http", "https" ],
   8   "consumes" : [ "application/json" ],
   9   "produces" : [ "application/json" ],
  10   "paths" : {
  11     "/policy/pap/v1/pdps" : {
  12       "get" : {
  13         "tags" : [ "PdpGroup Query" ],
  14         "summary" : "Query details of all PDP groups",
  15         "description" : "Queries details of all PDP groups, returning all group details",
  16         "operationId" : "queryGroupDetails",
  17         "produces" : [ "application/json" ],
  18         "parameters" : [ {
  19           "name" : "X-ONAP-RequestID",
  20           "in" : "header",
  21           "description" : "RequestID for http transaction",
  22           "required" : false,
  23           "type" : "string",
  24           "format" : "uuid"
  25         } ],
  26         "responses" : {
  27           "200" : {
  28             "description" : "successful operation",
  29             "headers" : {
  30               "X-MinorVersion" : {
  31                 "type" : "string",
  32                 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
  33               },
  34               "X-PatchVersion" : {
  35                 "type" : "string",
  36                 "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"
  37               },
  38               "X-LatestVersion" : {
  39                 "type" : "string",
  40                 "description" : "Used only to communicate an API's latest version"
  41               },
  42               "X-ONAP-RequestID" : {
  43                 "type" : "string",
  44                 "format" : "uuid",
  45                 "description" : "Used to track REST transactions for logging purpose"
  46               }
  47             },
  48             "schema" : {
  49               "$ref" : "#/definitions/PdpGroups"
  50             }
  51           },
  52           "401" : {
  53             "description" : "Authentication Error"
  54           },
  55           "403" : {
  56             "description" : "Authorization Error"
  57           },
  58           "500" : {
  59             "description" : "Internal Server Error"
  60           }
  61         },
  62         "security" : [ {
  63           "basicAuth" : [ ]
  64         } ],
  65         "x-interface info" : {
  66           "api-version" : "1.0.0",
  67           "last-mod-release" : "Dublin"
  68         }
  69       }
  70     }
  71   },
  72   "securityDefinitions" : {
  73     "basicAuth" : {
  74       "description" : "",
  75       "type" : "basic"
  76     }
  77   },
  78   "definitions" : {
  79     "Pdp" : {
  80       "type" : "object",
  81       "properties" : {
  82         "instanceId" : {
  83           "type" : "string"
  84         },
  85         "pdpState" : {
  86           "type" : "string",
  87           "enum" : [ "PASSIVE", "SAFE", "TEST", "ACTIVE", "TERMINATED" ]
  88         },
  89         "healthy" : {
  90           "type" : "string",
  91           "enum" : [ "HEALTHY", "NOT_HEALTHY", "TEST_IN_PROGRESS", "UNKNOWN" ]
  92         },
  93         "message" : {
  94           "type" : "string"
  95         }
  96       }
  97     },
  98     "PdpGroup" : {
  99       "type" : "object",
 100       "properties" : {
 101         "name" : {
 102           "type" : "string"
 103         },
 104         "description" : {
 105           "type" : "string"
 106         },
 107         "pdpGroupState" : {
 108           "type" : "string",
 109           "enum" : [ "PASSIVE", "SAFE", "TEST", "ACTIVE", "TERMINATED" ]
 110         },
 111         "properties" : {
 112           "type" : "object",
 113           "additionalProperties" : {
 114             "type" : "string"
 115           }
 116         },
 117         "pdpSubgroups" : {
 118           "type" : "array",
 119           "items" : {
 120             "$ref" : "#/definitions/PdpSubGroup"
 121           }
 122         }
 123       }
 124     },
 125     "PdpGroups" : {
 126       "type" : "object",
 127       "properties" : {
 128         "groups" : {
 129           "type" : "array",
 130           "items" : {
 131             "$ref" : "#/definitions/PdpGroup"
 132           }
 133         }
 134       }
 135     },
 136     "PdpSubGroup" : {
 137       "type" : "object",
 138       "properties" : {
 139         "pdpType" : {
 140           "type" : "string"
 141         },
 142         "supportedPolicyTypes" : {
 143           "type" : "array",
 144           "items" : {
 145             "$ref" : "#/definitions/ToscaPolicyTypeIdentifier"
 146           }
 147         },
 148         "policies" : {
 149           "type" : "array",
 150           "items" : {
 151             "$ref" : "#/definitions/ToscaPolicyIdentifier"
 152           }
 153         },
 154         "currentInstanceCount" : {
 155           "type" : "integer",
 156           "format" : "int32"
 157         },
 158         "desiredInstanceCount" : {
 159           "type" : "integer",
 160           "format" : "int32"
 161         },
 162         "properties" : {
 163           "type" : "object",
 164           "additionalProperties" : {
 165             "type" : "string"
 166           }
 167         },
 168         "pdpInstances" : {
 169           "type" : "array",
 170           "items" : {
 171             "$ref" : "#/definitions/Pdp"
 172           }
 173         }
 174       }
 175     },
 176     "ToscaPolicyIdentifier" : {
 177       "type" : "object",
 178       "properties" : {
 179         "name" : {
 180           "type" : "string"
 181         },
 182         "version" : {
 183           "type" : "string"
 184         }
 185       }
 186     },
 187     "ToscaPolicyTypeIdentifier" : {
 188       "type" : "object",
 189       "properties" : {
 190         "name" : {
 191           "type" : "string"
 192         },
 193         "version" : {
 194           "type" : "string"
 195         }
 196       }
 197     },
 198     "ToscaPolicyIdentifierOptVersion" : {
 199       "type" : "object",
 200       "properties" : {
 201         "name" : {
 202           "type" : "string"
 203         },
 204         "version" : {
 205           "type" : "string"
 206         }
 207       }
 208     }
 209   }
 210 }