generated from peter-evans/swagger-github-pages
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[BOT] [CREATE-SWAGGER] [SKIP-GH-PAGES] create swagger for "stats" of …
…version v2.1.0
- Loading branch information
1 parent
50eac7f
commit ee6bf8a
Showing
1 changed file
with
223 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,223 @@ | ||
swagger: "2.0" | ||
info: | ||
title: stats.proto | ||
version: version not set | ||
tags: | ||
- name: StatsService | ||
- name: Health | ||
consumes: | ||
- application/json | ||
produces: | ||
- application/json | ||
paths: | ||
/api/v1/counters: | ||
get: | ||
operationId: StatsService_GetCounters | ||
responses: | ||
"200": | ||
description: A successful response. | ||
schema: | ||
$ref: '#/definitions/v1Counters' | ||
default: | ||
description: An unexpected error response. | ||
schema: | ||
$ref: '#/definitions/rpcStatus' | ||
tags: | ||
- StatsService | ||
/api/v1/lines: | ||
get: | ||
operationId: StatsService_GetLineCharts | ||
responses: | ||
"200": | ||
description: A successful response. | ||
schema: | ||
$ref: '#/definitions/v1LineCharts' | ||
default: | ||
description: An unexpected error response. | ||
schema: | ||
$ref: '#/definitions/rpcStatus' | ||
tags: | ||
- StatsService | ||
/api/v1/lines/{name}: | ||
get: | ||
operationId: StatsService_GetLineChart | ||
responses: | ||
"200": | ||
description: A successful response. | ||
schema: | ||
$ref: '#/definitions/v1LineChart' | ||
default: | ||
description: An unexpected error response. | ||
schema: | ||
$ref: '#/definitions/rpcStatus' | ||
parameters: | ||
- name: name | ||
in: path | ||
required: true | ||
type: string | ||
- name: from | ||
description: Default is first data point | ||
in: query | ||
required: false | ||
type: string | ||
- name: to | ||
description: Default is last data point | ||
in: query | ||
required: false | ||
type: string | ||
- name: resolution | ||
in: query | ||
required: false | ||
type: string | ||
enum: | ||
- RESOLUTION_UNSPECIFIED | ||
- DAY | ||
- WEEK | ||
- MONTH | ||
- YEAR | ||
default: RESOLUTION_UNSPECIFIED | ||
tags: | ||
- StatsService | ||
/health: | ||
get: | ||
summary: |- | ||
If the requested service is unknown, the call will fail with status | ||
NOT_FOUND. | ||
operationId: Health_Check | ||
responses: | ||
"200": | ||
description: A successful response. | ||
schema: | ||
$ref: '#/definitions/v1HealthCheckResponse' | ||
default: | ||
description: An unexpected error response. | ||
schema: | ||
$ref: '#/definitions/rpcStatus' | ||
parameters: | ||
- name: service | ||
in: query | ||
required: false | ||
type: string | ||
tags: | ||
- Health | ||
definitions: | ||
HealthCheckResponseServingStatus: | ||
type: string | ||
enum: | ||
- UNKNOWN | ||
- SERVING | ||
- NOT_SERVING | ||
- SERVICE_UNKNOWN | ||
default: UNKNOWN | ||
description: ' - SERVICE_UNKNOWN: Used only by the Watch method.' | ||
protobufAny: | ||
type: object | ||
properties: | ||
'@type': | ||
type: string | ||
additionalProperties: {} | ||
rpcStatus: | ||
type: object | ||
properties: | ||
code: | ||
type: integer | ||
format: int32 | ||
message: | ||
type: string | ||
details: | ||
type: array | ||
items: | ||
type: object | ||
$ref: '#/definitions/protobufAny' | ||
v1Counter: | ||
type: object | ||
properties: | ||
id: | ||
type: string | ||
value: | ||
type: string | ||
title: | ||
type: string | ||
units: | ||
type: string | ||
description: | ||
type: string | ||
v1Counters: | ||
type: object | ||
properties: | ||
counters: | ||
type: array | ||
items: | ||
type: object | ||
$ref: '#/definitions/v1Counter' | ||
v1HealthCheckResponse: | ||
type: object | ||
properties: | ||
status: | ||
$ref: '#/definitions/HealthCheckResponseServingStatus' | ||
v1LineChart: | ||
type: object | ||
properties: | ||
chart: | ||
type: array | ||
items: | ||
type: object | ||
$ref: '#/definitions/v1Point' | ||
info: | ||
$ref: '#/definitions/v1LineChartInfo' | ||
v1LineChartInfo: | ||
type: object | ||
properties: | ||
id: | ||
type: string | ||
title: | ||
type: string | ||
description: | ||
type: string | ||
units: | ||
type: string | ||
resolutions: | ||
type: array | ||
items: | ||
type: string | ||
v1LineChartSection: | ||
type: object | ||
properties: | ||
id: | ||
type: string | ||
title: | ||
type: string | ||
charts: | ||
type: array | ||
items: | ||
type: object | ||
$ref: '#/definitions/v1LineChartInfo' | ||
v1LineCharts: | ||
type: object | ||
properties: | ||
sections: | ||
type: array | ||
items: | ||
type: object | ||
$ref: '#/definitions/v1LineChartSection' | ||
v1Point: | ||
type: object | ||
properties: | ||
date: | ||
type: string | ||
date_to: | ||
type: string | ||
value: | ||
type: string | ||
is_approximate: | ||
type: boolean | ||
title: All integers are encoded as strings to prevent data loss | ||
v1Resolution: | ||
type: string | ||
enum: | ||
- RESOLUTION_UNSPECIFIED | ||
- DAY | ||
- WEEK | ||
- MONTH | ||
- YEAR | ||
default: RESOLUTION_UNSPECIFIED |