chore: review

Author: shortcuts

specs/common/schemas/ingestion/WatchResponse.yml

@@ -7,16 +7,18 @@ properties:
     $ref: '../../parameters/ingestion.yml#/EventID'
   data:
     type: array
-    description: when used with discovering or validating sources, the sampled data of your source is returned.
+    description: |
+      This field is always null when used with the Push endpoint.
+      When used for a source discover or source validate run, it will include the sampled data of the source.
     items:
       type: object
   events:
-    description: in case of error, observability events will be added to the response, if any.
+    description: in case of error, observability events will be added to the response.
     type: array
     items:
       $ref: './Observability.yml#/Event'
   message:
-    description: a message describing the outcome of a validate run.
+    description: a message describing the outcome of the operation that has been ran (push, discover or validate) run.
     type: string
   createdAt:
     $ref: '../../parameters/ingestion.yml#/CreatedAt'

specs/search/helpers/partialUpdateObjectsWithTransformation.yml

@@ -4,9 +4,9 @@ method:
     tags:
       - Records
     operationId: partialUpdateObjectsWithTransformation
-    summary: Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+    summary: Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
     description: |
-      Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+      Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
     parameters:
       - in: query
         name: indexName

specs/search/helpers/saveObjectsWithTransformation.yml

@@ -4,9 +4,9 @@ method:
     tags:
       - Records
     operationId: saveObjectsWithTransformation
-    summary: Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+    summary: Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
     description: |
-      Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+      Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
     parameters:
       - in: query
         name: indexName

templates/javascript/clients/algoliasearch/builds/definition.mustache

@@ -32,9 +32,9 @@ export type Algoliasearch = SearchClient & {
   // Bridge helpers to expose along with the search endpoints at the root of the API client
 
   /**
-   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `saveObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
-   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
+   * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param saveObjects - The `saveObjects` object.
    * @param saveObjects.indexName - The `indexName` to save `objects` in.
    * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
@@ -45,7 +45,7 @@ export type Algoliasearch = SearchClient & {
   saveObjectsWithTransformation: (options: SaveObjectsOptions, requestOptions?: RequestOptions) => Promise<WatchResponse>;
 
   /**
-   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must've been passed to the client instantiation method.
+   * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/) to be created first, in order to transform records before indexing them to Algolia. The `region` must have been passed to the client instantiation method.
    *
    * @summary Save objects to an Algolia index by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
    * @param partialUpdateObjects - The `partialUpdateObjects` object.