Skip to content

Commit

Permalink
docs: hint at query REST controllers in dev guide (#20620)
Browse files Browse the repository at this point in the history
## Description

Adds a dedicated hint to Query REST controllers in the dev guide.

## Related issues

closes #20619
  • Loading branch information
tmetzke authored Jul 30, 2024
2 parents 35f5cc0 + 6e6f1de commit 5f3a869
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/rest-controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ You can extend an existing controller if there is one for your resource, e.g. th

1. (optional) Generate the data models locally before implementing controllers by running `mvn clean install -Dquickly` on the `zeebe/gateway-rest` module.
2. Consider the existing controllers for best practices around structuring your controller.
3. The controllers are Spring `RestController`s, marked as such by adding the appropriate Camunda annotation (refer to the other controllers).
3. The controllers are Spring `RestController`s, marked as such by adding the appropriate Camunda annotation (refer to the other controllers). There is a separate Camunda annotation for Query endpoint controllers as used by the `ProcessInstanceQueryController`.
4. Controllers should only take care of
1. Mapping and potentially validating user input.
2. Invoking the respective `Services` method to execute the desired action, e.g. `UserTaskServices::completeUserTask´ or `UserTaskServices::search`.
Expand Down

0 comments on commit 5f3a869

Please sign in to comment.