Commit c68cbff33549c182794c555a4e0c0ffce4145ce2

Authored by Volodymyr Babak
1 parent 8e0b76fb

Added more API swagger docs for edge controller

... ... @@ -79,6 +79,8 @@ public class EdgeController extends BaseController {
79 79 public static final String EDGE_SECURITY_CHECK = "If the user has the authority of 'Tenant Administrator', the server checks that the edge is owned by the same tenant. " +
80 80 "If the user has the authority of 'Customer User', the server checks that the edge is assigned to the same customer.";
81 81
  82 + @ApiOperation(value = "Is edges support enabled (isEdgesSupportEnabled)",
  83 + notes = "Returns 'true' if edges support enabled on server, 'false' - otherwise.")
82 84 @PreAuthorize("hasAnyAuthority('SYS_ADMIN', 'TENANT_ADMIN', 'CUSTOMER_USER')")
83 85 @RequestMapping(value = "/edges/enabled", method = RequestMethod.GET)
84 86 @ResponseBody
... ... @@ -397,7 +399,7 @@ public class EdgeController extends BaseController {
397 399
398 400 @ApiOperation(value = "Set root rule chain for provided edge (setRootRuleChain)",
399 401 notes = "Change root rule chain of the edge from the current to the new provided rule chain. \n" +
400   - "This operation will send an notification to remote edge service to update root rule chain remotely.")
  402 + "This operation will send a notification to remote edge service to update root rule chain remotely.")
401 403 @PreAuthorize("hasAnyAuthority('TENANT_ADMIN')")
402 404 @RequestMapping(value = "/edge/{edgeId}/{ruleChainId}/root", method = RequestMethod.POST)
403 405 @ResponseBody
... ... @@ -592,7 +594,8 @@ public class EdgeController extends BaseController {
592 594 }
593 595
594 596 @ApiOperation(value = "Sync edge (syncEdge)",
595   - notes = "Starts synchronization process between edge and cloud - all entities that are assigned to particular edge are going to be send to remote edge service.")
  597 + notes = "Starts synchronization process between edge and cloud. \n" +
  598 + "All entities that are assigned to particular edge are going to be send to remote edge service.")
596 599 @PreAuthorize("hasAuthority('TENANT_ADMIN')")
597 600 @RequestMapping(value = "/edge/sync/{edgeId}", method = RequestMethod.POST)
598 601 public void syncEdge(@PathVariable("edgeId") String strEdgeId) throws ThingsboardException {
... ... @@ -613,7 +616,7 @@ public class EdgeController extends BaseController {
613 616 }
614 617
615 618 @ApiOperation(value = "Find missing rule chains (findMissingToRelatedRuleChains)",
616   - notes = "Returns list of rule chains IDs that are not assigned to particular edge, but these rule chains are present in the already assigned rule chains to edge")
  619 + notes = "Returns list of rule chains ids that are not assigned to particular edge, but these rule chains are present in the already assigned rule chains to edge")
617 620 @PreAuthorize("hasAuthority('TENANT_ADMIN')")
618 621 @RequestMapping(value = "/edge/missingToRelatedRuleChains/{edgeId}", method = RequestMethod.GET)
619 622 @ResponseBody
... ...