summaryrefslogtreecommitdiffstats
path: root/docs/api/swagger/statistics-api.json
blob: a55f03c844009ffc32781f433b7838c80140ce7b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
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"
        }
      }
    }
  }
}