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.

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

merged 5 commits into from
Sep 2, 2024

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Sep 2, 2024

🧭 What and Why

The "Delete QS config" endpoint had a link to the Search API's "Delete index" endpoint.
Those links aren't portable (e.g. they worked for the Docusauraus site, but don't work in the Algolia docs and likely won't work somewhere else). Therefore, it's better not to have links in the specs to other Algolia APIs.

Changes included:

  • Remove link in QS API description
  • Update contribution guide to avoid links across APIs

@algolia-bot
Copy link
Collaborator

algolia-bot commented Sep 2, 2024

✔️ Code generated!

Name Link
🪓 Triggered by 9f33a8b40795cf791c5f11c0555e662d79225fa1
🍃 Generated commit 9ec10c04f94a4d6ae0f2891182bb7aebe9c012b0
🌲 Generated branch generated/fix/no-link
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
javascript 1636
php 1536
csharp 1140
python 982
java 968
ruby 929
swift 779
go 571
kotlin 496

Copy link

github-actions bot commented Sep 2, 2024

@kai687 kai687 marked this pull request as ready for review September 2, 2024 11:11
@kai687 kai687 requested a review from a team as a code owner September 2, 2024 11:11
@kai687 kai687 requested review from morganleroi and Fluf22 September 2, 2024 11:11
Fluf22
Fluf22 previously approved these changes Sep 2, 2024
Copy link
Contributor

@Fluf22 Fluf22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@millotp millotp enabled auto-merge (squash) September 2, 2024 12:41
@millotp millotp merged commit e3af955 into main Sep 2, 2024
25 checks passed
@millotp millotp deleted the fix/no-link branch September 2, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants