docs/pap/swagger/state-change-pap.json

   1 {
   2   "swagger" : "2.0",
   3   "basePath" : "/",
   4   "tags" : [ {
   5     "name" : "PdpGroup State Change"
   6   } ],
   7   "schemes" : [ "http", "https" ],
   8   "consumes" : [ "application/json" ],
   9   "produces" : [ "application/json" ],
  10   "paths" : {
  11     "/policy/pap/v1/pdps/groups/{name}" : {
  12       "put" : {
  13         "tags" : [ "PdpGroup State Change" ],
  14         "summary" : "Change state of a PDP Group",
  15         "description" : "Changes state of PDP Group, returning optional error details",
  16         "operationId" : "changeGroupState",
  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           "name" : "name",
  27           "in" : "path",
  28           "description" : "PDP Group Name",
  29           "required" : true,
  30           "type" : "string"
  31         }, {
  32           "name" : "state",
  33           "in" : "query",
  34           "description" : "PDP Group State",
  35           "required" : true,
  36           "type" : "string",
  37           "enum" : [ "PASSIVE", "SAFE", "TEST", "ACTIVE", "TERMINATED" ]
  38         } ],
  39         "responses" : {
  40           "200" : {
  41             "description" : "successful operation",
  42             "headers" : {
  43               "X-MinorVersion" : {
  44                 "type" : "string",
  45                 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
  46               },
  47               "X-PatchVersion" : {
  48                 "type" : "string",
  49                 "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"
  50               },
  51               "X-LatestVersion" : {
  52                 "type" : "string",
  53                 "description" : "Used only to communicate an API's latest version"
  54               },
  55               "X-ONAP-RequestID" : {
  56                 "type" : "string",
  57                 "format" : "uuid",
  58                 "description" : "Used to track REST transactions for logging purpose"
  59               }
  60             },
  61             "schema" : {
  62               "$ref" : "#/definitions/PdpGroupStateChangeResponse"
  63             }
  64           },
  65           "401" : {
  66             "description" : "Authentication Error"
  67           },
  68           "403" : {
  69             "description" : "Authorization Error"
  70           },
  71           "500" : {
  72             "description" : "Internal Server Error"
  73           }
  74         },
  75         "security" : [ {
  76           "basicAuth" : [ ]
  77         } ],
  78         "x-interface info" : {
  79           "api-version" : "1.0.0",
  80           "last-mod-release" : "Dublin"
  81         }
  82       }
  83     }
  84   },
  85   "securityDefinitions" : {
  86     "basicAuth" : {
  87       "description" : "",
  88       "type" : "basic"
  89     }
  90   },
  91   "definitions" : {
  92     "PdpGroupStateChangeResponse" : {
  93       "type" : "object",
  94       "properties" : {
  95         "errorDetails" : {
  96           "type" : "string"
  97         }
  98       }
  99     }
 100   }
 101 }