aboutsummaryrefslogtreecommitdiffstats
path: root/docs/pap/swagger/state-change-pap.json
diff options
context:
space:
mode:
authorJim Hahn <jrh3@att.com>2019-05-29 15:41:48 -0400
committerJim Hahn <jrh3@att.com>2019-05-30 09:08:43 -0400
commitd5cc948b2c25b5e444705ba133b3d619474e1bc6 (patch)
tree57c245c0873fb84f684cb9022ce1ab4071e745a1 /docs/pap/swagger/state-change-pap.json
parentd8d3191510be75033894d41439dc92ba250eeda5 (diff)
Add documentation for PAP
Included updates per Ram. Change-Id: Ib09c9b7e39aab566ebd3eae813fde6bc3e2fabd7 Issue-ID: POLICY-1681 Signed-off-by: Jim Hahn <jrh3@att.com>
Diffstat (limited to 'docs/pap/swagger/state-change-pap.json')
-rw-r--r--docs/pap/swagger/state-change-pap.json101
1 files changed, 101 insertions, 0 deletions
diff --git a/docs/pap/swagger/state-change-pap.json b/docs/pap/swagger/state-change-pap.json
new file mode 100644
index 00000000..16ef6360
--- /dev/null
+++ b/docs/pap/swagger/state-change-pap.json
@@ -0,0 +1,101 @@
+{
+ "swagger" : "2.0",
+ "basePath" : "/",
+ "tags" : [ {
+ "name" : "PdpGroupStateChange"
+ } ],
+ "schemes" : [ "http", "https" ],
+ "consumes" : [ "application/json" ],
+ "produces" : [ "application/json" ],
+ "paths" : {
+ "/policy/pap/v1/pdps/groups/{name}" : {
+ "put" : {
+ "tags" : [ "PdpGroupStateChange" ],
+ "summary" : "Change state of a PDP Group",
+ "description" : "Changes state of PDP Group, returning optional error details",
+ "operationId" : "changeGroupState",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "X-ONAP-RequestID",
+ "in" : "header",
+ "description" : "RequestID for http transaction",
+ "required" : false,
+ "type" : "string",
+ "format" : "uuid"
+ }, {
+ "name" : "name",
+ "in" : "path",
+ "description" : "PDP Group Name",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "name" : "state",
+ "in" : "query",
+ "description" : "PDP Group State",
+ "required" : true,
+ "type" : "string",
+ "enum" : [ "PASSIVE", "SAFE", "TEST", "ACTIVE", "TERMINATED" ]
+ } ],
+ "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/PdpGroupStateChangeResponse"
+ }
+ },
+ "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" : {
+ "PdpGroupStateChangeResponse" : {
+ "type" : "object",
+ "properties" : {
+ "errorDetails" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+}