docs(search): document include_facets/include_histogram opt-in toggles#242
Open
steveatlc wants to merge 2 commits into
Open
docs(search): document include_facets/include_histogram opt-in toggles#242steveatlc wants to merge 2 commits into
steveatlc wants to merge 2 commits into
Conversation
The search API now accepts include_facets and include_histogram as optional boolean request body fields. Both default to false: callers that omit them receive an empty facets block and no histogram. Note the new defaults in the Query Console docs and update the REST API curl example to show how to opt in. Webapp behavior is unchanged because the console sends explicit true for both. Refs refractionPOINT/replay#442, refractionPOINT/web-app-frontend#3767 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Broken Links DetectedThe link checker found some issues: Please fix these broken links before merging. Full resultsSee the uploaded artifact for complete link check results. |
The link `[lc:asset:*](asset-tags.md)` resolved into 8-reference/ where no asset-tags.md exists; the canonical file lives at docs/2-sensors-deployment/asset-tags.md and is already referenced correctly later in the same page. Use the same relative path. Unblocks the docs link checker on PR #242. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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
include_facetsandinclude_histogram, on the Query Console REST API examples page. Both default tofalse; callers that omit them now get an emptyfacetsblock and no histogram.trueso users see how to opt in.Reflects backend change in replay#442 and the matching webapp change in web-app-frontend#3767 (both merged 2026-05-22).
Test plan
mkdocs build— no new warnings introduced (the pre-existing8-reference/story-tags.md → asset-tags.mdwarning is unrelated and present on master).site/4-data-queries/index.html— admonition + curl tab render correctly with both new fields visible.ResolveIncludeToggle:nil → false).🤖 Generated with Claude Code