Skip to content

docs: update comments in Route method to clarify path structure #5

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.

Sign up for GitHub

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

Merged
pikann merged 1 commit into from
May 18, 2026
Merged

docs: update comments in Route method to clarify path structure #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ type routeKey struct {
// Route registers a handler for the given HTTP method and path.
// Paths are relative to the plugin's base URL:
//
// /api/v1/plugins/{pluginId}/projects/:projectId/{path}
// /api/v1/plugins/{pluginId}/{path}
//
// Project-scoped routes should include /projects/:projectId in the path
// (e.g. "/projects/:projectId/tasks/:taskId/items").
// Path parameters are available via [Request.PathParam].
func (c *Context) Route(method, path string, handler RouteHandler) {
c.routes[routeKey{strings.ToUpper(method), path}] = handler
Expand Down
Loading