nosu
/
taskana
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

TSK-1436: integraded wording feedback from team

This commit is contained in:
Mustapha Zorgati 2020-12-04 19:22:59 +01:00
parent f93cf9ee57
commit 727b3ba3b5
22 changed files with 99 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
history/taskana-simplehistory-rest-spring/src/docs/asciidoc/simplehistory-rest-api.adoc
View File

@ -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

2
history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryEventController.java
View File

@ -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

28
history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryQueryFilterParameter.java
View File

@ -19,7 +19,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the event type of the Task History Event. This results in a substring search.. (% is
* appended to the beginning and end of the requested value). Further SQL "Like" wildcard
* appended to the beginning and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
@JsonProperty("event-type-like")
@ -31,7 +31,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the user id of the Task History Event. This results in a substring search.. (% is
* appended to the beginning and end of the requested value). Further SQL "Like" wildcard
* appended to the beginning and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
@JsonProperty("user-id-like")
@ -54,7 +54,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the task id of the Task History Event. This results in a substring search.. (% is
* appended to the beginning and end of the requested value). Further SQL "Like" wildcard
* appended to the beginning and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
@JsonProperty("task-id-like")
@ -66,7 +66,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the business process id of the Task History Event. This results into a substring
* search. (% is appended to the beginning and end of the requested value). Further SQL "Like"
* search. (% is appended to the beginning and end of the requested value). Further SQL "LIKE"
* wildcard characters will be resolved correctly.
*/
@JsonProperty("business-process-id-like")
@ -90,7 +90,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the task classification key of the Task History Event. This results into a substring
* search. (% is appended to the beginning and end of the requested value). Further SQL "Like"
* search. (% is appended to the beginning and end of the requested value). Further SQL "LIKE"
* wildcard characters will be resolved correctly.
*/
@JsonProperty("task-classification-key-like")
@ -130,7 +130,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the workbasket key of the Task History Event. This results in a substring search.. (%
* is appended to the beginning and end of the requested value). Further SQL "Like" wildcard
* is appended to the beginning and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
@JsonProperty("workbasket-key-like")
@ -146,7 +146,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the company of the primary object reference of the Task History Event. This results
* into a substring search. (% is appended to the beginning and end of the requested value).
* Further SQL "Like" wildcard characters will be resolved correctly.
* Further SQL "LIKE" wildcard characters will be resolved correctly.
*/
@JsonProperty("por-company-like")
private final String[] porCompanyLike;
@ -161,7 +161,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the system of the primary object reference of the Task History Event. This results
* into a substring search. (% is appended to the beginning and end of the requested value).
* Further SQL "Like" wildcard characters will be resolved correctly.
* Further SQL "LIKE" wildcard characters will be resolved correctly.
*/
@JsonProperty("por-system-like")
private final String[] porSystemLike;
@ -176,7 +176,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the system instance of the primary object reference of the Task History Event. This
* results into a substring search. (% is appended to the beginning and end of the requested
* value). Further SQL "Like" wildcard characters will be resolved correctly.
* value). Further SQL "LIKE" wildcard characters will be resolved correctly.
*/
@JsonProperty("por-instance-like")
private final String[] porInstanceLike;
@ -191,7 +191,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the value of the primary object reference of the Task History Event. This results
* into a substring search. (% is appended to the beginning and end of the requested value).
* Further SQL "Like" wildcard characters will be resolved correctly.
* Further SQL "LIKE" wildcard characters will be resolved correctly.
*/
@JsonProperty("por-value-like")
private final String[] porValueLike;
@ -202,7 +202,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the value of the field custom1. This is an exact match. This results into a substring
* search. (% is appended to the beginning and end of the requested value). Further SQL "Like"
* search. (% is appended to the beginning and end of the requested value). Further SQL "LIKE"
* wildcard characters will be resolved correctly.
*/
@JsonProperty("custom-1-like")
@ -214,7 +214,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the value of the field custom2. This is an exact match. This results into a substring
* search. (% is appended to the beginning and end of the requested value). Further SQL "Like"
* search. (% is appended to the beginning and end of the requested value). Further SQL "LIKE"
* wildcard characters will be resolved correctly.
*/
@JsonProperty("custom-2-like")
@ -226,7 +226,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the value of the field custom3. This is an exact match. This results into a substring
* search. (% is appended to the beginning and end of the requested value). Further SQL "Like"
* search. (% is appended to the beginning and end of the requested value). Further SQL "LIKE"
* wildcard characters will be resolved correctly.
*/
@JsonProperty("custom-3-like")
@ -238,7 +238,7 @@ public class TaskHistoryQueryFilterParameter implements QueryParameter<TaskHisto
/**
* Filter by the value of the field custom4. This is an exact match. This results into a substring
* search. (% is appended to the beginning and end of the requested value). Further SQL "Like"
* search. (% is appended to the beginning and end of the requested value). Further SQL "LIKE"
* wildcard characters will be resolved correctly.
*/
@JsonProperty("custom-4-like")

12
history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/models/TaskHistoryEventRepresentationModel.java
View File

@ -9,13 +9,13 @@ import pro.taskana.spi.history.api.events.task.TaskHistoryEvent;
public class TaskHistoryEventRepresentationModel
extends RepresentationModel<TaskHistoryEventRepresentationModel> {
/** 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
* <p>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;

6
rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc
View File

@ -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

10
rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationController.java
View File

@ -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

18
rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/ClassificationQueryFilterParameter.java
View File

@ -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")

10
rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/models/ClassificationSummaryRepresentationModel.java
View File

@ -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;

8
rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/AccessIdController.java
View File

@ -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.

2
rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/AccessIdRepresentationModel.java
View File

@ -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<AccessIdRepresentationModel> {
/** The name of this Access Id. */

2
rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/models/TaskanaUserInfoRepresentationModel.java
View File

@ -11,7 +11,7 @@ import pro.taskana.common.api.TaskanaRole;
public class TaskanaUserInfoRepresentationModel
extends RepresentationModel<TaskanaUserInfoRepresentationModel> {
/** 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<String> groupIds = new ArrayList<>();

20
rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskCommentController.java
View File

@ -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)

16
rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskController.java
View File

@ -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.

4
rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/TaskQueryFilterParameter.java
View File

@ -25,7 +25,7 @@ public class TaskQueryFilterParameter implements QueryParameter<TaskQuery, Void>
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<TaskQuery, Void>
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")

2
rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/ObjectReferenceRepresentationModel.java
View File

@ -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;

4
rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskCommentRepresentationModel.java
View File

@ -9,9 +9,9 @@ import pro.taskana.task.api.models.TaskComment;
public class TaskCommentRepresentationModel
extends RepresentationModel<TaskCommentRepresentationModel> {
/** 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;

10
rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/TaskSummaryRepresentationModel.java
View File

@ -15,20 +15,20 @@ import pro.taskana.workbasket.rest.models.WorkbasketSummaryRepresentationModel;
public class TaskSummaryRepresentationModel
extends RepresentationModel<TaskSummaryRepresentationModel> {
/** 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.

4
rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketAccessItemQueryFilterParameter.java
View File

@ -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")

20
rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketController.java
View File

@ -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 {
* </ul>
*
* @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.

8
rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/WorkbasketQueryFilterParameter.java
View File

@ -16,7 +16,7 @@ public class WorkbasketQueryFilterParameter implements QueryParameter<Workbasket
/**
* Filter by the name 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("name-like")
@ -27,7 +27,7 @@ public class WorkbasketQueryFilterParameter implements QueryParameter<Workbasket
/**
* 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("key-like")
@ -38,7 +38,7 @@ public class WorkbasketQueryFilterParameter implements QueryParameter<Workbasket
/**
* Filter by the owner 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
* the beginning and end of the requested value). Further SQL "LIKE" wildcard characters will be
* resolved correctly.
*/
@JsonProperty("owner-like")
@ -46,7 +46,7 @@ public class WorkbasketQueryFilterParameter implements QueryParameter<Workbasket
/**
* Filter by the description of the workbasket. This results in a substring search.. (% is
* appended to the beginning and end of the requested value). Further SQL "Like" wildcard
* appended to the beginning and end of the requested value). Further SQL "LIKE" wildcard
* characters will be resolved correctly.
*/
@JsonProperty("description-like")

4
rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketAccessItemRepresentationModel.java
View File

@ -8,9 +8,9 @@ import pro.taskana.workbasket.api.models.WorkbasketAccessItem;
public class WorkbasketAccessItemRepresentationModel
extends RepresentationModel<WorkbasketAccessItemRepresentationModel> {
/** 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;

2
rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketSummaryRepresentationModel.java
View File

@ -9,7 +9,7 @@ import pro.taskana.workbasket.api.models.WorkbasketSummary;
public class WorkbasketSummaryRepresentationModel
extends RepresentationModel<WorkbasketSummaryRepresentationModel> {
/** Unique ID. */
/** Unique Id. */
protected String workbasketId;
/** the professional key for the workbasket. */
protected String key;