diff --git a/history/taskana-simplehistory-rest-spring/src/docs/asciidoc/simplehistory-rest-api.adoc b/history/taskana-simplehistory-rest-spring/src/docs/asciidoc/simplehistory-rest-api.adoc index d3229f051..55c117778 100644 --- a/history/taskana-simplehistory-rest-spring/src/docs/asciidoc/simplehistory-rest-api.adoc +++ b/history/taskana-simplehistory-rest-spring/src/docs/asciidoc/simplehistory-rest-api.adoc @@ -3,7 +3,7 @@ == Overview This is the REST documentation for http://taskana.pro)[TASKANA]'s simplehistory REST endpoints. -For all Query Parameters:: whenever a parameter is an array type multiple values can be passed by declaring that parameter multiple times. +*For all Query Parameters:* whenever a parameter is an array type, several values can be passed by declaring that parameter multiple times. === Hypermedia Support @@ -12,8 +12,8 @@ Please have a look at example responses for each resource to determine the avail TASKANA uses the https://restfulapi.net/hateoas/)[HATEOAS] (Hypermedia as the Engine of Application State) REST constraint. Most of our resources contain a `_links` section which contains navigation links. -These navigation links not only help navigate through our REST API, they encapsulate API. -Using HATEOAS allows us to change some endpoints without breaking any frontend. +Besides, helping to navigate through our REST API, the navigation links also encapsulate the API. +Using HATEOAS allows us to change some endpoints without modifying your frontend. == History event diff --git a/history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryEventController.java b/history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryEventController.java index 78ff4775c..a5cc3146a 100644 --- a/history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryEventController.java +++ b/history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryEventController.java @@ -90,7 +90,7 @@ public class TaskHistoryEventController { * This endpoint retrieves a single Task History Event. * * @title Get a single Task History Event - * @param historyEventId the id of the requested Task History Event. + * @param historyEventId the Id of the requested Task History Event. * @return the requested Task History Event * @throws TaskanaHistoryEventNotFoundException If a Task History Event can't be found by the * provided historyEventId diff --git a/history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryQueryFilterParameter.java b/history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryQueryFilterParameter.java index 0d8c44d66..0f25c01e3 100644 --- a/history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryQueryFilterParameter.java +++ b/history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryQueryFilterParameter.java @@ -19,7 +19,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter { - /** Unique ID. */ + /** Unique Id. */ private String taskHistoryId; - /** The id of the business process. */ + /** The Id of the business process. */ private String businessProcessId; - /** The id of the parent business process. */ + /** The Id of the parent business process. */ private String parentBusinessProcessId; - /** The id of the task. */ + /** The Id of the task. */ private String taskId; /** The type of the event. */ private String eventType; @@ -25,7 +25,7 @@ public class TaskHistoryEventRepresentationModel *

The format is ISO-8601. */ private Instant created; - /** The id of the user. */ + /** The Id of the user. */ private String userId; /** Domain. */ private String domain; @@ -37,7 +37,7 @@ public class TaskHistoryEventRepresentationModel private String porType; /** The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, ...). */ private String porSystem; - /** The instance of the system, the referenced primary object resides in. */ + /** The instance of the system where the referenced primary object is located. */ private String porInstance; /** The value of the primary object reference. */ private String porValue; diff --git a/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc b/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc index 90397cde5..b46100ab9 100644 --- a/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc +++ b/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc @@ -3,15 +3,15 @@ == Overview This is the REST documentation for http://taskana.pro)[TASKANA] - the world's first open source solution for Enterprise Task Management. -For all Query Parameters:: whenever a parameter is an array type multiple values can be passed by declaring that parameter multiple times. +*For all Query Parameters:* whenever a parameter is an array type, several values can be passed by declaring that parameter multiple times. === Hypermedia Support NOTE: HATEOAS support is still in development. Please have a look at example responses for each resource to determine the available links. TASKANA uses the https://restfulapi.net/hateoas/)[HATEOAS] (Hypermedia as the Engine of Application State) REST constraint. Most of our resources contain a `_links` section which contains navigation links. -These navigation links not only help navigate through our REST API, they encapsulate API. -Using HATEOAS allows us to change some endpoints without breaking any frontend. +Besides, helping to navigate through our REST API, the navigation links also encapsulate the API. +Using HATEOAS allows us to change some endpoints without modifying your frontend. == Task Resource diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationController.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationController.java index 55c66e5c2..3700d102e 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationController.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationController.java @@ -97,7 +97,7 @@ public class ClassificationController { /** * This endpoint retrieves a single Classification. * - * @param classificationId the id of the requested Classification. + * @param classificationId the Id of the requested Classification. * @return the requested classification * @throws ClassificationNotFoundException if the requested classification is not found. * @title Get a single Classification @@ -158,14 +158,14 @@ public class ClassificationController { * This endpoint updates a Classification. * * @title Update a Classification - * @param classificationId the id of the Classification which should be updated. + * @param classificationId the Id of the Classification which should be updated. * @param resource the new Classification for the requested id. * @return the updated Classification * @throws NotAuthorizedException if the current user is not authorized to update a Classification * @throws ClassificationNotFoundException if the requested Classification is not found - * @throws ConcurrencyException if the requested Classification id has been modified in the + * @throws ConcurrencyException if the requested Classification Id has been modified in the * meantime by a different process. - * @throws InvalidArgumentException if the id in the path and in the request body does not match + * @throws InvalidArgumentException if the Id in the path and in the request body does not match */ @PutMapping(path = RestEndpoints.URL_CLASSIFICATIONS_ID) @Transactional(rollbackFor = Exception.class) @@ -203,7 +203,7 @@ public class ClassificationController { * This endpoint deletes a requested Classification if possible. * * @title Delete a Classification - * @param classificationId the requested Classification id which should be deleted + * @param classificationId the requested Classification Id which should be deleted * @return no content * @throws ClassificationNotFoundException if the requested Classification could not be found * @throws ClassificationInUseException if there are tasks existing referring to the requested diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationQueryFilterParameter.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationQueryFilterParameter.java index bab71db4e..ca1a824d0 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationQueryFilterParameter.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationQueryFilterParameter.java @@ -20,7 +20,7 @@ public class ClassificationQueryFilterParameter /** * Filter by the name of the classification. This results in a substring search. (% is appended to - * the beginning and end of the requested value). Further SQL "Like" wildcard characters will be + * the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will be * resolved correctly. */ @JsonProperty("name-like") @@ -40,7 +40,7 @@ public class ClassificationQueryFilterParameter /** * Filter by the value of the field custom1. This results in a substring search.. (% is appended - * to the beginning and end of the requested value). Further SQL "Like" wildcard characters will + * to the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will * be resolved correctly. */ @JsonProperty("custom-1-like") @@ -48,7 +48,7 @@ public class ClassificationQueryFilterParameter /** * Filter by the value of the field custom2. This results in a substring search.. (% is appended - * to the beginning and end of the requested value). Further SQL "Like" wildcard characters will + * to the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will * be resolved correctly. */ @JsonProperty("custom-2-like") @@ -56,7 +56,7 @@ public class ClassificationQueryFilterParameter /** * Filter by the value of the field custom3. This results in a substring search.. (% is appended - * to the beginning and end of the requested value). Further SQL "Like" wildcard characters will + * to the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will * be resolved correctly. */ @JsonProperty("custom-3-like") @@ -64,7 +64,7 @@ public class ClassificationQueryFilterParameter /** * Filter by the value of the field custom4. This results in a substring search.. (% is appended - * to the beginning and end of the requested value). Further SQL "Like" wildcard characters will + * to the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will * be resolved correctly. */ @JsonProperty("custom-4-like") @@ -72,7 +72,7 @@ public class ClassificationQueryFilterParameter /** * Filter by the value of the field custom5. This results in a substring search.. (% is appended - * to the beginning and end of the requested value). Further SQL "Like" wildcard characters will + * to the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will * be resolved correctly. */ @JsonProperty("custom-5-like") @@ -80,14 +80,14 @@ public class ClassificationQueryFilterParameter /** * Filter by the value of the field custom6. This results in a substring search.. (% is appended - * to the beginning and end of the requested value). Further SQL "Like" wildcard characters will + * to the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will * be resolved correctly. */ @JsonProperty("custom-6-like") private final String[] custom6Like; /** * Filter by the value of the field custom7. This results in a substring search.. (% is appended - * to the beginning and end of the requested value). Further SQL "Like" wildcard characters will + * to the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will * be resolved correctly. */ @JsonProperty("custom-7-like") @@ -95,7 +95,7 @@ public class ClassificationQueryFilterParameter /** * Filter by the value of the field custom8. This results in a substring search.. (% is appended - * to the beginning and end of the requested value). Further SQL "Like" wildcard characters will + * to the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will * be resolved correctly. */ @JsonProperty("custom-8-like") diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/models/ClassificationSummaryRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/models/ClassificationSummaryRepresentationModel.java index 8446ce9b9..44c43e107 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/models/ClassificationSummaryRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/models/ClassificationSummaryRepresentationModel.java @@ -12,13 +12,13 @@ public class ClassificationSummaryRepresentationModel /** Unique Id. */ @NotNull protected String classificationId; /** - * The key of the classification. This is typically an externally known code or abbreviation of - * the classification. + * The key of the Classification. This is typically an externally known code or abbreviation of + * the Classification. */ @NotNull protected String key; /** - * The logical name of the entry point, the task list application should redirect to work on a - * task of this classification. + * The logical name of the entry point. This is needed by the task list application to determine + * the redirect to work on a task of this Classification. */ protected String applicationEntryPoint; /** @@ -30,7 +30,7 @@ public class ClassificationSummaryRepresentationModel protected String domain; /** The name of the classification. */ @NotNull protected String name; - /** The id of the parent classification. Empty string ("") if this is a root classification. */ + /** The Id of the parent classification. Empty string ("") if this is a root classification. */ protected String parentId; /** The key of the parent classification. Empty string ("") if this is a root classification. */ protected String parentKey; diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/AccessIdController.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/AccessIdController.java index 5560a1dc9..8b0d6e8bd 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/AccessIdController.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/AccessIdController.java @@ -18,7 +18,7 @@ import pro.taskana.common.api.exceptions.NotAuthorizedException; import pro.taskana.common.rest.ldap.LdapClient; import pro.taskana.common.rest.models.AccessIdRepresentationModel; -/** Controller for access id validation. */ +/** Controller for Access Id validation. */ @RestController @EnableHypermediaSupport(type = HypermediaType.HAL) public class AccessIdController { @@ -35,12 +35,12 @@ public class AccessIdController { } /** - * This endpoint searches a provided access id in the configured ldap. + * This endpoint searches a provided access Id in the configured ldap. * * @title Search for Access Id (users and groups) * @param searchFor the Access Id which should be searched for. * @return a list of all found Access Ids - * @throws InvalidArgumentException if the provided search for access id is shorter than the + * @throws InvalidArgumentException if the provided search for Access Id is shorter than the * configured one. * @throws NotAuthorizedException if the current user is not ADMIN or BUSINESS_ADMIN. */ @@ -66,7 +66,7 @@ public class AccessIdController { * This endpoint retrieves all groups a given Access Id belongs to. * * @title Get groups for Access Id - * @param accessId the access id whose groups should be determined. + * @param accessId the Access Id whose groups should be determined. * @return a list of the group Access Ids the requested Access Id belongs to * @throws InvalidArgumentException if the requested Access Id does not exist or is not unique. * @throws NotAuthorizedException if the current user is not ADMIN or BUSINESS_ADMIN. diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/AccessIdRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/AccessIdRepresentationModel.java index 8baf4c148..5c9e91df0 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/AccessIdRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/AccessIdRepresentationModel.java @@ -3,7 +3,7 @@ package pro.taskana.common.rest.models; import org.springframework.hateoas.RepresentationModel; import org.springframework.lang.NonNull; -/** EntityModel for access id validation. */ +/** EntityModel for Access Id. */ public class AccessIdRepresentationModel extends RepresentationModel { /** The name of this Access Id. */ diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/TaskanaUserInfoRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/TaskanaUserInfoRepresentationModel.java index b4dc538ae..fc9400137 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/TaskanaUserInfoRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/TaskanaUserInfoRepresentationModel.java @@ -11,7 +11,7 @@ import pro.taskana.common.api.TaskanaRole; public class TaskanaUserInfoRepresentationModel extends RepresentationModel { - /** The user id of the current user. */ + /** The user Id of the current user. */ private String userId; /** All groups the current user is a member of. */ private List groupIds = new ArrayList<>(); diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskCommentController.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskCommentController.java index d671e709e..ed49a63fc 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskCommentController.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskCommentController.java @@ -56,12 +56,12 @@ public class TaskCommentController { * This endpoint fetches a Task Comment. * * @title Get a single Task Comment - * @param taskCommentId the id of the Task Comment + * @param taskCommentId the Id of the Task Comment * @return the Task Comment * @throws NotAuthorizedException if the user is not authorized for the requested Task Comment * @throws TaskNotFoundException TODO: this is never thrown * @throws TaskCommentNotFoundException if the requested Task Comment is not found - * @throws InvalidArgumentException if the requested id is null or empty + * @throws InvalidArgumentException if the requested Id is null or empty */ @GetMapping(path = RestEndpoints.URL_TASK_COMMENT) @Transactional(readOnly = true, rollbackFor = Exception.class) @@ -91,7 +91,7 @@ public class TaskCommentController { /** * This endpoint retrieves all Task Comments for a specific Task. Further filters can be applied. * - * @param taskId the id of the Task whose comments are requested + * @param taskId the Id of the Task whose comments are requested * @param sortBy Sort the result by a given field. Multiple sort values can be declared. When the * primary sort value is the same, the second one will be used. * @param order The order direction for each sort value. This value requires the use of 'sort-by'. @@ -101,7 +101,7 @@ public class TaskCommentController { * @return a list of Task Comments * @throws NotAuthorizedException If the current user has no authorization to retrieve a Task * Comment from a certain Task or is not authorized to access the Task. - * @throws TaskNotFoundException If the given task id in the Task Comment does not refer to an + * @throws TaskNotFoundException If the given Task Id in the Task Comment does not refer to an * existing Task * @throws InvalidArgumentException if some parameters were not supplied correctly * @title Get a list of all Task Comments for a specific Task @@ -139,13 +139,13 @@ public class TaskCommentController { * This endpoint deletes a given Task Comment. * * @title Delete a Task Comment - * @param taskCommentId the id of the Task Comment which should be deleted + * @param taskCommentId the Id of the Task Comment which should be deleted * @return no content, if everything went well. * @throws NotAuthorizedException if the current user is not authorized to delete a Task Comment - * @throws TaskNotFoundException If the given task id in the Task Comment does not refer to an + * @throws TaskNotFoundException If the given Task Id in the Task Comment does not refer to an * existing task. * @throws TaskCommentNotFoundException if the requested Task Comment does not exist - * @throws InvalidArgumentException if the requested Task Comment id is null or empty + * @throws InvalidArgumentException if the requested Task Comment Id is null or empty */ @DeleteMapping(path = RestEndpoints.URL_TASK_COMMENT) @Transactional(readOnly = true, rollbackFor = Exception.class) @@ -178,7 +178,7 @@ public class TaskCommentController { * @throws NotAuthorizedException if the current user does not have access to the Task Comment * @throws TaskNotFoundException if the referenced Task within the Task Comment does not exist * @throws TaskCommentNotFoundException if the requested Task Comment does not exist - * @throws InvalidArgumentException if the id in the path and in the request body does not match + * @throws InvalidArgumentException if the Id in the path and in the request body does not match * @throws ConcurrencyException if the requested Task Comment has been updated in the meantime by * a different process. */ @@ -221,11 +221,11 @@ public class TaskCommentController { * This endpoint creates a Task Comment. * * @title Create a new Task Comment - * @param taskId the id of the Task where a Task Comment should be created. + * @param taskId the Id of the Task where a Task Comment should be created. * @param taskCommentRepresentationModel the Task Comment to create. * @return the created Task Comment * @throws NotAuthorizedException if the current user is not authorized to create a Task Comment - * @throws InvalidArgumentException if the Task Comment id is null or empty + * @throws InvalidArgumentException if the Task Comment Id is null or empty * @throws TaskNotFoundException if the requested task does not exist */ @PostMapping(path = RestEndpoints.URL_TASK_COMMENTS) diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskController.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskController.java index 94ba5576f..df17cef85 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskController.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskController.java @@ -147,7 +147,7 @@ public class TaskController { /** * This endpoint retrieves a specific Task. * - * @param taskId the id of the requested Task + * @param taskId the Id of the requested Task * @return the requested Task * @throws TaskNotFoundException if the requested Task does not exist. * @throws NotAuthorizedException if the current user is not authorized to get the requested Task. @@ -171,7 +171,7 @@ public class TaskController { /** * This endpoint claims a Task if possible. * - * @param taskId the id of the Task which should be claimed + * @param taskId the Id of the Task which should be claimed * @param userName TODO: this is currently not used * @return the claimed Task * @throws TaskNotFoundException if the requested Task does not exist. @@ -238,7 +238,7 @@ public class TaskController { * This endpoint cancels the claim of an existing Task if it was claimed by the current user * before. * - * @param taskId the id of the requested Task. + * @param taskId the Id of the requested Task. * @return the unclaimed Task. * @throws TaskNotFoundException if the requested Task does not exist. * @throws InvalidStateException if the Task is already in an end state. @@ -268,7 +268,7 @@ public class TaskController { /** * This endpoint completes a Task. * - * @param taskId id of the requested Task to complete. + * @param taskId Id of the requested Task to complete. * @return the completed Task * @throws TaskNotFoundException if the requested Task does not exist. * @throws InvalidOwnerException if current user is not the owner of the Task or an administrator. @@ -298,7 +298,7 @@ public class TaskController { * This endpoint deletes a Task. * * @title Delete a Task - * @param taskId the id of the Task which should be deleted. + * @param taskId the Id of the Task which should be deleted. * @return the deleted Task. * @throws TaskNotFoundException if the requested Task does not exist. * @throws InvalidStateException TODO: this is never thrown @@ -356,8 +356,8 @@ public class TaskController { * This endpoint transfers a given Task to a given Workbasket, if possible. * * @title Transfer a Task to another Workbasket - * @param taskId the id of the Task which should be transferred - * @param workbasketId the id of the destination Workbasket + * @param taskId the Id of the Task which should be transferred + * @param workbasketId the Id of the destination Workbasket * @return the successfully transferred Task. * @throws TaskNotFoundException if the requested Task does not exist * @throws WorkbasketNotFoundException if the requested Workbasket does not exist @@ -384,7 +384,7 @@ public class TaskController { /** * This endpoint updates a requested Task. * - * @param taskId the id of the Task which should be updated + * @param taskId the Id of the Task which should be updated * @param taskRepresentationModel the new Task for the requested id. * @return the updated Task * @throws TaskNotFoundException if the requested Task does not exist. diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryFilterParameter.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryFilterParameter.java index bbd4f5725..084e75b31 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryFilterParameter.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryFilterParameter.java @@ -25,7 +25,7 @@ public class TaskQueryFilterParameter implements QueryParameter private final String[] name; /** * Filter by the name of the task. This results in a substring search.. (% is appended to the - * front and end of the requested value). Further SQL "Like" wildcard characters will be resolved + * front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved * correctly. */ @JsonProperty("name-like") @@ -52,7 +52,7 @@ public class TaskQueryFilterParameter implements QueryParameter private final String[] owner; /** * Filter by the owner of the task. This results in a substring search.. (% is appended to the - * front and end of the requested value). Further SQL "Like" wildcard characters will be resolved + * front and end of the requested value). Further SQL "LIKE" wildcard characters will be resolved * correctly. */ @JsonProperty("owner-like") diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/ObjectReferenceRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/ObjectReferenceRepresentationModel.java index 079a58b3c..ced808f8e 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/ObjectReferenceRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/ObjectReferenceRepresentationModel.java @@ -11,7 +11,7 @@ public class ObjectReferenceRepresentationModel private String company; /** The (kind of) system, the referenced primary object resides in (e.g. SAP, MySystem A, ...). */ private String system; - /** The instance of the system, the referenced primary object resides in. */ + /** The instance of the system where the referenced primary object is located. */ private String systemInstance; /** The type of the referenced primary object (contract, claim, policy, customer, ...). */ private String type; diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskCommentRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskCommentRepresentationModel.java index a1a2c31e0..35dfe2d46 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskCommentRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskCommentRepresentationModel.java @@ -9,9 +9,9 @@ import pro.taskana.task.api.models.TaskComment; public class TaskCommentRepresentationModel extends RepresentationModel { - /** Unique ID. */ + /** Unique Id. */ private String taskCommentId; - /** Task ID. Can identify the task to which the comment belongs. */ + /** Task Id. Can identify the task to which the comment belongs. */ private String taskId; /** The content of the comment. */ private String textField; diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskSummaryRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskSummaryRepresentationModel.java index cfa183aa7..801a3b58f 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskSummaryRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskSummaryRepresentationModel.java @@ -15,20 +15,20 @@ import pro.taskana.workbasket.rest.models.WorkbasketSummaryRepresentationModel; public class TaskSummaryRepresentationModel extends RepresentationModel { - /** Unique ID. */ + /** Unique Id. */ protected String taskId; /** - * External ID. Can be used to enforce idempotence at task creation. Can identify an external + * External Id. Can be used to enforce idempotence at task creation. Can identify an external * task. */ protected String externalId; /** The creation timestamp of the task in the system. */ protected Instant created; - /** The timestamp of the last claim-operation on the task. */ + /** The timestamp of the last claim-operation. */ protected Instant claimed; - /** The timestamp of the completion of the task. */ + /** The timestamp of the completion. */ protected Instant completed; - /** Timestamp of the last modification of the task. */ + /** The timestamp of the last modification. */ protected Instant modified; /** * Planned start of the task. The actual completion of the task should be between PLANNED and DUE. diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketAccessItemQueryFilterParameter.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketAccessItemQueryFilterParameter.java index 8b8f891bf..7d2ffa9e0 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketAccessItemQueryFilterParameter.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketAccessItemQueryFilterParameter.java @@ -16,7 +16,7 @@ public class WorkbasketAccessItemQueryFilterParameter /** * Filter by the key of the workbasket. This results in a substring search.. (% is appended to the - * beginning and end of the requested value). Further SQL "Like" wildcard characters will be + * beginning and end of the requested value). Further SQL "LIKE" wildcard characters will be * resolved correctly. */ @JsonProperty("workbasket-key-like") @@ -28,7 +28,7 @@ public class WorkbasketAccessItemQueryFilterParameter /** * Filter by the name of the access id. This results in a substring search.. (% is appended to the - * beginning and end of the requested value). Further SQL "Like" wildcard characters will be + * beginning and end of the requested value). Further SQL "LIKE" wildcard characters will be * resolved correctly. */ @JsonProperty("access-id-like") diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketController.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketController.java index 00e0406e5..3bc789876 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketController.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketController.java @@ -116,7 +116,7 @@ public class WorkbasketController { * This endpoint retrieves a single Workbasket. * * @title Get a single Workbasket - * @param workbasketId the id of the requested Workbasket + * @param workbasketId the Id of the requested Workbasket * @return the requested Workbasket * @throws WorkbasketNotFoundException if the requested Workbasket is not found * @throws NotAuthorizedException if the current user has no permissions to access the requested @@ -151,10 +151,10 @@ public class WorkbasketController { * * * @title Delete a Workbasket - * @param workbasketId the id of the Workbasket which should be deleted + * @param workbasketId the Id of the Workbasket which should be deleted * @return the deleted Workbasket * @throws NotAuthorizedException if the current user is not authorized to delete this Workbasket. - * @throws InvalidArgumentException if the requested Workbasket id is null or empty + * @throws InvalidArgumentException if the requested Workbasket Id is null or empty * @throws WorkbasketNotFoundException if the requested Workbasket is not found * @throws WorkbasketInUseException if the Workbasket contains tasks. */ @@ -222,10 +222,10 @@ public class WorkbasketController { * This endpoint updates a given Workbasket. * * @title Update a Workbasket - * @param workbasketId the id of the Workbasket which should be updated. + * @param workbasketId the Id of the Workbasket which should be updated. * @param workbasketRepresentationModel the new Workbasket for the requested id. * @return the updated Workbasket - * @throws InvalidWorkbasketException if the requested id and the id within the new Workbasket do + * @throws InvalidWorkbasketException if the requested Id and the Id within the new Workbasket do * not match. * @throws WorkbasketNotFoundException if the requested workbasket does not * @throws NotAuthorizedException if the current user is not authorized to update the Workbasket @@ -265,8 +265,8 @@ public class WorkbasketController { * This endpoint retrieves all Workbasket Access Items for a given Workbasket. * * @title Get all Workbasket Access Items - * @param workbasketId the id of the requested workbasket. - * @return the access items for the requested workbasket. + * @param workbasketId the Id of the requested Workbasket. + * @return the access items for the requested Workbasket. * @throws NotAuthorizedException if the current user is not member of role BUSINESS_ADMIN or * ADMIN * @throws WorkbasketNotFoundException if the requested Workbasket does not exist. @@ -298,7 +298,7 @@ public class WorkbasketController { * ones. * * @title Set all Workbasket Access Items - * @param workbasketId the id of the Workbasket whose Workbasket Access Items will be replaced + * @param workbasketId the Id of the Workbasket whose Workbasket Access Items will be replaced * @param workbasketAccessItemRepModels the new Workbasket Access Items. * @return the new Workbasket Access Items for the requested Workbasket * @throws NotAuthorizedException if the current user is not member of role BUSINESS_ADMIN or @@ -346,7 +346,7 @@ public class WorkbasketController { * This endpoint retrieves all Distribution Targets for a requested Workbasket. * * @title Get all Distribution Targets for a Workbasket - * @param workbasketId the id of the Workbasket whose Distribution Targets will be retrieved + * @param workbasketId the Id of the Workbasket whose Distribution Targets will be retrieved * @return the Distribution Targets for the requested Workbasket * @throws WorkbasketNotFoundException if the requested Workbasket does not exist. * @throws NotAuthorizedException if the current user has no read permission for the specified @@ -418,7 +418,7 @@ public class WorkbasketController { * This endpoint removes all Distribution Target references for a provided Workbasket. * * @title Remove a Workbasket as Distribution Target - * @param targetWorkbasketId the id of the requested Workbasket. + * @param targetWorkbasketId the Id of the requested Workbasket. * @return no content * @throws WorkbasketNotFoundException if the requested Workbasket does not exist. * @throws NotAuthorizedException if the requested user ist not ADMIN or BUSINESS_ADMIN. diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketQueryFilterParameter.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketQueryFilterParameter.java index a85029ed5..a3263905d 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketQueryFilterParameter.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketQueryFilterParameter.java @@ -16,7 +16,7 @@ public class WorkbasketQueryFilterParameter implements QueryParameter { - /** Unique ID. */ + /** Unique Id. */ private String accessItemId; - /** The workbasket id. */ + /** The workbasket Id. */ private String workbasketId; /** The access id. This could be either a userid or a full qualified group id. */ private String accessId; diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketSummaryRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketSummaryRepresentationModel.java index 3ea30067c..6ba87b4aa 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketSummaryRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketSummaryRepresentationModel.java @@ -9,7 +9,7 @@ import pro.taskana.workbasket.api.models.WorkbasketSummary; public class WorkbasketSummaryRepresentationModel extends RepresentationModel { - /** Unique ID. */ + /** Unique Id. */ protected String workbasketId; /** the professional key for the workbasket. */ protected String key;