From ac9b287a2f790fcb012d990281b9df51fee227ad Mon Sep 17 00:00:00 2001
From: Deep Khajanchi <45371064+deepkhajanchi@users.noreply.github.com>
Date: Tue, 17 Sep 2024 13:24:40 -0700
Subject: [PATCH] Update built-in-endpoints.adoc

Updates in Health check endpoint
---
 modules/API/pages/built-in-endpoints.adoc | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/modules/API/pages/built-in-endpoints.adoc b/modules/API/pages/built-in-endpoints.adoc
index 3ed33f99..dc24b0e2 100644
--- a/modules/API/pages/built-in-endpoints.adoc
+++ b/modules/API/pages/built-in-endpoints.adoc
@@ -32,6 +32,8 @@ These endpoints are simple diagnostic utilities, which respond with the followin
 
 .GET /echo Request and Response
 
+Note: 9000 port is for RESTPP server then in the below request it should not return message "Hello GSQL" , do we need to correct this? 
+
 [source,console]
 ----
 curl -X GET "http://localhost:9000/echo"
@@ -58,6 +60,10 @@ curl -X GET "http://localhost:9000/echo"
 
 === Health check (public)
 
+Note: 
+- This 'api/ping endpoint is depended on GUI service and it cannot run on the higher number of nodes than 3 based on https://github.com/tigergraph/cqrs/blob/900a0fb81a649adbb2d60884b2e5ad23bb43b2f1/tutopia/common/config/node_assignment.go#L16. Therefor, hitting this endpoint on those nodes > 3 shows 502 error. So, this should not be treated as "health check endpoint" which is confusing our customers: https://tigergraph.zendesk.com/agent/tickets/53725.
+Zulip thread: https://zulip.graphtiger.com/#narrow/stream/39-TigerGraph-Frontline/topic/.2353725.3A.20.5BGoldman.20Sachs-US.5D.20-.20Need.20help.20to.20setup.20the.20paral.2E.2E.2E 
+
 `GET /api/ping`
 
 This endpoint performs a simple server health check. It listens on port 14240 and does not require authentication. If you ping it and the server is running, it will respond with the message "pong".