From 7ebe9ca1aca6c6fb23507f984950cfd061e637f0 Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Tue, 31 Oct 2023 09:32:58 +0100 Subject: [PATCH] pageserver: `/attach`: clarify semantics of 409 (#5698) context: https://app.incident.io/neondb/incidents/75 specifically: https://neondb.slack.com/archives/C0634NXQ6E7/p1698422852902959?thread_ts=1698419362.155059&cid=C0634NXQ6E7 --- pageserver/src/http/openapi_spec.yml | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/pageserver/src/http/openapi_spec.yml b/pageserver/src/http/openapi_spec.yml index 2d954f6823..d31e4a1554 100644 --- a/pageserver/src/http/openapi_spec.yml +++ b/pageserver/src/http/openapi_spec.yml @@ -569,7 +569,17 @@ paths: schema: $ref: "#/components/schemas/NotFoundError" "409": - description: Tenant download is already in progress + description: | + The tenant is already known to Pageserver in some way, + and hence this `/attach` call has been rejected. + + Some examples of how this can happen: + - tenant was created on this pageserver + - tenant attachment was started by an earlier call to `/attach`. + + Callers should poll the tenant status's `attachment_status` field, + like for status 202. See the longer description for `POST /attach` + for details. content: application/json: schema: