[DOCS-14522] [Server] Explicitly document the cursor option of the listIndexes command Created: 01/Jun/21 Updated: 30/Oct/23 Resolved: 29/Mar/22 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | manual, Server |
| Affects Version/s: | None |
| Fix Version/s: | Server_Docs_20231030 |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | Spencer Brown | Assignee: | Sarah Olson |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Participants: | |
| Days since reply: | 1 year, 45 weeks, 1 day ago |
| Epic Link: | DOCSP-11701 |
| Description |
DescriptionThe listIndexes command documentation is missing the documentation for cursor option, which allows the user to specify a batch size for the results. Please explicitly add "cursor" as an option for this command, with the description that it takes a document
where N is the desired batch size. Please also amend the output description for "listIndexes.cursor", mentioning to use the getMore command to retrieve additional results if the cursor is non-zero. Scope of changesImpact to Other DocsMVP (Work and Date)Resources (Scope or Design Docs, Invision, etc.) |
| Comments |
| Comment by Githook User [ 29/Mar/22 ] |
|
Author: {'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}Message: Docs 14522 v4.0 (#879)
Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local> |
| Comment by Githook User [ 29/Mar/22 ] |
|
Author: {'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}Message: Docs 14522 v4.2 (#877)
Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local>
Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local> |
| Comment by Githook User [ 29/Mar/22 ] |
|
Author: {'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}Message:
Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local> " |
| Comment by Githook User [ 29/Mar/22 ] |
|
Author: {'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}Message:
Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local> Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local> |
| Comment by Githook User [ 29/Mar/22 ] |
|
Author: {'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}Message:
Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local> Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local> |
| Comment by Githook User [ 25/Mar/22 ] |
|
Author: {'name': 'Sarah Olson', 'email': '98367156+sarah-olson-mongodb@users.noreply.github.com', 'username': 'sarah-olson-mongodb'}Message:
Co-authored-by: Sarah Olson <sarah.olson@Sarahs-MacBook-Pro.local> |
| Comment by Sarah Olson [ 10/Mar/22 ] |
|
Hi spencer.brown! I'm pretty new to the Server documentation team and as part of my onboarding and learning process the team assigned me this relatively old Jira that you filed. Would you mind having a quick look and let me know if I addressed your concerns? PR: https://github.com/10gen/docs-mongodb-internal/pull/771 Updates staging link: https://docs-mongodbcom-staging.corp.mongodb.com/docs/docsworker-xlarge/DOCS-14522/reference/command/listIndexes/
|