summaryrefslogtreecommitdiffstats
path: root/docs/api/statistics-api.json
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/statistics-api.json')
-rw-r--r--docs/api/statistics-api.json147
1 files changed, 147 insertions, 0 deletions
diff --git a/docs/api/statistics-api.json b/docs/api/statistics-api.json
new file mode 100644
index 00000000..a55f03c8
--- /dev/null
+++ b/docs/api/statistics-api.json
@@ -0,0 +1,147 @@
+{
+ "swagger" : "2.0",
+ "basePath" : "/",
+ "tags" : [{
+ "name" : "Statistics"
+ }],
+ "schemes" : [ "http", "https" ],
+ "paths" : {
+ "/policy/api/v1/statistics" : {
+ "get" : {
+ "tags" : [ "Statistics" ],
+ "summary" : "Retrieve current statistics",
+ "description" : "Returns current statistics including the counters of API invocation",
+ "operationId" : "getStatistics",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "X-ONAP-RequestID",
+ "in" : "header",
+ "description" : "RequestID for http transaction",
+ "required" : false,
+ "type" : "string",
+ "format" : "uuid"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation; All statistics counters of API invocation will be returned.",
+ "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/StatisticsReport"
+ }
+ },
+ "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" : {
+ "StatisticsReport" : {
+ "type" : "object",
+ "properties" : {
+ "code" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "totalApiCallCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "apiCallSuccessCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "apiCallFailureCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "totalPolicyGetCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "totalPolicyPostCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "totalPolicyTypeGetCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "totalPolicyTypePostCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "policyGetSuccessCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "policyGetFailureCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "policyPostSuccessCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "policyPostFailureCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "policyTypeGetSuccessCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "policyTypeGetFailureCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "policyTypePostSuccessCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "policyTypePostFailureCount" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ }
+ }
+ }
+}