Skip to content

Commit

Permalink
feat(oas): handle buildinfo requests to Tempo API
Browse files Browse the repository at this point in the history
  • Loading branch information
tdakkota committed May 27, 2024
1 parent 8a1aab5 commit 04e265c
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions _oas/tempo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ externalDocs:
servers:
- url: "http://localhost:3200"
paths:
/api/status/buildinfo:
get:
operationId: buildInfo
description: |
Returns Tempo buildinfo, in the same format as Prometheus `/api/v1/status/buildinfo`.
Used by Grafana to check Tempo API version.
responses:
200:
$ref: "#/components/responses/BuildInfo"
default:
$ref: "#/components/responses/Error"
/api/echo:
get:
operationId: echo
Expand All @@ -22,6 +33,7 @@ paths:
example: echo
default:
$ref: "#/components/responses/Error"

/api/traces/{traceID}:
get:
operationId: traceByID
Expand Down Expand Up @@ -301,6 +313,12 @@ components:
"application/json":
schema:
$ref: "#/components/schemas/Error"
BuildInfo:
description: Prometheus version JSON.
content:
"application/json":
schema:
$ref: "#/components/schemas/PrometheusVersion"
TraceByID:
description: Query by trace ID result
content:
Expand Down Expand Up @@ -531,5 +549,28 @@ components:
- "intrinsic"
- "none"

PrometheusVersion:
type: object
required:
- version
- revision
- branch
- buildUser
- buildDate
- goVersion
properties:
version:
type: string
revision:
type: string
branch:
type: string
buildUser:
type: string
buildDate:
type: string
goVersion:
type: string

Error:
type: string

0 comments on commit 04e265c

Please sign in to comment.