spec

Author: Arseny Bolotnikov

ydb/core/fq/libs/http_api_client/http_client.py

@@ -150,7 +150,7 @@ def create_query(
         self._validate_http_error(response, expected_code=expected_code)
         return response.json()["id"]
 
-    def restart_query(
+    def start_query(
         self,
         query_id: str,
         idempotency_key: str | None = None,

ydb/core/public_http/fq_handlers.h

@@ -401,9 +401,9 @@ DECLARE_YQ_GRPC_ACTOR(GetResultData, GetResultData);
 
 #define TGrpcCallWrapperBase TGrpcCallWrapper<FederatedQuery::DescribeQueryRequest, FQHttp::GetQueryRequest, FederatedQuery::ModifyQueryResult, google::protobuf::Empty, FederatedQuery::ModifyQueryResponse>
 
-class TRestartQueryRequest : public TGrpcCallWrapperBase {
+class TStartQueryRequest : public TGrpcCallWrapperBase {
 public:
-    TRestartQueryRequest(const THttpRequestContext& ctx)
+    TStartQueryRequest(const THttpRequestContext& ctx)
     : TGrpcCallWrapperBase(ctx, &NGRpcService::CreateFederatedQueryDescribeQueryRequestOperationCall)
     {}
 
@@ -446,7 +446,7 @@ class TRestartQueryRequest : public TGrpcCallWrapperBase {
                 TGrpcCallWrapper<FederatedQuery::ModifyQueryRequest, int, FederatedQuery::ModifyQueryResult, google::protobuf::Empty, FederatedQuery::ModifyQueryResponse>::SendReply
             );
 
-            // новый тип события, по идее нужна новая фабрика
+            // new event -> new EventFactory
             EventFactory = &NGRpcService::CreateFederatedQueryModifyQueryRequestOperationCall;
             ctx.Send(NGRpcService::CreateGRpcRequestProxyId(), EventFactory(requestContextModify).release());
             this->Die(ctx);

ydb/core/public_http/http_service.cpp

@@ -57,7 +57,7 @@ namespace {
             Router.RegisterHandler(HTTP_METHOD_GET,  "/api/fq/v1/queries/{query_id}/status", CreateHttpHandler<TJsonGetQueryStatus>());
             Router.RegisterHandler(HTTP_METHOD_GET,  "/api/fq/v1/queries/{query_id}/results/{result_set_index}", CreateHttpHandler<TJsonGetResultData>());
             Router.RegisterHandler(HTTP_METHOD_POST, "/api/fq/v1/queries/{query_id}/stop", CreateHttpHandler<TJsonStopQuery>());
-            Router.RegisterHandler(HTTP_METHOD_POST, "/api/fq/v1/queries/{query_id}/start", CreateHttpHandler<TRestartQueryRequest>());
+            Router.RegisterHandler(HTTP_METHOD_POST, "/api/fq/v1/queries/{query_id}/start", CreateHttpHandler<TStartQueryRequest>());
         }
 
         void Bootstrap(const TActorContext& ctx) {

ydb/core/public_http/openapi/openapi.yaml

@@ -185,6 +185,31 @@ paths:
         required: true
         schema:
           type: string
+  '/queries/{query_id}/start':
+    post:
+      responses:
+        '204':
+          description: No Content
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GenericError'
+      parameters:
+        - $ref: '#/components/parameters/Idempotency-Key'
+        - $ref: '#/components/parameters/Authorization'
+        - $ref: '#/components/parameters/x-request-id'
+        - $ref: '#/components/parameters/db'
+        - $ref: '#/components/parameters/project'
+      summary: start stopped query
+      operationId: start-query
+    parameters:
+      - name: query_id
+        in: path
+        required: true
+        schema:
+          type: string
   '/queries/{query_id}/results/{result_set_index}':
     parameters:
       - name: query_id

ydb/tests/fq/http_api/test_http_api.py

@@ -98,7 +98,7 @@ def test_simple_analytics_query(self):
             response = client.stop_query(query_id)
             assert response.status_code == 204
 
-            response = client.restart_query(query_id)
+            response = client.start_query(query_id)
             assert response.status_code == 204
 
             response = client.stop_query(query_id)
@@ -120,7 +120,7 @@ def test_invalid_id(self):
             resp = client.stop_quert(query_id="nevalidno")
             assert resp.status_code == 404
 
-            resp = client.restart_query(query_id="snova nevalidno")
+            resp = client.start_query(query_id="snova nevalidno")
             assert resp.status_code == 404
 
     def test_warning(self):
@@ -252,18 +252,20 @@ def test_restart_idempotency(self):
             response1 = client.stop_query(query_id, idempotency_key="Z")
             assert response1.status_code == 204
 
-            response2 = client.restart_query(query_id, idempotency_key="Z")
+            response2 = client.start_query(query_id, idempotency_key="Z")
             assert response2.status_code == 204
 
-            response2 = client.restart_query(query_id, idempotency_key="Z")
+            response2 = client.start_query(query_id, idempotency_key="Z")
             assert response2.status_code == 204
 
-            response2 = client.restart_query(query_id)
+            response2 = client.start_query(query_id)
             assert response2.status_code == 400
 
+            response1 = client.stop_query(query_id, idempotency_key="Z")
+            assert response1.status_code == 204
+
         self.streaming_over_kikimr.compute_plane.start()
         c.wait_query_status(query_id, fq.QueryMeta.ABORTED_BY_USER)
-        pass
 
     def test_simple_streaming_query(self):
         self.init_topics("simple_streaming_query", create_output=False)
@@ -296,7 +298,7 @@ def test_simple_streaming_query(self):
             response = client.stop_query(query_id)
             assert response.status_code == 204
 
-            response = client.restart_query(query_id)
+            response = client.start_query(query_id)
             assert response.status_code == 204
 
             wait_for_query_status(client, query_id, ["FAILED"])