Document repositioning to-do lists#415
Conversation
There was a problem hiding this comment.
Pull request overview
Documents the API endpoint for repositioning a to-do list within its to-do set, including the flat route semantics and the legacy project-scoped form.
Changes:
- Adds a new “Reposition a to-do list” endpoint section documenting
PUT /todosets/todolists/:id/position.jsonand its204 No Contentbehavior. - Clarifies that
positionis 1-based and counts only incomplete to-do lists. - Adds the legacy project-scoped route mapping to the new section.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7385114cbb
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
You can reorder a to-do list within its to-do set. This documents the existing API endpoint for it.
What the docs now say
PUT /todosets/todolists/2/position.jsonwith a top-levelposition(greater than or equal to one). A successful call returns204 No Content.positionof1moves the list above all other incomplete lists.PUT /buckets/1/todosets/todolists/2/position.jsonremains available as a legacy form.Documentation-only; no API changes.
Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.