jerryshao commented on code in PR #10840: URL: https://github.com/apache/gravitino/pull/10840#discussion_r3122981288
########## conf/gravitino.conf.template: ########## @@ -19,6 +19,8 @@ # THE CONFIGURATION FOR Gravitino SERVER gravitino.server.shutdown.timeout = 3000 +# Timeout in milliseconds for the entity-store liveness probe used by health endpoints Review Comment: Fixed. Updated the comment to read "entity-store readiness probe used by /api/health/ready" to accurately reflect which endpoint this timeout controls. ########## docs/open-api/health.yaml: ########## @@ -0,0 +1,168 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + + +--- + +paths: + /health: + get: + tags: + - health + summary: Aggregate health + operationId: aggregateHealth + description: > + Returns aggregate health status combining liveness and readiness checks. + Returns 200 when all checks pass; 503 when any check fails. + This endpoint is exempt from authentication so probes can reach it without credentials. + security: [] + responses: + "200": + $ref: "#/components/responses/HealthResponse" + "503": + $ref: "#/components/responses/HealthResponse" + "4XX": + $ref: "./openapi.yaml#/components/responses/BadRequestErrorResponse" + "5xx": + $ref: "./openapi.yaml#/components/responses/ServerErrorResponse" + Review Comment: Fixed. Changed all three `5xx` keys to `5XX` to match the OpenAPI patterned-field syntax. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
