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

packages/advanced-personalization/model/clientMethodProps.ts

@@ -15,7 +15,7 @@ export type ComputeRealtimeUserProps = {
  */
 export type CustomDeleteProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -29,7 +29,7 @@ export type CustomDeleteProps = {
  */
 export type CustomGetProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -43,7 +43,7 @@ export type CustomGetProps = {
  */
 export type CustomPostProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -61,7 +61,7 @@ export type CustomPostProps = {
  */
 export type CustomPutProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**

packages/advanced-personalization/src/advancedPersonalizationClient.ts

@@ -159,7 +159,7 @@ export function createAdvancedPersonalizationClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
-     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
      * @param customDelete.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -188,7 +188,7 @@ export function createAdvancedPersonalizationClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customGet - The customGet object.
-     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
      * @param customGet.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -214,7 +214,7 @@ export function createAdvancedPersonalizationClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
-     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPost.parameters - Query parameters to apply to the current query.
      * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -245,7 +245,7 @@ export function createAdvancedPersonalizationClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPut - The customPut object.
-     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPut.parameters - Query parameters to apply to the current query.
      * @param customPut.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

packages/algoliasearch/lite/model/clientMethodProps.ts

@@ -10,7 +10,7 @@ import type { SearchParamsObject } from './searchParamsObject';
  */
 export type CustomPostProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**

packages/algoliasearch/lite/src/liteClient.ts

@@ -173,7 +173,7 @@ export function createLiteClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
-     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPost.parameters - Query parameters to apply to the current query.
      * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

packages/client-abtesting/model/clientMethodProps.ts

@@ -5,7 +5,7 @@
  */
 export type CustomDeleteProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -19,7 +19,7 @@ export type CustomDeleteProps = {
  */
 export type CustomGetProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -33,7 +33,7 @@ export type CustomGetProps = {
  */
 export type CustomPostProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -51,7 +51,7 @@ export type CustomPostProps = {
  */
 export type CustomPutProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**

packages/client-abtesting/src/abtestingClient.ts

@@ -163,7 +163,7 @@ export function createAbtestingClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
-     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
      * @param customDelete.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -192,7 +192,7 @@ export function createAbtestingClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customGet - The customGet object.
-     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
      * @param customGet.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -218,7 +218,7 @@ export function createAbtestingClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
-     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPost.parameters - Query parameters to apply to the current query.
      * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -249,7 +249,7 @@ export function createAbtestingClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPut - The customPut object.
-     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPut.parameters - Query parameters to apply to the current query.
      * @param customPut.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

packages/client-analytics/model/clientMethodProps.ts

@@ -9,7 +9,7 @@ import type { OrderBy } from '../model/orderBy';
  */
 export type CustomDeleteProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -23,7 +23,7 @@ export type CustomDeleteProps = {
  */
 export type CustomGetProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -37,7 +37,7 @@ export type CustomGetProps = {
  */
 export type CustomPostProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -55,7 +55,7 @@ export type CustomPostProps = {
  */
 export type CustomPutProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**

packages/client-analytics/src/analyticsClient.ts

@@ -152,7 +152,7 @@ export function createAnalyticsClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
-     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
      * @param customDelete.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -181,7 +181,7 @@ export function createAnalyticsClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customGet - The customGet object.
-     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
      * @param customGet.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -207,7 +207,7 @@ export function createAnalyticsClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
-     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPost.parameters - Query parameters to apply to the current query.
      * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -238,7 +238,7 @@ export function createAnalyticsClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPut - The customPut object.
-     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPut.parameters - Query parameters to apply to the current query.
      * @param customPut.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

packages/client-composition/model/clientMethodProps.ts

@@ -13,7 +13,7 @@ import type { SearchForFacetValuesRequest } from '../model/searchForFacetValuesR
  */
 export type CustomDeleteProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -27,7 +27,7 @@ export type CustomDeleteProps = {
  */
 export type CustomGetProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -41,7 +41,7 @@ export type CustomGetProps = {
  */
 export type CustomPostProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**
@@ -59,7 +59,7 @@ export type CustomPostProps = {
  */
 export type CustomPutProps = {
   /**
-   * Path of the endpoint, anything after \"/1\" must be specified.
+   * Path of the endpoint, for example `1/newFeature`.
    */
   path: string;
   /**

packages/client-composition/src/compositionFullClient.ts

@@ -193,7 +193,7 @@ export function createCompositionClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
-     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
      * @param customDelete.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -222,7 +222,7 @@ export function createCompositionClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customGet - The customGet object.
-     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
      * @param customGet.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -248,7 +248,7 @@ export function createCompositionClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
-     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPost.parameters - Query parameters to apply to the current query.
      * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -279,7 +279,7 @@ export function createCompositionClient({
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPut - The customPut object.
-     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPut.parameters - Query parameters to apply to the current query.
      * @param customPut.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.