docs/pap/swagger/deployments-batch-pap.json

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