From 780e9df94e0fe8c2069fad3cc1566b10539129fd Mon Sep 17 00:00:00 2001 From: Tushar-TG-14 Date: Tue, 13 Jan 2026 21:10:00 +0530 Subject: [PATCH 1/8] Finalize Node Replacement V2 documentation for 4.2 --- .../cluster-and-ha-management/pages/node-replacement-v2.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/cluster-and-ha-management/pages/node-replacement-v2.adoc b/modules/cluster-and-ha-management/pages/node-replacement-v2.adoc index e26be736..8b8322bf 100644 --- a/modules/cluster-and-ha-management/pages/node-replacement-v2.adoc +++ b/modules/cluster-and-ha-management/pages/node-replacement-v2.adoc @@ -255,4 +255,4 @@ Ensure the data volume is mounted under `/data`, the RESTPP port matches the tar * *DNS does not update* + -Check the TTL value on the Route 53 record, verify the correct hostname was updated (UPSERT), and confirm the change with `nslookup`. +Check the TTL value on the Route 53 record, verify the correct hostname was updated (UPSERT), and confirm the change with `nslookup`. \ No newline at end of file From 39cb902ee0b3c2771d99bde007bbff0886af5701 Mon Sep 17 00:00:00 2001 From: Tushar-TG-14 Date: Thu, 23 Jul 2026 16:59:11 +0530 Subject: [PATCH 2/8] DOC-2403 note on run query endpoint --- modules/API/pages/built-in-endpoints.adoc | 7 +++++++ modules/API/pages/gsql-endpoints.adoc | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/modules/API/pages/built-in-endpoints.adoc b/modules/API/pages/built-in-endpoints.adoc index 65ae258a..262c9afd 100644 --- a/modules/API/pages/built-in-endpoints.adoc +++ b/modules/API/pages/built-in-endpoints.adoc @@ -2534,6 +2534,13 @@ Each time a new TigerGraph query is installed, a dynamic endpoint is generated. This new endpoint enables the user to run the new TigerGraph query through HTTP requests and giving the parameters in URL or in a data payload. In the case of a `GET` request, parameters should be passed in through the query string. +[NOTE] +==== +This RESTPP endpoint is the recommended endpoint for running installed queries because it avoids the additional processing performed by the GSQL endpoint. + +Use the GSQL endpoint only if you specifically require its additional functionality. +==== + ==== Parameters: [%autowidth] diff --git a/modules/API/pages/gsql-endpoints.adoc b/modules/API/pages/gsql-endpoints.adoc index 791b682e..2dad2954 100644 --- a/modules/API/pages/gsql-endpoints.adoc +++ b/modules/API/pages/gsql-endpoints.adoc @@ -3212,6 +3212,13 @@ Sample Response:: The endpoint is used to run a query by its name. +[NOTE] +==== +This endpoint provides additional GSQL-specific processing before forwarding the request to the RESTPP query endpoint. + +If you only need to run an installed query, TigerGraph recommends using the RESTPP endpoint `GET /query/{graph_name}/{query_name}` for lower request overhead. See xref:api:built-in-endpoints.adoc#_run_an_installed_query_get[Run an installed query (`GET`)]. +==== + ==== Endpoint Parameters: [%autowidth] From 88262e04aefac3a4b76329c11580a4ad51d80ebf Mon Sep 17 00:00:00 2001 From: Tushar-TG-14 Date: Fri, 24 Jul 2026 15:42:11 +0530 Subject: [PATCH 3/8] Update built-in-endpoints.adoc --- modules/API/pages/built-in-endpoints.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/API/pages/built-in-endpoints.adoc b/modules/API/pages/built-in-endpoints.adoc index 262c9afd..2d0a0ee5 100644 --- a/modules/API/pages/built-in-endpoints.adoc +++ b/modules/API/pages/built-in-endpoints.adoc @@ -2531,14 +2531,14 @@ If you install all queries and receive a state of `SUCCESS` for one or more quer `+GET /restpp/query/{graph_name}/{query_name}+` Each time a new TigerGraph query is installed, a dynamic endpoint is generated. -This new endpoint enables the user to run the new TigerGraph query through HTTP requests and giving the parameters in URL or in a data payload. +This endpoint enables users to run an installed TigerGraph query through HTTP requests by providing parameters in the URL or request payload. In the case of a `GET` request, parameters should be passed in through the query string. [NOTE] ==== This RESTPP endpoint is the recommended endpoint for running installed queries because it avoids the additional processing performed by the GSQL endpoint. -Use the GSQL endpoint only if you specifically require its additional functionality. +Use the xref:api:gsql-endpoints.adoc#_run_query[GSQL Run query endpoint] only if you specifically require its additional functionality. ==== ==== Parameters: From 429f351688f38ad8d8fedb5997430cd07ec22f63 Mon Sep 17 00:00:00 2001 From: Tushar-TG-14 Date: Fri, 24 Jul 2026 15:50:40 +0530 Subject: [PATCH 4/8] Update gsql-endpoints.adoc --- modules/API/pages/gsql-endpoints.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/API/pages/gsql-endpoints.adoc b/modules/API/pages/gsql-endpoints.adoc index 2dad2954..45322cf1 100644 --- a/modules/API/pages/gsql-endpoints.adoc +++ b/modules/API/pages/gsql-endpoints.adoc @@ -3214,9 +3214,9 @@ The endpoint is used to run a query by its name. [NOTE] ==== -This endpoint provides additional GSQL-specific processing before forwarding the request to the RESTPP query endpoint. +If you only need to run an installed query, TigerGraph recommends using the RESTPP endpoint `GET /query/{graph_name}/{query_name}` for lower request overhead. -If you only need to run an installed query, TigerGraph recommends using the RESTPP endpoint `GET /query/{graph_name}/{query_name}` for lower request overhead. See xref:api:built-in-endpoints.adoc#_run_an_installed_query_get[Run an installed query (`GET`)]. +See xref:api:built-in-endpoints.adoc#_run_an_installed_query_get[Run an installed query (GET)]. ==== ==== Endpoint Parameters: From 37c7bb30697fbf97dddf020044b267340e1d1dd7 Mon Sep 17 00:00:00 2001 From: Tushar-TG-14 Date: Mon, 27 Jul 2026 18:55:47 +0530 Subject: [PATCH 5/8] Update gsql-endpoints.adoc --- modules/API/pages/gsql-endpoints.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/API/pages/gsql-endpoints.adoc b/modules/API/pages/gsql-endpoints.adoc index 45322cf1..6d22d1ea 100644 --- a/modules/API/pages/gsql-endpoints.adoc +++ b/modules/API/pages/gsql-endpoints.adoc @@ -3214,7 +3214,9 @@ The endpoint is used to run a query by its name. [NOTE] ==== -If you only need to run an installed query, TigerGraph recommends using the RESTPP endpoint `GET /query/{graph_name}/{query_name}` for lower request overhead. +This endpoint performs the same core function as the RESTPP endpoint `GET /query/{graph_name}/{query_name}`. + +It is provided as part of the standardized GSQL API introduced in 4.1. If you already use the RESTPP endpoint, you can continue using it. See xref:api:built-in-endpoints.adoc#_run_an_installed_query_get[Run an installed query (GET)]. ==== From 2024cab52142573c036eb786b0df9f900fede5f5 Mon Sep 17 00:00:00 2001 From: Tushar-TG-14 Date: Mon, 27 Jul 2026 18:55:52 +0530 Subject: [PATCH 6/8] Update documentation on RESTPP and GSQL endpoints Clarified the usage of RESTPP and GSQL endpoints for running installed queries. --- modules/API/pages/built-in-endpoints.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/API/pages/built-in-endpoints.adoc b/modules/API/pages/built-in-endpoints.adoc index 2d0a0ee5..7395f10b 100644 --- a/modules/API/pages/built-in-endpoints.adoc +++ b/modules/API/pages/built-in-endpoints.adoc @@ -2536,9 +2536,9 @@ In the case of a `GET` request, parameters should be passed in through the query [NOTE] ==== -This RESTPP endpoint is the recommended endpoint for running installed queries because it avoids the additional processing performed by the GSQL endpoint. +This endpoint and the xref:api:gsql-endpoints.adoc#_run_query[GSQL Run query] endpoint perform the same core function of running an installed query. -Use the xref:api:gsql-endpoints.adoc#_run_query[GSQL Run query endpoint] only if you specifically require its additional functionality. +TigerGraph provides the GSQL endpoint as part of a standardized GSQL API. If your application already uses the RESTPP API, you can continue using this endpoint. ==== ==== Parameters: From 8ef8470d51da01db65593e98e5a39ae5c2afe376 Mon Sep 17 00:00:00 2001 From: Tushar-TG-14 Date: Wed, 29 Jul 2026 21:20:30 +0530 Subject: [PATCH 7/8] Update built-in-endpoints.adoc --- modules/API/pages/built-in-endpoints.adoc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/modules/API/pages/built-in-endpoints.adoc b/modules/API/pages/built-in-endpoints.adoc index 7395f10b..cdd791c1 100644 --- a/modules/API/pages/built-in-endpoints.adoc +++ b/modules/API/pages/built-in-endpoints.adoc @@ -2536,9 +2536,13 @@ In the case of a `GET` request, parameters should be passed in through the query [NOTE] ==== -This endpoint and the xref:api:gsql-endpoints.adoc#_run_query[GSQL Run query] endpoint perform the same core function of running an installed query. +TigerGraph provides both RESTPP and GSQL endpoints for running installed queries. -TigerGraph provides the GSQL endpoint as part of a standardized GSQL API. If your application already uses the RESTPP API, you can continue using this endpoint. +This RESTPP endpoint executes installed queries directly. The GSQL xref:api:gsql-endpoints.adoc#_run_query[Run query endpoint] internally forwards requests to this endpoint as part of the standardized GSQL API introduced in TigerGraph 4.1. + +If your application does not require the standardized GSQL API, TigerGraph recommends using this RESTPP endpoint because it executes the query directly without the additional request forwarding. + +For a comparison of the RESTPP and GSQL endpoints, including differences in parameter formats and request processing, see xref:api:gsql-endpoints.adoc#_comparing_the_restpp_and_gsql_query_endpoints[Comparing the RESTPP and GSQL query endpoints]. ==== ==== Parameters: From 934c494a3995463871738839f13bce7b64b1c7e4 Mon Sep 17 00:00:00 2001 From: Tushar-TG-14 Date: Wed, 29 Jul 2026 21:20:35 +0530 Subject: [PATCH 8/8] Update gsql-endpoints.adoc --- modules/API/pages/gsql-endpoints.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/API/pages/gsql-endpoints.adoc b/modules/API/pages/gsql-endpoints.adoc index 6d22d1ea..244a9d80 100644 --- a/modules/API/pages/gsql-endpoints.adoc +++ b/modules/API/pages/gsql-endpoints.adoc @@ -3214,11 +3214,11 @@ The endpoint is used to run a query by its name. [NOTE] ==== -This endpoint performs the same core function as the RESTPP endpoint `GET /query/{graph_name}/{query_name}`. +This endpoint provides a standardized GSQL API for running installed queries. Internally, it forwards requests to the RESTPP endpoint `GET /restpp/query/{graph_name}/{query_name}` to execute the query. -It is provided as part of the standardized GSQL API introduced in 4.1. If you already use the RESTPP endpoint, you can continue using it. +Use this endpoint if you are working with the standardized GSQL API or want consistency with other GSQL endpoints. If your application does not require the standardized GSQL API, consider using the xref:api:built-in-endpoints.adoc#_run_an_installed_query_get[RESTPP endpoint], which executes installed queries directly without the additional request forwarding. -See xref:api:built-in-endpoints.adoc#_run_an_installed_query_get[Run an installed query (GET)]. +For a comparison of the RESTPP and GSQL endpoints, including differences in parameter formats and request processing, see xref:#_comparing_the_restpp_and_gsql_query_endpoints[Comparing the RESTPP and GSQL query endpoints]. ==== ==== Endpoint Parameters: