[DOC-14757]: Feedback on bleveMaxClauseCount – Couchbase Docs

[RayOffiah]

Description

This pull request updates the documentation concerning bleveMaxClauseCount. It clarifies its default behavior, emphasizes query optimization, and introduces enhancements for retrieving cluster-level options:

• Added a "Getting Cluster Level Options" section, along with CURL examples, to fts-cluster-options.adoc.
• Improved documentation for bleveMaxResultWindow and maxReplicasAllowed with reusable steps.
• Added a new partial for ease of cluster-level option retrieval.

---

Preview URL:
https://preview.docs-test.couchbase.com/docs-server-DOC-14757--8.0--Feedback-on-bleveMaxClauseCount--Couchbase-Docs

You will need the Docs Team credentials on Confluence.

[Copilot]

🟡 Changes recommended

Several documentation passages contain incomplete, fragmented, or inaccurate descriptions.

4 open findings

• Remove the duplicated space after the comma · New
• Clarify that a larger result window increases resource usage · New
• Make the lowercase “by” clause a standalone command introduction · New
• Refer to the response as a JSON object, not a string · New

What changed in this PR

Updates Full Text Search cluster-option documentation with retrieval guidance and clearer configuration details.

Changes:

• Adds reusable cluster-option retrieval instructions.
• Documents the /api/conciseOptions response.
• Clarifies query optimization and selected option guidance.

File	Description
modules/​fts/​partials/​get-cluster-level-options.adoc	Adds reusable retrieval command.
modules/​fts/​pages/​fts-cluster-options.adoc	Adds retrieval section and response example.
modules/​fts/​pages/​fts-advanced-settings-maxReplicasAllowed.adoc	Includes retrieval guidance.
modules/​fts/​pages/​fts-advanced-settings-bleveMaxResultWindow.adoc	Revises explanation and includes retrieval guidance.
modules/​fts/​pages/​fts-advanced-settings-bleveMaxClauseCount.adoc	Clarifies query guidance and includes retrieval instructions.

🧠 Review effort: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

🟡 Changes recommended

The new reusable command transmits cluster credentials over unencrypted HTTP.

1 open finding

• Example sends cluster credentials over unencrypted HTTP · New

4 resolved since last review

• Refer to the response as a JSON object, not a string
• Make the lowercase “by” clause a standalone command introduction
• Clarify that a larger result window increases resource usage
• Remove the duplicated space after the comma

🧠 Review effort: Balanced

[Copilot]

🔵 Needs a closer look

The retrieval endpoint lacks a documented public contract, and the sample contradicts the stated default clause count.

0 open findings

1 resolved since last review

• Example sends cluster credentials over unencrypted HTTP

Previously missed (2)

In code that hasn't changed since last review

Correct bleveMaxClauseCount default in example

modules/​fts/​pages/​fts-cluster-options.adoc:41

This sample shows bleveMaxClauseCount as 10000, while the linked settings page states that its default is 1024. Because this standalone section does not first configure an override, the example should show 1024 (or explicitly explain that it comes from a modified cluster) so users checking the default do not receive contradictory guidance.

Document or replace unsupported conciseOptions endpoint

modules/​fts/​partials/​get-cluster-level-options.adoc:8

The Search Service REST inventory documents GET /api/managerOptions (modules/rest-api/partials/rest-search-service-table.adoc:253-261), but contains no /api/conciseOptions contract. Introducing this undocumented endpoint makes the retrieval instructions dependent on an API whose supported versions and response contract are unclear. Please either use the supported retrieval endpoint and update the sample response, or add the corresponding REST API documentation/version requirements for /api/conciseOptions.

🧠 Review effort: Balanced

[Pallavi-Janardhan]

LGTM

[sarahlwelton]

@RayOffiah , I thought we were going to make the team check in about the missing API option before doing this. I'm not sure that conciseOptions is an endpoint on the API and I'm concerned this is hallucinated.