diff options
author | 2019-05-29 15:41:48 -0400 | |
---|---|---|
committer | 2019-05-30 09:08:43 -0400 | |
commit | d5cc948b2c25b5e444705ba133b3d619474e1bc6 (patch) | |
tree | 57c245c0873fb84f684cb9022ce1ab4071e745a1 /docs/pap/swagger/statistics-pap.json | |
parent | d8d3191510be75033894d41439dc92ba250eeda5 (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/statistics-pap.json')
-rw-r--r-- | docs/pap/swagger/statistics-pap.json | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/docs/pap/swagger/statistics-pap.json b/docs/pap/swagger/statistics-pap.json new file mode 100644 index 00000000..390fe1a0 --- /dev/null +++ b/docs/pap/swagger/statistics-pap.json @@ -0,0 +1,91 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "Statistics" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "paths" : { + "/policy/pap/v1/statistics" : { + "get" : { + "tags" : [ "Statistics" ], + "summary" : "Fetch current statistics", + "description" : "Returns current statistics of the Policy Administration component", + "operationId" : "statistics", + "produces" : [ "application/json" ], + "parameters" : [ ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatisticsReport" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ] + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "StatisticsReport" : { + "type" : "object", + "properties" : { + "code" : { + "type" : "integer", + "format" : "int32" + }, + "totalPdpCount" : { + "type" : "integer", + "format" : "int64" + }, + "totalPdpGroupCount" : { + "type" : "integer", + "format" : "int64" + }, + "totalPolicyDeployCount" : { + "type" : "integer", + "format" : "int64" + }, + "policyDeploySuccessCount" : { + "type" : "integer", + "format" : "int64" + }, + "policyDeployFailureCount" : { + "type" : "integer", + "format" : "int64" + }, + "totalPolicyDownloadCount" : { + "type" : "integer", + "format" : "int64" + }, + "policyDownloadSuccessCount" : { + "type" : "integer", + "format" : "int64" + }, + "policyDownloadFailureCount" : { + "type" : "integer", + "format" : "int64" + } + } + } + } +} |