Document flat routes for dock tool endpoints#390
Open
robzolkos wants to merge 2 commits intobasecamp:masterfrom
Open
Document flat routes for dock tool endpoints#390robzolkos wants to merge 2 commits intobasecamp:masterfrom
robzolkos wants to merge 2 commits intobasecamp:masterfrom
Conversation
Update Get, Update, and Trash tool endpoints to use flat routes as the primary path, noting bucket-scoped paths still work. Create remains bucket-scoped since it operates within a specific project.
Match the convention used by other sections: list bucket-scoped paths in a dedicated section at the bottom instead of inline notes per endpoint.
There was a problem hiding this comment.
Pull request overview
Updates the Tools API documentation to treat the flat dock tool routes as the primary/canonical endpoints while still acknowledging legacy project-scoped access.
Changes:
- Document
GET /dock/tools/:id.jsonas the primary “Get a tool” route (with legacy/buckets/:id/...noted). - Document
PUT /dock/tools/:id.jsonas the primary “Update a tool” route (with legacy/buckets/:id/...noted). - Document
DELETE /dock/tools/:id.jsonas the primary “Trash a tool” route (with legacy/buckets/:id/...noted).
Comments suppressed due to low confidence (3)
sections/tools.md:26
- The example response block is still tagged as
<!-- START GET /buckets/1/dock/tools/2.json -->/<!-- END GET /buckets/1/dock/tools/2.json -->, but the canonical endpoint in this section is nowGET /dock/tools/2.json. Please update the START/END tags to match the primary (flat) route, and optionally add a legacy tag/section for the project-scoped route if these comments are used for snippet generation.
```json
{
sections/tools.md:118
- This file now documents flat routes as canonical, but it introduces per-endpoint notes for the legacy
/buckets/...paths. Most other API docs in this repo group legacy bucket-prefixed endpoints under a dedicated "Legacy project-scoped routes" section (e.g., sections/boosts.md, sections/recordings.md), which is easier to scan and maintain. Consider using the same pattern here and listing the legacyPUT /buckets/1/dock/tools/2.jsonroute in that section instead of inline text.
**Required parameters**: `title` for the new name.
This endpoint will return `200 OK` with the updated JSON representation of the tool.
sections/tools.md:208
- This file now documents flat routes as canonical, but it introduces per-endpoint notes for the legacy
/buckets/...paths. Most other API docs in this repo group legacy bucket-prefixed endpoints under a dedicated "Legacy project-scoped routes" section (e.g., sections/boosts.md, sections/recordings.md), which is easier to scan and maintain. Consider using the same pattern here and listing the legacyDELETE /buckets/1/dock/tools/2.jsonroute in that section instead of inline text.
This endpoint will return `204 No Content` if successful.
###### Copy as cURL
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/dock/tools/:id.json) as the primary path/buckets/:id/dock/tools/:id.json) still workSee basecamp/bc3#9930