From 41d956c6331369246c46300745552a03657cbedb Mon Sep 17 00:00:00 2001 From: Mustapha Zorgati <15628173+mustaphazorgati@users.noreply.github.com> Date: Mon, 7 Dec 2020 17:38:30 +0100 Subject: [PATCH] TSK-1436: implemented further documentation rewording. --- .../src/docs/asciidoc/rest-api.adoc | 2 +- .../common/rest/QueryPagingParameter.java | 4 ++-- .../models/ReportRepresentationModel.java | 2 +- .../task/rest/TaskCommentController.java | 4 ++-- .../task/rest/TaskQueryFilterParameter.java | 20 ++++++++++--------- .../AttachmentSummaryRepresentationModel.java | 6 +++--- .../TaskCommentRepresentationModel.java | 6 +++--- .../TaskSummaryRepresentationModel.java | 2 +- ...rkbasketAccessItemRepresentationModel.java | 2 +- .../WorkbasketSummaryRepresentationModel.java | 2 +- 10 files changed, 26 insertions(+), 24 deletions(-) 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 b46100ab9..61d5ca01f 100644 --- a/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc +++ b/rest/taskana-rest-spring/src/docs/asciidoc/rest-api.adoc @@ -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 diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/QueryPagingParameter.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/QueryPagingParameter.java index 87588d8ee..20a8596d9 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/QueryPagingParameter.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/QueryPagingParameter.java @@ -12,11 +12,11 @@ import pro.taskana.common.rest.models.PageMetadata; public class QueryPagingParameter> implements QueryParameter> { - /** 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; diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/monitor/rest/models/ReportRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/monitor/rest/models/ReportRepresentationModel.java index 0e6ed00b1..f71937640 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/monitor/rest/models/ReportRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/monitor/rest/models/ReportRepresentationModel.java @@ -107,7 +107,7 @@ public class ReportRepresentationModel extends RepresentationModel *

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

The format is ISO-8601. - * - *

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

The format is ISO-8601. + * + *

This parameter can't be used together with 'due-from' or 'due-until'. + */ + private final Instant[] due; + + /** * Filter since a given due timestamp. * diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/AttachmentSummaryRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/AttachmentSummaryRepresentationModel.java index f660bce41..19b6bd63c 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/AttachmentSummaryRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/task/rest/models/AttachmentSummaryRepresentationModel.java @@ -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; 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 35dfe2d46..825d256ed 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 @@ -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() { 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 801a3b58f..f67d84cb6 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 @@ -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; diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketAccessItemRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketAccessItemRepresentationModel.java index f8c272f0a..812781ba2 100644 --- a/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketAccessItemRepresentationModel.java +++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/workbasket/rest/models/WorkbasketAccessItemRepresentationModel.java @@ -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; 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 6ba87b4aa..4629c7964 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 @@ -38,7 +38,7 @@ public class WorkbasketSummaryRepresentationModel * The first Org Level (the top one). * *

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;