chore(spec): fix comment of custom path (generated)

algolia/api-clients-automation#5014

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: algolia-bot

lib/algolia/api/abtesting_client.rb

@@ -115,7 +115,7 @@ def add_ab_tests(add_ab_tests_request, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -147,7 +147,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Object]
@@ -158,7 +158,7 @@ def custom_delete(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -190,7 +190,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Object]
@@ -201,7 +201,7 @@ def custom_get(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -234,7 +234,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -246,7 +246,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -279,7 +279,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

lib/algolia/api/analytics_client.rb

@@ -71,7 +71,7 @@ def add_user_agent_segment(segment, version = nil)
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -103,7 +103,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Object]
@@ -114,7 +114,7 @@ def custom_delete(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -146,7 +146,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Object]
@@ -157,7 +157,7 @@ def custom_get(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -190,7 +190,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -202,7 +202,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -235,7 +235,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)

lib/algolia/api/ingestion_client.rb

@@ -345,7 +345,7 @@ def create_transformation(transformation_create, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -377,7 +377,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Object]
@@ -388,7 +388,7 @@ def custom_delete(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
@@ -420,7 +420,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Object]
@@ -431,7 +431,7 @@ def custom_get(path, parameters = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -464,7 +464,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -476,7 +476,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {})
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
@@ -509,7 +509,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option
 
     # This method lets you send requests to the Algolia REST API.
 
-    # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
+    # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
     # @param body [Object] Parameters to send with the custom request.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)