From e3af9554ebe220d9e9b6b28ce1de704c0c0ad08b Mon Sep 17 00:00:00 2001 From: Kai Welke Date: Mon, 2 Sep 2024 16:28:41 +0200 Subject: [PATCH] fix(specs): no links across API specs (#3643) Co-authored-by: Pierre Millot --- scripts/cts/runCts.ts | 3 ++- specs/insights/paths/deleteUserToken.yml | 2 +- specs/query-suggestions/paths/qsConfig.yml | 2 +- website/docs/docs.md | 5 ++++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/scripts/cts/runCts.ts b/scripts/cts/runCts.ts index d2ccb9481f..678745891a 100644 --- a/scripts/cts/runCts.ts +++ b/scripts/cts/runCts.ts @@ -128,7 +128,8 @@ export async function runCts( ): Promise { const withBenchmarkServer = suites.benchmark && (clients.includes('search') || clients.includes('all') || languages.includes('swift')); - const withClientServer = suites.client && (clients.includes('search') || clients.includes('all')); + const withClientServer = + suites.client && (clients.includes('search') || clients.includes('all') || process.platform === 'darwin'); // the macos swift CI also runs the clients tests const closeTestServer = await startTestServer({ ...suites, benchmark: withBenchmarkServer, diff --git a/specs/insights/paths/deleteUserToken.yml b/specs/insights/paths/deleteUserToken.yml index 713663a787..a4a8d44b3f 100644 --- a/specs/insights/paths/deleteUserToken.yml +++ b/specs/insights/paths/deleteUserToken.yml @@ -6,7 +6,7 @@ delete: description: | Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. - To delete a personalization user profile, see [Delete a user profile](/specs/personalization#tag/profiles/operation/deleteUserProfile). + To delete a personalization user profile, see `Delete a user profile` in the Personalization API. parameters: - name: userToken in: path diff --git a/specs/query-suggestions/paths/qsConfig.yml b/specs/query-suggestions/paths/qsConfig.yml index b6df6eaf06..1ba08da13d 100644 --- a/specs/query-suggestions/paths/qsConfig.yml +++ b/specs/query-suggestions/paths/qsConfig.yml @@ -68,7 +68,7 @@ delete: Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. - To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation. + To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation. parameters: - $ref: '../common/parameters.yml#/IndexName' responses: diff --git a/website/docs/docs.md b/website/docs/docs.md index 96540de070..368a696529 100644 --- a/website/docs/docs.md +++ b/website/docs/docs.md @@ -28,7 +28,10 @@ To make using the specs in these contexts easier, follow these guidelines: - Don't use headings, except in [API descriptions](#api-descriptions). - Prefer using `externalDocs` objects over inline Markdown links. - Use inline Markdown links judiciously. - Don't link to readily searchable information, such as internet RFCs or Wikipedia. + They don't render in CLI/code environments. + + - Don't link to readily searchable information, such as internet RFCs or Wikipedia. + - Don't link to endpoints of other Algolia APIs. These links won't be portable. ### Markdown in long descriptions