do_gc is missing from openapi spec

[koivunej]

Enabled in #3639, but a schema description was not added.

[shanyp]

how do we ensure that this is not called in our public API surface? this should be allowed only to admins (Neon)

[hlinnaka]

how do we ensure that this is not called in our public API surface? this should be allowed only to admins (Neon)

Users cannot call the pageserver's API directly

[koivunej]

Note that #3756 missed the body requirement for the PUT in schema. Can't remember how it's described, and am also a bit sad how much describing requires uninteresting boilerplate (those non-200 cases).

For example:

$ curl -X PUT localhost:9898/v1/tenant/b5e8a13d500fc802c16caa9c0998af5c/timeline/73e1f731e8bfd33e54f239d8e20c8a2d/do_gc && echo
{"msg":"Error {\n    context: \"Failed to parse json request\",\n    source: Error(\"EOF while parsing a value\", line: 1, column: 0),\n}"}
$ curl -X PUT -H 'content-type: application/json' localhost:9898/v1/tenant/b5e8a13d500fc802c16caa9c0998af5c/timeline/73e1f731e8bfd33e54f239d8e20c8a2d/do_gc && echo
{"msg":"Error {\n    context: \"Failed to parse json request\",\n    source: Error(\"EOF while parsing a value\", line: 1, column: 0),\n}"}

Error comes from

neon/pageserver/src/http/routes.rs

Line 933 in fb1581d

let gc_req: TimelineGcRequest = json_request(&mut request).await?;

I think the body should be optional because {} is fine, but there could also be the gc_horizon. I don't think there's a serde-specific way to make it accept '' as '{}' because empty input is not valid json. I also think accepting the gc_horizon a bit sketchy if it should be allowed in prod, but #3639 just removed the conditional compilation without discussion on this.

[koivunej]

I think this is already fixed.

[LizardWizzard]

If it is indeed already in place: https://github.com/zenithdb/zenith/blob/24eaa3b7ca818558c8255343e8fa134d876449fe/pageserver/src/http/openapi_spec.yml#L290