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

   1 {
   2   "swagger" : "2.0",
   3   "basePath" : "/",
   4   "tags" : [ {
   5     "name" : "PdpPolicyUndeploy"
   6   } ],
   7   "schemes" : [ "http", "https" ],
   8   "consumes" : [ "application/json" ],
   9   "produces" : [ "application/json" ],
  10   "paths" : {
  11     "/policy/pap/v1/pdps/policies/{name}" : {
  12       "delete" : {
  13         "tags" : [ "PdpPolicyUndeploy" ],
  14         "summary" : "Undeploy a PDP Policy from PDPs",
  15         "description" : "Undeploys the latest version of a policy from the PDPs, returning optional error details",
  16         "operationId" : "deletePolicy",
  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 Policy Name",
  29           "required" : true,
  30           "type" : "string"
  31         } ],
  32         "responses" : {
  33           "200" : {
  34             "description" : "successful operation",
  35             "headers" : {
  36               "X-MinorVersion" : {
  37                 "type" : "string",
  38                 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
  39               },
  40               "X-PatchVersion" : {
  41                 "type" : "string",
  42                 "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"
  43               },
  44               "X-LatestVersion" : {
  45                 "type" : "string",
  46                 "description" : "Used only to communicate an API's latest version"
  47               },
  48               "X-ONAP-RequestID" : {
  49                 "type" : "string",
  50                 "format" : "uuid",
  51                 "description" : "Used to track REST transactions for logging purpose"
  52               }
  53             },
  54             "schema" : {
  55               "$ref" : "#/definitions/PdpGroupDeleteResponse"
  56             }
  57           },
  58           "401" : {
  59             "description" : "Authentication Error"
  60           },
  61           "403" : {
  62             "description" : "Authorization Error"
  63           },
  64           "500" : {
  65             "description" : "Internal Server Error"
  66           }
  67         },
  68         "security" : [ {
  69           "basicAuth" : [ ]
  70         } ],
  71         "x-interface info" : {
  72           "api-version" : "1.0.0",
  73           "last-mod-release" : "Dublin"
  74         }
  75       }
  76     },
  77     "/policy/pap/v1/pdps/policies/{name}/versions/{version}" : {
  78       "delete" : {
  79         "tags" : [ "PdpPolicyUndeploy" ],
  80         "summary" : "Undeploy version of a PDP Policy from PDPs",
  81         "description" : "Undeploys a specific version of a policy from the PDPs, returning optional error details",
  82         "operationId" : "deletePolicyVersion",
  83         "produces" : [ "application/json" ],
  84         "parameters" : [ {
  85           "name" : "X-ONAP-RequestID",
  86           "in" : "header",
  87           "description" : "RequestID for http transaction",
  88           "required" : false,
  89           "type" : "string",
  90           "format" : "uuid"
  91         }, {
  92           "name" : "name",
  93           "in" : "path",
  94           "description" : "PDP Policy Name",
  95           "required" : true,
  96           "type" : "string"
  97         }, {
  98           "name" : "version",
  99           "in" : "path",
 100           "description" : "PDP Policy Version",
 101           "required" : true,
 102           "type" : "string"
 103         } ],
 104         "responses" : {
 105           "200" : {
 106             "description" : "successful operation",
 107             "headers" : {
 108               "X-MinorVersion" : {
 109                 "type" : "string",
 110                 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
 111               },
 112               "X-PatchVersion" : {
 113                 "type" : "string",
 114                 "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"
 115               },
 116               "X-LatestVersion" : {
 117                 "type" : "string",
 118                 "description" : "Used only to communicate an API's latest version"
 119               },
 120               "X-ONAP-RequestID" : {
 121                 "type" : "string",
 122                 "format" : "uuid",
 123                 "description" : "Used to track REST transactions for logging purpose"
 124               }
 125             },
 126             "schema" : {
 127               "$ref" : "#/definitions/PdpGroupDeleteResponse"
 128             }
 129           },
 130           "401" : {
 131             "description" : "Authentication Error"
 132           },
 133           "403" : {
 134             "description" : "Authorization Error"
 135           },
 136           "500" : {
 137             "description" : "Internal Server Error"
 138           }
 139         },
 140         "security" : [ {
 141           "basicAuth" : [ ]
 142         } ],
 143         "x-interface info" : {
 144           "api-version" : "1.0.0",
 145           "last-mod-release" : "Dublin"
 146         }
 147       }
 148     }
 149   },
 150   "securityDefinitions" : {
 151     "basicAuth" : {
 152       "description" : "",
 153       "type" : "basic"
 154     }
 155   },
 156   "definitions" : {
 157     "PdpGroupDeleteResponse" : {
 158       "type" : "object",
 159       "properties" : {
 160         "errorDetails" : {
 161           "type" : "string"
 162         }
 163       }
 164     }
 165   }
 166 }