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

TSK-1436: implemented further documentation rewording.

This commit is contained in:
Mustapha Zorgati 2020-12-07 17:38:30 +01:00
parent fff26d6a08
commit 41d956c633
10 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -40,7 +40,7 @@ include::{snippets}/TaskCommentControllerRestDocTest/deleteTaskCommentDocTest/au
include::{snippets}/ClassificationControllerRestDocTest/createClassificationDocTest/auto-section.adoc[]
include::{snippets}/ClassificationControllerRestDocTest/getClassificationDocTest/auto-section.adoc[]
include::{snippets}/ClassificationControllerRestDocTest/getAllClassificationsDocTest/auto-section.adoc[]
include::{snippets}/ClassificationControllerRestDocTest/updateClzassificationDocTest/auto-section.adoc[]
include::{snippets}/ClassificationControllerRestDocTest/updateClassificationDocTest/auto-section.adoc[]
include::{snippets}/ClassificationControllerRestDocTest/deleteClassificationDocTest/auto-section.adoc[]
== Workbasket Resource

4
rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/QueryPagingParameter.java
View File

@ -12,11 +12,11 @@ import pro.taskana.common.rest.models.PageMetadata;
public class QueryPagingParameter<T, Q extends BaseQuery<T, ?>>
implements QueryParameter<Q, List<T>> {
/** Request a specific page. Requires the definition of the page-size. */
/** Request a specific page. Requires the definition of the 'page-size'. */
@Min(1)
private final Integer page;
/** Defines the page size for each page. This requires that a specific page is requested. */
/** Defines the size for each page. This requires a specific requested 'page'. */
@JsonProperty("page-size")
@Min(1)
private final Integer pageSize;

2
rest/taskana-rest-spring/src/main/java/pro/taskana/monitor/rest/models/ReportRepresentationModel.java
View File

@ -107,7 +107,7 @@ public class ReportRepresentationModel extends RepresentationModel<ReportReprese
private final String name;
/** Date of the report creation. */
private final Instant date;
/** Column-headers of the report. */
/** Column headers of the report. */
private final String[] header;
/** Descriptions for the rows of the report. */
private final String[] rowDesc;

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

@ -53,7 +53,7 @@ public class TaskCommentController {
}
/**
* This endpoint fetches a Task Comment.
* This endpoint retrieves a Task Comment.
*
* @title Get a single Task Comment
* @param taskCommentId the Id of the Task Comment
@ -96,7 +96,7 @@ public class TaskCommentController {
* 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'.
* The amount of sort-by and order declarations have to match. Alternatively the value can be
* omitted. If done so the default sort order (ASCENDING) will be applied to every sort-by
* omitted. In this case the default sort order (ASCENDING) will be applied to every sort-by
* value.
* @return a list of Task Comments
* @throws NotAuthorizedException If the current user has no authorization to retrieve a Task

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

@ -81,15 +81,6 @@ public class TaskQueryFilterParameter implements QueryParameter<TaskQuery, Void>
* <p>This parameter can't be used together with 'planned-from' or 'planned-until'.
*/
private final Instant[] planned;
/**
* Filter by a due time interval. The length of the provided values has to be even. To create an
* open interval you can either use 'null' or just leave it blank.
*
* <p>The format is ISO-8601.
*
* <p>This parameter can't be used together with 'due-from' or 'due-until'.
*/
private final Instant[] due;
/**
* Filter since a given planned timestamp.
@ -111,6 +102,17 @@ public class TaskQueryFilterParameter implements QueryParameter<TaskQuery, Void>
@JsonProperty("planned-until")
private final Instant plannedUntil;
/**
* Filter by a due time interval. The length of the provided values has to be even. To create an
* open interval you can either use 'null' or just leave it blank.
*
* <p>The format is ISO-8601.
*
* <p>This parameter can't be used together with 'due-from' or 'due-until'.
*/
private final Instant[] due;
/**
* Filter since a given due timestamp.
*

6
rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/AttachmentSummaryRepresentationModel.java
View File

@ -14,11 +14,11 @@ public class AttachmentSummaryRepresentationModel
protected String attachmentId;
/** the referenced task id. */
protected String taskId;
/** The creation timestamp of the attachment in the system. */
/** The creation timestamp in the system. */
protected Instant created;
/** Timestamp of the last modification of the attachment. */
/** The timestamp of the last modification. */
protected Instant modified;
/** Timestamp of the entry of the attachment. */
/** The timestamp of the entry date. */
protected Instant received;
/** The classification of this attachment. */
protected ClassificationSummaryRepresentationModel classificationSummary;

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

@ -11,15 +11,15 @@ public class TaskCommentRepresentationModel
/** Unique Id. */
private String taskCommentId;
/** Task Id. Can identify the task to which the comment belongs. */
/** Task Id. Can identify the task the comment belongs to. */
private String taskId;
/** The content of the comment. */
private String textField;
/** The creator of the task comment. */
private String creator;
/** The creation timestamp of the task comment in the system. */
/** The creation timestamp in the system. */
private Instant created;
/** Timestamp of the last modification of the task comment. */
/** Timestamp of the last task comment modification. */
private Instant modified;
public String getTaskCommentId() {

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

@ -22,7 +22,7 @@ public class TaskSummaryRepresentationModel
* task.
*/
protected String externalId;
/** The creation timestamp of the task in the system. */
/** The creation timestamp in the system. */
protected Instant created;
/** The timestamp of the last claim-operation. */
protected Instant claimed;

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

@ -12,7 +12,7 @@ public class WorkbasketAccessItemRepresentationModel
private String accessItemId;
/** The workbasket Id. */
private String workbasketId;
/** The access id. This could be either a userid or a full qualified group id. */
/** The Access Id. This could be either a user Id or a full qualified group Id. */
private String accessId;
/** The workbasket key. */
private String workbasketKey;

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

@ -38,7 +38,7 @@ public class WorkbasketSummaryRepresentationModel
* The first Org Level (the top one).
*
* <p>The Org Level is an association with an org hierarchy level in the organization. The values
* are used for monitoring and statistical purposes and should reflect the responsibility of the
* are used for monitoring and statistical purposes and should reflect who is responsible of the
* tasks in the workbasket.
*/
protected String orgLevel1;