Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(specs): no links across API specs #3643

Merged
merged 5 commits into from
Sep 2, 2024
Merged

fix(specs): no links across API specs #3643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c150eaa
fix(specs): no link
kai687 Sep 2, 2024
1f63664
fix: remove link here too
kai687 Sep 2, 2024
73fc675
fix swift
millotp Sep 2, 2024
9fa4184
Merge branch 'main' into fix/no-link
millotp Sep 2, 2024
39b1404
Merge branch 'main' into fix/no-link
millotp Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion scripts/cts/runCts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ export async function runCts(
): Promise<void> {
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,
Expand Down
2 changes: 1 addition & 1 deletion specs/insights/paths/deleteUserToken.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion specs/query-suggestions/paths/qsConfig.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 4 additions & 1 deletion website/docs/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading