Update search API response schema with highlight documentation#4059
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Update search API response schema with highlight documentation#4059mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
<mark><b>tags around matched query termspage,header,content,metadata(withtitle,breadcrumbs,icon,hash,openapi), andscoreNote
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
200response for/v1/search/{domain}changes from a top-level array to an object containingresults.Each result is now fully documented with
page,header, highlightedcontent(using<mark><b>tags), richermetadata(title,breadcrumbs,icon,hash,openapi), and a numeric relevancescore.Written by Cursor Bugbot for commit 0749bad. This will update automatically on new commits. Configure here.