Doc 2403 run query endpoint

[Tushar-TG-14]

No description provided.

[victorleeTG]

"only need to run an installed query"

"only" is in comparison to what? What are these others things that this GSQL endpoint could do?

[qe-tigergraph]

PR Review Agent verdict: 🔴 request_changes

This is an automated review agent's judgement. False alarm? React 👎 on this comment to flag it for other reviewers.

Open issues (2)

🟠 Major (1)

• The NOTE block in both changed files fails to meet the core requirements of DOC-2403. The ticket and Victor Lee's explicit instructions require the docs to explain why two endpoints exist and the tradeoffs between them. Specifically: the GSQL endpoint (POST /gsql/v1/queries/{queryName}) internally forwards the request to RESTPP, adding an extra hop and latency. The RESTPP endpoint (GET /restpp/query/{graph_name}/{query_name}) handles the query directly with less overhead. The docs should frame the GSQL endpoint as a wrapper provided for API consistency and advise users optimizing for latency to use the RESTPP endpoint directly. — modules/API/pages/gsql-endpoints.adoc

🟡 Minor (1)

• The NOTE cites the RESTPP endpoint as `GET /query/{graph_name}/{query_name}` but the actual endpoint (documented on the built-in-endpoints page, line 2531) is `GET /restpp/query/{graph_name}/{query_name}`. The /restpp prefix is missing. A reader who copies this path directly would get a 404. — modules/API/pages/gsql-endpoints.adoc

[qe-tigergraph]

🟠 [major]

The NOTE block in both changed files fails to meet the core requirements of DOC-2403. The ticket and Victor Lee's explicit instructions require the docs to explain why two endpoints exist and the tradeoffs between them. Specifically: the GSQL endpoint (POST /gsql/v1/queries/{queryName}) internally forwards the request to RESTPP, adding an extra hop and latency. The RESTPP endpoint (GET /restpp/query/{graph_name}/{query_name}) handles the query directly with less overhead. The docs should frame the GSQL endpoint as a wrapper provided for API consistency and advise users optimizing for latency to use the RESTPP endpoint directly.

The current NOTE blocks only state that the two endpoints "perform the same core function" and "if you already use one, keep using it." This does not give a new user any basis for choosing between them.

Suggested fix: On the GSQL page (the wrapper), add text such as: "This endpoint is a wrapper that forwards the request internally to the RESTPP endpoint. It is provided as part of the standardized GSQL API for consistency with other GSQL endpoints. Users who need to minimize latency and server traffic should use the RESTPP endpoint directly." On the RESTPP page, note that it is the canonical/direct endpoint with lower overhead, and cross-reference the GSQL wrapper.

[qe-tigergraph]

🟡 [minor]

The NOTE cites the RESTPP endpoint as `GET /query/{graph_name}/{query_name}` but the actual endpoint (documented on the built-in-endpoints page, line 2531) is `GET /restpp/query/{graph_name}/{query_name}`. The /restpp prefix is missing. A reader who copies this path directly would get a 404.

Suggested fix: `GET /restpp/query/{graph_name}/{query_name}`

[qe-tigergraph]

PR Review — ⚠️ this round failed

The reviewer could not produce a review for 2024cab (RequestFailed: Response(404 Not Found, data_model=typing.Any)). No findings were posted this round.

Please retry: wip -review server-docs#966