docs(specs): Review OpenAPI Search API (index operations)

[gazconroy]

🧭 What and Why

This is one of several PRs addressing the Search API.

This PR reviews just the index operations of the Search API.

Questions and notes

operationIndex

• Original content says “ You can't move a source index that has replicas.” but that appears not to be true. I can carry out a move operation on an index with replicas. It won’t rename the original but, instead, creates an empty index with the destination name. Should this be stated?

listIndices

• The page parameter requires a hitsPerPage parameter to make any sense/return sensible results. This was missing in the original OAS, I’ve added it but is the default of 100 correct?

getSettings

• In the response, allowCompressionOfIntegerArray notes say “If true, the engine applies a better compression ratio. This is recommended for arrays containing non-negative integers. When enabled, the compressed arrays may be reordered.”

  What’s the user benefit in compressing arrays? Is there any performance impact?

  In the final sentence does this mean that the engine might reorder the array? Could this pose issues?

• In the response, what's the difference between facetOrdering and facets?

🎟 JIRA Ticket: DOC-1107

Changes included:

Changes to summary, description and examples

🧪 Test

[netlify]

✅ Deploy Preview for api-clients-automation ready!

Name	Link
🔨 Latest commit	4485662
🔍 Latest deploy log	https://app.netlify.com/sites/api-clients-automation/deploys/64ad3a5c1440be0008ba65cf
😎 Deploy Preview	https://deploy-preview-1696--api-clients-automation.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[algolia-bot]

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

[kai687]

Good for final review by the team.