390fe1a0bf051c51cc952e82ae3e568e35770aa8
[policy/parent.git] / docs / pap / swagger / statistics-pap.json
1 {
2   "swagger" : "2.0",
3   "basePath" : "/",
4   "tags" : [ {
5     "name" : "Statistics"
6   } ],
7   "schemes" : [ "http", "https" ],
8   "consumes" : [ "application/json" ],
9   "produces" : [ "application/json" ],
10   "paths" : {
11     "/policy/pap/v1/statistics" : {
12       "get" : {
13         "tags" : [ "Statistics" ],
14         "summary" : "Fetch current statistics",
15         "description" : "Returns current statistics of the Policy Administration component",
16         "operationId" : "statistics",
17         "produces" : [ "application/json" ],
18         "parameters" : [ ],
19         "responses" : {
20           "200" : {
21             "description" : "successful operation",
22             "schema" : {
23               "$ref" : "#/definitions/StatisticsReport"
24             }
25           },
26           "401" : {
27             "description" : "Authentication Error"
28           },
29           "403" : {
30             "description" : "Authorization Error"
31           },
32           "500" : {
33             "description" : "Internal Server Error"
34           }
35         },
36         "security" : [ {
37           "basicAuth" : [ ]
38         } ]
39       }
40     }
41   },
42   "securityDefinitions" : {
43     "basicAuth" : {
44       "description" : "",
45       "type" : "basic"
46     }
47   },
48   "definitions" : {
49     "StatisticsReport" : {
50       "type" : "object",
51       "properties" : {
52         "code" : {
53           "type" : "integer",
54           "format" : "int32"
55         },
56         "totalPdpCount" : {
57           "type" : "integer",
58           "format" : "int64"
59         },
60         "totalPdpGroupCount" : {
61           "type" : "integer",
62           "format" : "int64"
63         },
64         "totalPolicyDeployCount" : {
65           "type" : "integer",
66           "format" : "int64"
67         },
68         "policyDeploySuccessCount" : {
69           "type" : "integer",
70           "format" : "int64"
71         },
72         "policyDeployFailureCount" : {
73           "type" : "integer",
74           "format" : "int64"
75         },
76         "totalPolicyDownloadCount" : {
77           "type" : "integer",
78           "format" : "int64"
79         },
80         "policyDownloadSuccessCount" : {
81           "type" : "integer",
82           "format" : "int64"
83         },
84         "policyDownloadFailureCount" : {
85           "type" : "integer",
86           "format" : "int64"
87         }
88       }
89     }
90   }
91 }