Skip to content

Commit

Permalink
Adds an example share request as javadoc comment
Browse files Browse the repository at this point in the history
Signed-off-by: Darshit Chanpura <[email protected]>
  • Loading branch information
DarshitChanpura committed Jan 2, 2025
1 parent 515920d commit 074d29a
Showing 1 changed file with 15 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,21 @@
/**
* Registers REST API to handle detector/forecaster sharing.
* Here is an example request:
*
* POST /_plugins/_anomaly_detection/detectors
* {
* "config_id" : <document_id>,
* "share_with" : {
* "AD_FULL_ACCESS": {
* "users": ["x"],
* "roles": ["y"],
* "backend_roles": ["z"]
* }
* }
* }
* example response:
* {
* "message": "Resource <document_id> shared successfully with <share_with>"
* }
*/
public class RestShareConfigAction extends BaseRestHandler {
public RestShareConfigAction() {}
Expand Down

0 comments on commit 074d29a

Please sign in to comment.