diff --git a/scripts/buildLanguages.ts b/scripts/buildLanguages.ts index 0cfed5b7422..c6927c30ced 100644 --- a/scripts/buildLanguages.ts +++ b/scripts/buildLanguages.ts @@ -59,6 +59,9 @@ async function buildLanguage(language: Language, gens: Generator[], buildType: B if (buildType !== 'guides') { fileNames = gens.reduce((prev, curr) => `${prev} ${createClientName(curr.client, curr.language)}.ts`, ''); + } else if (!fileNames.includes('search')) { + // only search is needed for guides right now, if it's not being built, no need to validate guides + break; } await run(`yarn tsc ${fileNames} --noEmit`, { diff --git a/specs/crawler/common/schemas/configuration.yml b/specs/crawler/common/schemas/configuration.yml index 47daad30e21..be07a169021 100644 --- a/specs/crawler/common/schemas/configuration.yml +++ b/specs/crawler/common/schemas/configuration.yml @@ -9,7 +9,7 @@ Configuration: actions: type: array description: | - Instructions how to process crawled URLs. + Instructions about how to process crawled URLs. Each action defines: @@ -31,7 +31,7 @@ Configuration: The API key must have the following access control list (ACL) permissions: `search`, `browse`, `listIndexes`, `addObject`, `deleteObject`, `deleteIndex`, `settings`, `editSettings`. The API key must not be the admin API key of the application. - The API key must have access to the indices which the crawler is supposed to create. + The API key must have access to create the indices that the crawler will use. For example, if `indexPrefix` is `crawler_`, the API key must have access to all `crawler_*` indices. appId: $ref: '../parameters.yml#/applicationID' @@ -54,7 +54,7 @@ Configuration: description: | References to external data sources for enriching the extracted records. - For more information, see [Enrich extrated records with external data](https://www.algolia.com/doc/tools/crawler/guides/enriching-extraction-with-external-data/). + For more information, see [Enrich extracted records with external data](https://www.algolia.com/doc/tools/crawler/guides/enriching-extraction-with-external-data/). maxItems: 10 items: type: string diff --git a/specs/crawler/paths/crawlerTaskCancel.yml b/specs/crawler/paths/crawlerTaskCancel.yml index de0660f391c..c699b3ef79a 100644 --- a/specs/crawler/paths/crawlerTaskCancel.yml +++ b/specs/crawler/paths/crawlerTaskCancel.yml @@ -4,8 +4,8 @@ post: description: | Cancels a blocking task. - Tasks that ran into an error block the futher schedule of your Crawler. - To unblock the crawler, you can cancel the blocking task. + Tasks that ran into an error will block your crawler's schedule. + To unblock the crawler, cancel the blocking task. tags: - tasks parameters: diff --git a/specs/crawler/spec.yml b/specs/crawler/spec.yml index 71f52ee7aa3..f59e25ec3ad 100644 --- a/specs/crawler/spec.yml +++ b/specs/crawler/spec.yml @@ -14,7 +14,7 @@ info: ## Availability and authentication - Acess to the Crawler API is available with the [Crawler add-on](https://www.algolia.com/pricing/). + Access to the Crawler API is available with the [Crawler add-on](https://www.algolia.com/pricing/). To authenticate your API requests, use the **basic authentication** header: @@ -73,7 +73,7 @@ tags: In the Crawler configuration, you specify which URLs to crawl, when to crawl, how to extract records from the crawl, and where to index the extracted records. The configuration is versioned, so you can always restore a previous version. It's easiest to make configuration changes in the [Crawler dashboard](https://crawler.algolia.com/admin/). - The editor has autocomplete and builtin validation so you can try your configuration changes before comitting them. + The editor has autocomplete and built-in validation so you can try your configuration changes before committing them. - name: crawlers x-displayName: Crawler description: | diff --git a/specs/ingestion/common/schemas/transformation.yml b/specs/ingestion/common/schemas/transformation.yml index d8f6fea5e23..541c686de03 100644 --- a/specs/ingestion/common/schemas/transformation.yml +++ b/specs/ingestion/common/schemas/transformation.yml @@ -35,7 +35,7 @@ Description: description: A descriptive name for your transformation of what it does. AuthenticationIDs: - description: The authentications associated for the current transformation. + description: The authentications associated with the current transformation. type: array items: $ref: './common.yml#/authenticationID' diff --git a/specs/ingestion/paths/runs/events/events.yml b/specs/ingestion/paths/runs/events/events.yml index edb4bbc4578..ecd2ec27377 100644 --- a/specs/ingestion/paths/runs/events/events.yml +++ b/specs/ingestion/paths/runs/events/events.yml @@ -2,7 +2,7 @@ get: tags: - observability summary: List task run events - description: Retrieves a list of events for a task run, identified by it's ID. + description: Retrieves a list of events for a task run, identified by its ID. operationId: listEvents x-acl: - addObject diff --git a/specs/ingestion/spec.yml b/specs/ingestion/spec.yml index 7d31c26a170..594c9b3ec1b 100644 --- a/specs/ingestion/spec.yml +++ b/specs/ingestion/spec.yml @@ -38,14 +38,9 @@ info: Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. - The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, - correspond to anything in the Search API. It justs checks if they're formatted correctly. - Check the [Events](https://dashboard.algolia.com/events/health) health section, - whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking. - ## Version - The current version of the Insights API is version 1, as indicated by the `/1/` in each endpoint's URL. + The current version of the Ingestion API is version 1, as indicated by the `/1/` in each endpoint's URL. version: 1.0.0 components: diff --git a/specs/insights/spec.yml b/specs/insights/spec.yml index 74575729e5b..f9fd5face6c 100644 --- a/specs/insights/spec.yml +++ b/specs/insights/spec.yml @@ -10,7 +10,7 @@ info: ## Client libraries Use Algolia's API clients, libraries, and integrations to collect events from your UI and send them to the Insights API. - See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) + See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/). ## Base URLs @@ -45,7 +45,7 @@ info: Error responses have a `message` property with more information. The Insights API doesn't validate if the event parameters such as `indexName`, `objectIDs`, or `userToken`, - correspond to anything in the Search API. It justs checks if they're formatted correctly. + correspond to anything in the Search API. It just checks if they're formatted correctly. Check the [Events](https://dashboard.algolia.com/events/health) health section, whether your events can be used for Algolia features such as Analytics, or Dynamic Re-Ranking. @@ -79,7 +79,7 @@ tags: x-displayName: Events description: >- Events represent user interactions with your website or app. - They include details like the event's name, type, a timestamp or a user token. + They include details like the event's name, type, a timestamp, or a user token. - name: usertokens x-displayName: User tokens description: | diff --git a/specs/monitoring/common/parameters.yml b/specs/monitoring/common/parameters.yml index e5b97dfee00..5fcaad7f06b 100644 --- a/specs/monitoring/common/parameters.yml +++ b/specs/monitoring/common/parameters.yml @@ -3,7 +3,7 @@ Clusters: name: clusters in: path required: true - description: Subset of clusters, separated by comma. + description: Subset of clusters, separated by commas. schema: # The `correct` (?) schema should be type array/items string, # But the SDK generator expects a string, because it can't replace a list of strings in the URL.