Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the documentation about the /{db}/_explain endpoint #53

Open
pgj opened this issue Jun 7, 2024 · 1 comment
Open

Update the documentation about the /{db}/_explain endpoint #53

pgj opened this issue Jun 7, 2024 · 1 comment

Comments

@pgj
Copy link
Contributor

pgj commented Jun 7, 2024

Please note that the /{db}/_explain endpoint gained some extensions a couple of months ago to aid users in understanding the index selection logic better. This has been documented by Apache CouchDB and it should be added to the IBM Cloud documentation as well:

https://docs.couchdb.org/en/latest/api/database/find.html#index-selection

Glynn wrote a nice blog entry about the whole feature:

https://blog.cloudant.com/2024/01/17/Explaining-Explain.html

@pgj
Copy link
Contributor Author

pgj commented Jun 10, 2024

@ricellis noted that the API documentation was updated: https://cloud.ibm.com/apidocs/cloudant#postexplain-response — due to that, this ticket should be more about adding a section on this topic to the collection of "How to" documents. Otherwise it might go unnoticed for the customers.

@pgj pgj changed the title Update the documentation of the /{db}/_explain endpoint Update the documentation about the /{db}/_explain endpoint Jun 10, 2024
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

No branches or pull requests

1 participant