diff --git a/pageserver/src/http/openapi_spec.yml b/pageserver/src/http/openapi_spec.yml index f5c1224f01..477a2d378d 100644 --- a/pageserver/src/http/openapi_spec.yml +++ b/pageserver/src/http/openapi_spec.yml @@ -93,9 +93,16 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + delete: description: | - Attempts to delete specified tenant. 500 and 409 errors should be retried until 404 is retrieved. + Attempts to delete specified tenant. 500, 503 and 409 errors should be retried until 404 is retrieved. 404 means that deletion successfully finished" responses: "400": @@ -134,6 +141,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/timeline: parameters: @@ -178,6 +192,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/timeline/{timeline_id}: parameters: @@ -226,6 +247,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + delete: description: "Attempts to delete specified timeline. 500 and 409 errors should be retried" responses: @@ -265,13 +293,19 @@ paths: application/json: schema: $ref: "#/components/schemas/PreconditionFailedError" - "500": description: Generic operation error content: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/timeline/{timeline_id}/get_lsn_by_timestamp: parameters: @@ -328,6 +362,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/timeline/{timeline_id}/do_gc: parameters: - name: tenant_id @@ -375,6 +416,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/attach: parameters: - name: tenant_id @@ -465,6 +513,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/detach: parameters: @@ -518,6 +573,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/ignore: parameters: @@ -560,6 +622,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/load: parameters: @@ -604,6 +673,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/synthetic_size: parameters: @@ -641,6 +717,12 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" /v1/tenant/{tenant_id}/size: parameters: @@ -704,6 +786,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/timeline/: parameters: @@ -780,6 +869,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/: get: description: Get tenants list @@ -810,6 +906,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + post: description: | Create a tenant. Returns new tenant id on success. @@ -860,6 +963,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/config: put: @@ -905,6 +1015,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + /v1/tenant/{tenant_id}/config/: parameters: - name: tenant_id @@ -954,6 +1071,13 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + "503": + description: Temporarily unavailable, please retry. + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceUnavailableError" + components: securitySchemes: JWT: @@ -1220,6 +1344,13 @@ components: properties: msg: type: string + ServiceUnavailableError: + type: object + required: + - msg + properties: + msg: + type: string NotFoundError: type: object required: