Skip to content

Commit cd4b011

Browse files
committed
use hidden tag on query endpoint
1 parent 6d77cd9 commit cd4b011

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

nexus/external-api/output/nexus_tags.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ probe_create POST /experimental/v1/probes
3030
probe_delete DELETE /experimental/v1/probes/{probe}
3131
probe_list GET /experimental/v1/probes
3232
probe_view GET /experimental/v1/probes/{probe}
33+
timeseries_query POST /v1/timeseries/query
3334

3435
API operations found with tag "images"
3536
OPERATION ID METHOD URL PATH
@@ -73,7 +74,6 @@ login_saml POST /login/{silo_name}/saml/{provi
7374
API operations found with tag "metrics"
7475
OPERATION ID METHOD URL PATH
7576
silo_metric GET /v1/metrics/{metric_name}
76-
timeseries_query POST /v1/timeseries/query
7777

7878
API operations found with tag "policy"
7979
OPERATION ID METHOD URL PATH

nexus/external-api/src/lib.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2567,6 +2567,10 @@ pub trait NexusExternalApi {
25672567
body: TypedBody<params::TimeseriesQuery>,
25682568
) -> Result<HttpResponseOk<views::OxqlQueryResult>, HttpError>;
25692569

2570+
// TODO: list endpoint for project-scoped schemas is blocked on
2571+
// https://github.com/oxidecomputer/omicron/issues/5942: the authz scope for
2572+
// each schema is not stored in Clickhouse yet.
2573+
25702574
/// Run project-scoped timeseries query
25712575
///
25722576
/// Queries are written in OxQL. Project must be specified by name or ID in
@@ -2575,7 +2579,7 @@ pub trait NexusExternalApi {
25752579
#[endpoint {
25762580
method = POST,
25772581
path = "/v1/timeseries/query",
2578-
tags = ["metrics"],
2582+
tags = ["hidden"],
25792583
}]
25802584
async fn timeseries_query(
25812585
rqctx: RequestContext<Self::Context>,

openapi/nexus.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8893,7 +8893,7 @@
88938893
"/v1/timeseries/query": {
88948894
"post": {
88958895
"tags": [
8896-
"metrics"
8896+
"hidden"
88978897
],
88988898
"summary": "Run project-scoped timeseries query",
88998899
"description": "Queries are written in OxQL. Project must be specified by name or ID in URL query parameter. The OxQL query will only return timeseries data from the specified project.",

0 commit comments

Comments
 (0)