fix(specs): endpoint level timeout for ingestion (#4251)

Author: shortcuts

clients/algoliasearch-client-python/algoliasearch/http/request_options.py

@@ -58,6 +58,7 @@ def merge(
         query_parameters: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
         data: Optional[str] = None,
+        timeouts: Dict[str, int] = {},
         user_request_options: Optional[Union[Self, Dict[str, Any]]] = None,
     ) -> Self:
         """
@@ -74,9 +75,9 @@ def merge(
             "headers": headers,
             "query_parameters": query_parameters,
             "timeouts": {
-                "read": self._config.read_timeout,
-                "write": self._config.write_timeout,
-                "connect": self._config.connect_timeout,
+                "read": timeouts.get("read", self._config.read_timeout),
+                "write": timeouts.get("write", self._config.write_timeout),
+                "connect": timeouts.get("connect", self._config.connect_timeout),
             },
             "data": data,
         }

specs/ingestion/paths/sources/discover.yml

@@ -10,6 +10,10 @@ post:
     - addObject
     - deleteIndex
     - editSettings
+  x-timeouts:
+    connect: 180000
+    read: 180000
+    write: 180000
   parameters:
     - $ref: '../../common/parameters.yml#/pathSourceID'
   responses:

specs/ingestion/paths/sources/validate.yml

@@ -9,6 +9,10 @@ post:
     - addObject
     - deleteIndex
     - editSettings
+  x-timeouts:
+    connect: 180000
+    read: 180000
+    write: 180000
   requestBody:
     description: ''
     content:

specs/ingestion/paths/sources/validateID.yml

@@ -9,6 +9,10 @@ post:
     - addObject
     - deleteIndex
     - editSettings
+  x-timeouts:
+    connect: 180000
+    read: 180000
+    write: 180000
   parameters:
     - $ref: '../../common/parameters.yml#/pathSourceID'
   requestBody:

specs/ingestion/paths/tasks/v2/pushTask.yml

@@ -8,6 +8,10 @@ post:
     - addObject
     - deleteIndex
     - editSettings
+  x-timeouts:
+    connect: 180000
+    read: 180000
+    write: 180000
   parameters:
     - $ref: '../../../common/parameters.yml#/pathTaskID'
     - name: watch

templates/javascript/clients/api-single.mustache

@@ -159,6 +159,17 @@ export function create{{#lambda.titlecase}}{{clientName}}{{/lambda.titlecase}}({
         {{/vendorExtensions}}
       };
 
+      {{#vendorExtensions.x-timeouts}}
+      requestOptions = {
+        timeouts: {
+          connect: {{connect}},
+          read: {{read}},
+          write: {{write}},
+          ...requestOptions?.timeouts,
+        }
+      }
+      {{/vendorExtensions.x-timeouts}}
+
       return transporter.request(request, requestOptions);
     },
 

templates/python/api.mustache

@@ -180,6 +180,13 @@ class {{classname}}{{#isSyncClient}}Sync{{/isSyncClient}}:
                 {{#queryParams.0}}query_parameters=_query_parameters,{{/queryParams.0}}
                 {{#headerParams.0}}headers=_headers,{{/headerParams.0}}
                 {{#bodyParam}}data=dumps(body_serializer(_data)),{{/bodyParam}}
+                {{#vendorExtensions.x-timeouts}}
+                timeouts={
+                  "read": {{read}},
+                  "write": {{write}},
+                  "connect": {{connect}},
+                },
+                {{/vendorExtensions.x-timeouts}}
                 user_request_options=request_options,
             ),
             {{#vendorExtensions}}

templates/ruby/api.mustache

@@ -138,6 +138,9 @@ module {{moduleName}}
       {{/headerParams}}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
       {{/vendorExtensions}}
+      {{#vendorExtensions.x-timeouts}}
+      request_options[:timeout] ||= {{#vendorExtensions.x-use-read-transporter}}{{vendorExtensions.x-timeouts.read}}{{/vendorExtensions.x-use-read-transporter}} {{^vendorExtensions.x-use-read-transporter}}{{vendorExtensions.x-timeouts.write}}{{/vendorExtensions.x-use-read-transporter}} 
+      {{/vendorExtensions.x-timeouts}}
 
       post_body = request_options[:debug_body]{{#bodyParam}} || @api_client.object_to_http_body({{{paramName}}}){{/bodyParam}}
 
@@ -187,4 +190,4 @@ module {{moduleName}}
 {{/isSearchClient}}
   end
 {{/operations}}
-end
+end