feat(api): add FormatQuery method to Prometheus v1 API (#1856)

yshngg · web-flow · commit 1f3a9042681e · 2025-08-20T15:43:10.000+01:00
Signed-off-by: Yusheng Guo &lt;yshngg@outlook.com&gt;
diff --git a/api/prometheus/v1/api.go b/api/prometheus/v1/api.go
@@ -506,6 +506,8 @@ type API interface {
 	TSDB(ctx context.Context, opts ...Option) (TSDBResult, error)
 	// WalReplay returns the current replay status of the wal.
 	WalReplay(ctx context.Context) (WalReplayStatus, error)
+	// FormatQuery formats a PromQL expression in a prettified way.
+	FormatQuery(ctx context.Context, query string) (string, error)
 }
 
 // AlertsResult contains the result from querying the alerts endpoint.

Original file line number	Diff line number	Diff line change
`@@ -506,6 +506,8 @@ type API interface {`
`506`	`506`	`TSDB(ctx context.Context, opts ...Option) (TSDBResult, error)`
`507`	`507`	`// WalReplay returns the current replay status of the wal.`
`508`	`508`	`WalReplay(ctx context.Context) (WalReplayStatus, error)`
	`509`	`+ // FormatQuery formats a PromQL expression in a prettified way.`
	`510`	`+ FormatQuery(ctx context.Context, query string) (string, error)`
`509`	`511`	`}`
`510`	`512`
`511`	`513`	`// AlertsResult contains the result from querying the alerts endpoint.`