Skip to content

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Sep 26, 2025

🧭 What and Why

This PR updates links inside specs to match the new docs.
URL structure for API references have slightly changed.

I also updated some descriptions for clarity.

🎟 JIRA Ticket:

Changes included:

  • Replace all API > API links with absolute URLs that match the new docs site.
  • Clarify summary and description of patchCrawler endpoint -- it didn't match what the endpoint actually does
  • Swap "Upsert" with "Add or update" for the getCompositionRule endpoint. It's longer but easier to understand from people without database knowledge.
  • Remove "Related guide:" from the externalDocs.description fields. We will render this docs side.
  • Remove trailing slashes from URLs. On Mintlify that leads to one less redirect.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Sep 26, 2025

✔️ Code generated!

Name Link
🪓 Triggered by 97008c2eb38243564f75b18db7d171cdbdf6c7a7
🍃 Generated commit e957b785ff85815c59424d7f50f346bb0a56847f
🌲 Generated branch generated/fix/update-links
📊 Benchmark results

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

Language Req/s
go 1746
javascript 1587
php 1431
csharp 1291
python 1150
java 999
ruby 811
swift 705
scala 23

@kai687 kai687 marked this pull request as ready for review September 26, 2025 13:00
@kai687 kai687 requested a review from a team as a code owner September 26, 2025 13:00
@kai687 kai687 requested review from Fluf22 and shortcuts September 26, 2025 13:00
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

sorry I missed this PR, it looks great thanks !

@millotp millotp enabled auto-merge (squash) October 6, 2025 12:55
@millotp millotp merged commit b8b8629 into main Oct 6, 2025
53 of 56 checks passed
@millotp millotp deleted the fix/update-links branch October 6, 2025 13:25
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.

3 participants