Skip to content

Update search API response schema with highlight documentation#4059

Open
mintlify[bot] wants to merge 1 commit intomainfrom
search-highlight-1772776006
Open

Update search API response schema with highlight documentation#4059
mintlify[bot] wants to merge 1 commit intomainfrom
search-highlight-1772776006

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Mar 6, 2026

Summary

  • Updated the search API response schema to accurately reflect the actual response structure
  • Added documentation for the new exact-match highlighting feature that returns windowed snippets with <mark><b> tags around matched query terms
  • Added detailed field descriptions including page, header, content, metadata (with title, breadcrumbs, icon, hash, openapi), and score

Note

Low Risk
Spec-only change in discovery-openapi.json, with no runtime logic touched; primary risk is breaking generated clients/consumers that relied on the previous (incorrect) schema.

Overview
Updates the Search API response contract in the OpenAPI spec. The 200 response for /v1/search/{domain} changes from a top-level array to an object containing results.

Each result is now fully documented with page, header, highlighted content (using <mark><b> tags), richer metadata (title, breadcrumbs, icon, hash, openapi), and a numeric relevance score.

Written by Cursor Bugbot for commit 0749bad. This will update automatically on new commits. Configure here.

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.

0 participants