diff options
Diffstat (limited to 'docs/pap/swagger')
| -rw-r--r-- | docs/pap/swagger/deployments-batch-pap.json | 150 | ||||
| -rw-r--r-- | docs/pap/swagger/groups-batch-pap.json (renamed from docs/pap/swagger/group-pap.json) | 49 |
2 files changed, 169 insertions, 30 deletions
diff --git a/docs/pap/swagger/deployments-batch-pap.json b/docs/pap/swagger/deployments-batch-pap.json new file mode 100644 index 00000000..58289fb9 --- /dev/null +++ b/docs/pap/swagger/deployments-batch-pap.json @@ -0,0 +1,150 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "DeploymentsUpdate" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json", "application/yaml" ], + "produces" : [ "application/json", "application/yaml" ], + "paths" : { + "/policy/pap/v1/pdps/deployments/batch" : { + "post" : { + "tags" : [ "DeploymentsUpdate" ], + "summary" : "Updates policy deployments within specific PDP groups", + "description" : "Updates policy deployments within specific PDP groups, returning optional error details", + "operationId" : "updateGroupPolicies", + "produces" : [ "application/json", "application/yaml" ], + "parameters" : [ { + "name" : "X-ONAP-RequestID", + "in" : "header", + "description" : "RequestID for http transaction", + "required" : false, + "type" : "string", + "format" : "uuid" + }, { + "in" : "body", + "name" : "body", + "description" : "List of PDP Group Deployments", + "required" : true, + "schema" : { + "$ref" : "#/definitions/DeploymentGroups" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "headers" : { + "X-MinorVersion" : { + "type" : "string", + "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client" + }, + "X-PatchVersion" : { + "type" : "string", + "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" + }, + "X-LatestVersion" : { + "type" : "string", + "description" : "Used only to communicate an API's latest version" + }, + "X-ONAP-RequestID" : { + "type" : "string", + "format" : "uuid", + "description" : "Used to track REST transactions for logging purpose" + } + }, + "schema" : { + "$ref" : "#/definitions/PdpGroupDeployResponse" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ], + "x-interface info" : { + "api-version" : "1.0.0", + "last-mod-release" : "Dublin" + } + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "ToscaPolicyIdentifier" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PdpGroupDeployResponse" : { + "type" : "object", + "properties" : { + "errorDetails" : { + "type" : "string" + } + } + }, + "DeploymentGroup" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "deploymentSubgroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/DeploymentSubGroup" + } + } + } + }, + "DeploymentGroups" : { + "type" : "object", + "properties" : { + "groups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/DeploymentGroup" + } + } + } + }, + "DeploymentSubGroup" : { + "type" : "object", + "properties" : { + "pdpType" : { + "type" : "string" + }, + "action" : { + "type" : "string", + "enum" : [ "POST", "DELETE", "PATCH" ] + }, + "policies" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ToscaPolicyIdentifier" + } + } + } + } + } +}
\ No newline at end of file diff --git a/docs/pap/swagger/group-pap.json b/docs/pap/swagger/groups-batch-pap.json index 1298fffa..8a1899e3 100644 --- a/docs/pap/swagger/group-pap.json +++ b/docs/pap/swagger/groups-batch-pap.json @@ -2,19 +2,19 @@ "swagger" : "2.0", "basePath" : "/", "tags" : [ { - "name" : "PdpGroupDeploy" + "name" : "PdpGroupUpdate" } ], "schemes" : [ "http", "https" ], - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], + "consumes" : [ "application/json", "application/yaml" ], + "produces" : [ "application/json", "application/yaml" ], "paths" : { - "/policy/pap/v1/pdps" : { + "/policy/pap/v1/pdps/groups/batch" : { "post" : { - "tags" : [ "PdpGroupDeploy" ], - "summary" : "Deploy or update PDP Groups", - "description" : "Deploys or updates a PDP Group, returning optional error details", - "operationId" : "deployGroup", - "produces" : [ "application/json" ], + "tags" : [ "PdpGroupUpdate" ], + "summary" : "Create or update PDP Groups", + "description" : "Create or update one or more PDP Groups, returning optional error details", + "operationId" : "createOrUpdateGroups", + "produces" : [ "application/json", "application/yaml" ], "parameters" : [ { "name" : "X-ONAP-RequestID", "in" : "header", @@ -54,7 +54,7 @@ } }, "schema" : { - "$ref" : "#/definitions/PdpGroupDeployResponse" + "$ref" : "#/definitions/PdpGroupUpdateResponse" } }, "401" : { @@ -84,6 +84,14 @@ } }, "definitions" : { + "PdpGroupUpdateResponse" : { + "type" : "object", + "properties" : { + "errorDetails" : { + "type" : "string" + } + } + }, "Pdp" : { "type" : "object", "properties" : { @@ -202,25 +210,6 @@ "type" : "string" } } - }, - "PdpGroupDeployResponse" : { - "type" : "object", - "properties" : { - "errorDetails" : { - "type" : "string" - } - } - }, - "ToscaPolicyIdentifierOptVersion" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "version" : { - "type" : "string" - } - } } } -} +}
\ No newline at end of file |