blob: d5ca9a08b46337de6ca3537b30797192d071b661 [file] [log] [blame]
{
"swagger" : "2.0",
"basePath" : "/",
"tags" : [ {
"name" : "PdpGroup State Change"
} ],
"schemes" : [ "http", "https" ],
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"paths" : {
"/policy/pap/v1/pdps/groups/{name}" : {
"put" : {
"tags" : [ "PdpGroup State Change" ],
"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"
}
}
}
}
}