" + + "This is the REST documentation for [TASKANA](http://taskana.pro) - the " + + "world’s first open source solution for Enterprise Task Management." + + "
" + + ""
+ + "**For all Query Parameters:**
Whenever a parameter is an array type,"
+ + " several values can be passed by declaring that parameter multiple times."
+ + "
" + + "Whenever a parameter is a complex type, the attributes of the value-object" + + " can be passed as a json. For example, a complex parameter with the name " + + "\"complex-query-param\" and attributes \"attribute1\" and \"attribute2\" " + + "would be specified in the following way:complex-query-param={\"attribute1\"" + + ":\"value1\",\"attribute2\":\"value2\"}" + + "
" + + "" + + "Whenever a parameter is a value-less type (e.g owner-is-null and " + + "current-user) it is expected to be defined without a value, i.e., it should" + + " be specified as ?parameter and not ?parameter= or ?parameter=someValue" + + "
" + + "" + + "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 [HATEOAS](https://restfulapi.net/hateoas/) (Hypermedia" + + " as the Engine of Application State) REST constraint. Most of our resources" + + " contain a _links section which contains navigation links. 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." + + "
" + + "" + + "In order to support multilingual websites, TASKANA uses error codes to " + + "define which error occurred. Additionally, an optional set of message " + + "variables, containing some technical information, is added, so that the " + + "website can describe the error with all details." + + "
" + + "| Status Code | " + + "Key | " + + "Message Variables | " + + "
|---|---|---|
| **400 BAD_REQUEST** | " + + "CLASSIFICATION_SERVICE_LEVEL_MALFORMED | " + + "serviceLevel, classificationKey, domain | " + + "
| **400 BAD_REQUEST** | " + + "CUSTOM_HOLIDAY_WRONG_FORMAT | " + + "customHoliday | " + + "
| **400 BAD_REQUEST** | " + + "DOMAIN_NOT_FOUND | " + + "domain | " + + "
| **400 BAD_REQUEST** | " + + "INVALID_ARGUMENT | " + + "" + + " |
| **400 BAD_REQUEST** | " + + "QUERY_PARAMETER_MALFORMED | " + + "malformedQueryParameters | " + + "
| **400 BAD_REQUEST** | " + + "TASK_INVALID_CALLBACK_STATE | " + + "taskId, taskCallbackState, requiredCallbackStates | " + + "
| **400 BAD_REQUEST** | " + + "TASK_INVALID_OWNER | " + + "taskId, currentUserId | " + + "
| **400 BAD_REQUEST** | " + + "TASK_INVALID_STATE | " + + "taskId, taskState, requiredTaskStates | " + + "
| **403 FORBIDDEN** | " + + "NOT_AUTHORIZED | " + + "roles, currentUserId | " + + "
| **403 FORBIDDEN** | " + + "NOT_AUTHORIZED_ON_TASK_COMMENT | " + + "currentUserId, taskCommentId | " + + "
| **403 FORBIDDEN** | " + + "NOT_AUTHORIZED_ON_WORKBASKET_WITH_ID | " + + "currentUserId, workbasketId, requiredPermissions | " + + "
| **403 FORBIDDEN** | " + + "NOT_AUTHORIZED_ON_WORKBASKET_WITH_KEY_AND_DOMAIN | " + + "currentUserId, workbasketKey, domain, requiredPermissions | " + + "
| **404 NOT_FOUND** | " + + "CLASSIFICATION_WITH_ID_NOT_FOUND | " + + "classificationId | " + + "
| **404 NOT_FOUND** | " + + "CLASSIFICATION_WITH_KEY_NOT_FOUND | " + + "classificationKey, domain | " + + "
| **404 NOT_FOUND** | " + + "TASK_COMMENT_NOT_FOUND | " + + "taskCommentId | " + + "
| **404 NOT_FOUND** | " + + "TASK_NOT_FOUND | " + + "taskId | " + + "
| **404 NOT_FOUND** | " + + "USER_NOT_FOUND | " + + "userId | " + + "
| **404 NOT_FOUND** | " + + "WORKBASKET_WITH_ID_NOT_FOUND | " + + "workbasketId | " + + "
| **404 NOT_FOUND** | " + + "WORKBASKET_WITH_KEY_NOT_FOUND | " + + "workbasketKey, domain | " + + "
| **409 CONFLICT** | " + + "ATTACHMENT_ALREADY_EXISTS | " + + "attachmentId, taskId | " + + "
| **409 CONFLICT** | " + + "CLASSIFICATION_ALREADY_EXISTS | " + + "classificationKey, domain | " + + "
| **409 CONFLICT** | " + + "ENTITY_NOT_UP_TO_DATE | " + + "entityId | " + + "
| **409 CONFLICT** | " + + "TASK_ALREADY_EXISTS | " + + "externalTaskId | " + + "
| **409 CONFLICT** | " + + "USER_ALREADY_EXISTS | " + + "userID | " + + "
| **409 CONFLICT** | " + + "WORKBASKET_ACCESS_ITEM_ALREADY_EXISTS | " + + "accessId, workbasketId | " + + "
| **409 CONFLICT** | " + + "WORKBASKET_ALREADY_EXISTS | " + + "workbasketKey, domain | " + + "
| **409 CONFLICT** | " + + "WORKBASKET_MARKED_FOR_DELETION | " + + "workbasketId | " + + "
| **413 PAYLOAD_TOO_LARGE** | " + + "PAYLOAD_TOO_LARGE | " + + "" + + " |
| **423 LOCKED** | " + + "CLASSIFICATION_IN_USE | " + + "classificationKey, domain | " + + "
| **423 LOCKED** | " + + "WORKBASKET_IN_USE | " + + "workbasketId | " + + "
| **500 INTERNAL_SERVER_ERROR** | " + + "CONNECTION_AUTOCOMMIT_FAILED | " + + "" + + " |
| **500 INTERNAL_SERVER_ERROR** | " + + "CONNECTION_NOT_SET | " + + "" + + " |
| **500 INTERNAL_SERVER_ERROR** | " + + "CRITICAL_SYSTEM_ERROR | " + + "" + + " |
| **500 INTERNAL_SERVER_ERROR** | " + + "DATABASE_UNSUPPORTED | " + + "databaseProductName | " + + "
| **500 INTERNAL_SERVER_ERROR** | " + + "UNKNOWN_ERROR | " + + "" + + " |
| Key | " + + "Type | " + + "
|---|---|
| accessId | " + + "String | " + + "
| attachmentId | " + + "String | " + + "
| classificationId | " + + "String | " + + "
| classificationKey | " + + "String | " + + "
| currentUserId | " + + "String | " + + "
| customHoliday | " + + "String | " + + "
| databaseProductName | " + + "String | " + + "
| domain | " + + "String | " + + "
| externalTaskId | " + + "String | " + + "
| historyEventId | " + + "String | " + + "
| malformedQueryParameters | " + + "MalformedQueryParameter[] | " + + "
| requiredCallbackStates | " + + "CallbackState[] | " + + "
| requiredPermissions | " + + "WorkbasketPermission[] | " + + "
| requiredTaskStates | " + + "TaskState[] | " + + "
| roles | " + + "TaskanaRole[] | " + + "
| taskCallbackState | " + + "CallbackState | " + + "
| taskCommentId | " + + "String | " + + "
| taskId | " + + "String | " + + "
| taskState | " + + "TaskState | " + + "
| workbasketId | " + + "String | " + + "
| workbasketKey | " + + "String | " + + "
The format is ISO-8601. */ + @Schema( + name = "created", + description = + "The creation timestamp of the classification in the system.
The format is ISO-8601.") private Instant created; /** * The timestamp of the last modification. * *
The format is ISO-8601. */ + @Schema( + name = "modified", + description = "The timestamp of the last modification.
The format is ISO-8601."
+ )
private Instant modified;
/** The description of the classification. */
+ @Schema(name = "description", description = "The description of the classification.")
private String description;
public Boolean getIsValidInDomain() {
diff --git a/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/models/ClassificationSummaryPagedRepresentationModel.java b/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/models/ClassificationSummaryPagedRepresentationModel.java
index 5dd36f520..32c7fe74a 100644
--- a/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/models/ClassificationSummaryPagedRepresentationModel.java
+++ b/rest/taskana-rest-spring/src/main/java/pro/taskana/classification/rest/models/ClassificationSummaryPagedRepresentationModel.java
@@ -1,6 +1,7 @@
package pro.taskana.classification.rest.models;
import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;
import java.beans.ConstructorProperties;
import java.util.Collection;
@@ -17,6 +18,7 @@ public class ClassificationSummaryPagedRepresentationModel
}
/** the embedded classifications. */
+ @Schema(name = "classifications", description = "the embedded classifications.")
@Override
@JsonProperty("classifications")
public @NotNull Collection This is stated according to ISO 8601.
*/
- @NotNull protected String serviceLevel;
+ @Schema(
+ name = "serviceLevel",
+ description =
+ "The service level of the classification. This is stated according to ISO 8601.")
+ @NotNull
+ protected String serviceLevel;
/** The type of classification. Types can be configured in the file 'taskana.properties'. */
+ @Schema(
+ name = "type",
+ description =
+ "The type of classification. Types can be configured in the file 'taskana.properties'.")
protected String type;
/** A custom property with name "1". */
+ @Schema(name = "custom1", description = "A custom property with name \"1\".")
protected String custom1;
/** A custom property with name "2". */
+ @Schema(name = "custom2", description = "A custom property with name \"2\".")
protected String custom2;
/** A custom property with name "3". */
+ @Schema(name = "custom3", description = "A custom property with name \"3\".")
protected String custom3;
/** A custom property with name "4". */
+ @Schema(name = "custom4", description = "A custom property with name \"4\".")
protected String custom4;
/** A custom property with name "5". */
+ @Schema(name = "custom5", description = "A custom property with name \"5\".")
protected String custom5;
/** A custom property with name "6". */
+ @Schema(name = "custom6", description = "A custom property with name \"6\".")
protected String custom6;
/** A custom property with name "7". */
+ @Schema(name = "custom7", description = "A custom property with name \"7\".")
protected String custom7;
/** A custom property with name "8". */
+ @Schema(name = "custom8", description = "A custom property with name \"8\".")
protected String custom8;
public String getClassificationId() {
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 61cfd52a1..990522ab4 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
@@ -1,7 +1,13 @@
package pro.taskana.common.rest;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.hateoas.MediaTypes;
import org.springframework.hateoas.config.EnableHypermediaSupport;
import org.springframework.hateoas.config.EnableHypermediaSupport.HypermediaType;
import org.springframework.http.ResponseEntity;
@@ -39,6 +45,25 @@ public class AccessIdController {
* @throws NotAuthorizedException if the current user is not ADMIN or BUSINESS_ADMIN.
* @title Search for Access Id (users and groups)
*/
+ @Operation(
+ summary = "Search for Access Id (users and groups)",
+ description = "This endpoint searches a provided access Id in the configured ldap.",
+ parameters = {
+ @Parameter(
+ name = "search-for",
+ description = "the Access Id which should be searched for.",
+ example = "max",
+ required = true)
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "a list of all found Access Ids",
+ content =
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = AccessIdRepresentationModel[].class)))
+ })
@GetMapping(path = RestEndpoints.URL_ACCESS_ID)
public ResponseEntity Each Row represents a Workbasket. Each "
+ + "Column Header represents a Time Interval.",
+ parameters = {
+ @Parameter(
+ name = "task-timestamp",
+ description = "Determine which Task Timestamp should be used for comparison"),
+ @Parameter(
+ name = "state",
+ examples = {
+ @ExampleObject(value = "READY"),
+ @ExampleObject(value = "CLAIMED"),
+ @ExampleObject(value = "COMPLETED")
+ })
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "The computed Report",
+ content =
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = ReportRepresentationModel.class))),
+ })
@GetMapping(path = RestEndpoints.URL_MONITOR_WORKBASKET_REPORT)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity Each Row represents a "
+ + "Workbasket. Each Column Header represents a priority range.",
+ parameters = {
+ @Parameter(
+ name = "workbasket-type",
+ description = "Determine the WorkbasketTypes to include in the report",
+ example = "GROUP"),
+ @Parameter(name = "columnHeader", description = "The column headers for the report")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "The computed Report",
+ content =
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = ReportRepresentationModel.class)))
+ })
@GetMapping(path = RestEndpoints.URL_MONITOR_WORKBASKET_PRIORITY_REPORT)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity Each Row represents a "
+ + "Classification category. Each Column Header represents a Time Interval.",
+ parameters = {
+ @Parameter(
+ name = "task-timestamp",
+ description = "Determine which Task Timestamp should be used for comparison")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "The computed Report",
+ content =
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = ReportRepresentationModel.class)))
+ })
@GetMapping(path = RestEndpoints.URL_MONITOR_CLASSIFICATION_CATEGORY_REPORT)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity Each Row represents a Classification."
+ + " Each Column Header represents a Time Interval.",
+ parameters = {
+ @Parameter(
+ name = "task-timestamp",
+ description = "Determine which Task Timestamp should be used for comparison")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "The computed Report",
+ content =
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = ReportRepresentationModel.class)))
+ })
@GetMapping(path = RestEndpoints.URL_MONITOR_CLASSIFICATION_REPORT)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity Each Foldable Row represents"
+ + " a Classification and can be expanded to show the Classification of Attachments."
+ + " Each Column Header represents a Time Interval.",
+ parameters = {
+ @Parameter(
+ name = "task-timestamp",
+ description = "Determine which Task Timestamp should be used for comparison")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "The computed Report",
+ content =
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = ReportRepresentationModel.class)))
+ })
@GetMapping(path = RestEndpoints.URL_MONITOR_DETAILED_CLASSIFICATION_REPORT)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity Each Row represents a value "
+ + "of the requested Task Custom Field. Each Column Header represents a Time "
+ + "Interval.",
+ parameters = {
+ @Parameter(
+ name = "custom-field",
+ description = "The Task Custom Field whose values are of interest",
+ example = "CUSTOM_14",
+ required = true),
+ @Parameter(
+ name = "task-timestamp",
+ description = "Determine which Task Timestamp should be used for comparison")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "The computed Report",
+ content =
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = ReportRepresentationModel.class)))
+ })
@GetMapping(path = RestEndpoints.URL_MONITOR_TASK_CUSTOM_FIELD_VALUE_REPORT)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity Each Row represents a Workbasket. "
+ + "Each Column Header represents a Task State.",
+ parameters = {
+ @Parameter(
+ name = "domain",
+ description = "Filter the report values by domains",
+ required = false),
+ @Parameter(
+ name = "state",
+ description = "Filter the report values by Task states",
+ required = false),
+ @Parameter(
+ name = "workbasket-id",
+ description = "Filter the report values by Workbasket Ids",
+ required = false),
+ @Parameter(
+ name = "priority-minimum",
+ description = "Filter the report values by a minimum priority",
+ required = false)
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "The computed Report",
+ content =
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = ReportRepresentationModel.class)))
+ })
@GetMapping(path = RestEndpoints.URL_MONITOR_TASK_STATUS_REPORT)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity Each Foldable Row represents a "
+ + "TaskTimestamp and can be expanded to display the four organization levels of the "
+ + "corresponding Workbasket. Each Column Header represents a TimeInterval.",
+ parameters = {
+ @Parameter(
+ name = "task-timestamp",
+ description = "Filter by the Task Timestamp of the task")
+ },
+ responses = {
+ @ApiResponse(
+ responseCode = "200",
+ description = "The computed Report",
+ content =
+ @Content(
+ mediaType = MediaTypes.HAL_JSON_VALUE,
+ schema = @Schema(implementation = ReportRepresentationModel.class)))
+ })
@GetMapping(path = RestEndpoints.URL_MONITOR_TIMESTAMP_REPORT)
@Transactional(readOnly = true, rollbackFor = Exception.class)
public ResponseEntity This parameter can't be used together with "
+ + "'custom-int-1-within'.")
@JsonProperty("custom-int-1-from")
private final Integer customInt1From;
/** Exclude values from a lower bound of the field customInt1 of the Task. */
+ @Schema(
+ name = "custom-int-1-from-not",
+ description = "Exclude values from a lower bound of the field customInt1 of the Task.")
@JsonProperty("custom-int-1-from-not")
private final Integer customInt1FromNot;
/**
@@ -46,24 +323,45 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-1-within'.")
@JsonProperty("custom-int-1-to")
private final Integer customInt1To;
/** Exclude values to an upper bound of the field customInt1 of the Task. */
+ @Schema(
+ name = "custom-int-1-to-not",
+ description = "Exclude values to an upper bound of the field customInt1 of the Task.")
@JsonProperty("custom-int-1-to-not")
private final Integer customInt1ToNot;
/** Filter by the value of the field customInt2 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-2",
+ description =
+ "Filter by the value of the field customInt2 of the Task. This is an exact match.")
@JsonProperty("custom-int-2")
private final Integer[] customInt2In;
/** Exclude values of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-not",
+ description = "Exclude values of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-not")
private final Integer[] customInt2NotIn;
/** Filter by the range of value of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-within",
+ description = "Filter by the range of value of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-within")
private final Integer[] customInt2Within;
/** Exclude range of values of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-not-within",
+ description = "Exclude range of values of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-not-within")
private final Integer[] customInt2NotWithin;
/**
@@ -71,9 +369,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-2-within'.")
@JsonProperty("custom-int-2-from")
private final Integer customInt2From;
/** Exclude values from a lower bound of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-from-not",
+ description = "Exclude values from a lower bound of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-from-not")
private final Integer customInt2FromNot;
/**
@@ -81,22 +387,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-2-within'.")
@JsonProperty("custom-int-2-to")
private final Integer customInt2To;
/** Exclude values to an upper bound of the field customInt2 of the Task. */
+ @Schema(
+ name = "custom-int-2-to-not",
+ description = "Exclude values to an upper bound of the field customInt2 of the Task.")
@JsonProperty("custom-int-2-to-not")
private final Integer customInt2ToNot;
/** Filter by the value of the field customInt3 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-3",
+ description =
+ "Filter by the value of the field customInt3 of the Task. This is an exact match.")
@JsonProperty("custom-int-3")
private final Integer[] customInt3In;
/** Exclude values of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-not",
+ description = "Exclude values of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-not")
private final Integer[] customInt3NotIn;
/** Filter by the range of value of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-within",
+ description = "Filter by the range of value of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-within")
private final Integer[] customInt3Within;
/** Exclude range of values of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-not-within",
+ description = "Exclude range of values of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-not-within")
private final Integer[] customInt3NotWithin;
/**
@@ -104,9 +431,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-3-within'.")
@JsonProperty("custom-int-3-from")
private final Integer customInt3From;
/** Exclude values from a lower bound of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-from-not",
+ description = "Exclude values from a lower bound of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-from-not")
private final Integer customInt3FromNot;
/**
@@ -114,22 +449,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-3-within'.")
@JsonProperty("custom-int-3-to")
private final Integer customInt3To;
/** Exclude values to an upper bound of the field customInt3 of the Task. */
+ @Schema(
+ name = "custom-int-3-to-not",
+ description = "Exclude values to an upper bound of the field customInt3 of the Task.")
@JsonProperty("custom-int-3-to-not")
private final Integer customInt3ToNot;
/** Filter by the value of the field customInt4 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-4",
+ description =
+ "Filter by the value of the field customInt4 of the Task. This is an exact match.")
@JsonProperty("custom-int-4")
private final Integer[] customInt4In;
/** Exclude values of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-not",
+ description = "Exclude values of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-not")
private final Integer[] customInt4NotIn;
/** Filter by the range of value of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-within",
+ description = "Filter by the range of value of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-within")
private final Integer[] customInt4Within;
/** Exclude range of values of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-not-within",
+ description = "Exclude range of values of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-not-within")
private final Integer[] customInt4NotWithin;
/**
@@ -137,9 +493,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-4-within'.")
@JsonProperty("custom-int-4-from")
private final Integer customInt4From;
/** Exclude values from a lower bound of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-from-not",
+ description = "Exclude values from a lower bound of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-from-not")
private final Integer customInt4FromNot;
/**
@@ -147,22 +511,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-4-within'.")
@JsonProperty("custom-int-4-to")
private final Integer customInt4To;
/** Exclude values to an upper bound of the field customInt4 of the Task. */
+ @Schema(
+ name = "custom-int-4-to-not",
+ description = "Exclude values to an upper bound of the field customInt4 of the Task.")
@JsonProperty("custom-int-4-to-not")
private final Integer customInt4ToNot;
/** Filter by the value of the field customInt5 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-5",
+ description =
+ "Filter by the value of the field customInt5 of the Task. This is an exact match.")
@JsonProperty("custom-int-5")
private final Integer[] customInt5In;
/** Exclude values of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-not",
+ description = "Exclude values of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-not")
private final Integer[] customInt5NotIn;
/** Filter by the range of value of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-within",
+ description = "Filter by the range of value of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-within")
private final Integer[] customInt5Within;
/** Exclude range of values of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-not-within",
+ description = "Exclude range of values of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-not-within")
private final Integer[] customInt5NotWithin;
/**
@@ -170,9 +555,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-5-within'.")
@JsonProperty("custom-int-5-from")
private final Integer customInt5From;
/** Exclude values from a lower bound of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-from-not",
+ description = "Exclude values from a lower bound of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-from-not")
private final Integer customInt5FromNot;
/**
@@ -180,22 +573,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-5-within'.")
@JsonProperty("custom-int-5-to")
private final Integer customInt5To;
/** Exclude values to an upper bound of the field customInt5 of the Task. */
+ @Schema(
+ name = "custom-int-5-to-not",
+ description = "Exclude values to an upper bound of the field customInt5 of the Task.")
@JsonProperty("custom-int-5-to-not")
private final Integer customInt5ToNot;
/** Filter by the value of the field customInt6 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-6",
+ description =
+ "Filter by the value of the field customInt6 of the Task. This is an exact match.")
@JsonProperty("custom-int-6")
private final Integer[] customInt6In;
/** Exclude values of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-not",
+ description = "Exclude values of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-not")
private final Integer[] customInt6NotIn;
/** Filter by the range of value of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-within",
+ description = "Filter by the range of value of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-within")
private final Integer[] customInt6Within;
/** Exclude range of values of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-not-within",
+ description = "Exclude range of values of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-not-within")
private final Integer[] customInt6NotWithin;
/**
@@ -203,9 +617,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-6-within'.")
@JsonProperty("custom-int-6-from")
private final Integer customInt6From;
/** Exclude values from a lower bound of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-from-not",
+ description = "Exclude values from a lower bound of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-from-not")
private final Integer customInt6FromNot;
/**
@@ -213,22 +635,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-6-within'.")
@JsonProperty("custom-int-6-to")
private final Integer customInt6To;
/** Exclude values to an upper bound of the field customInt6 of the Task. */
+ @Schema(
+ name = "custom-int-6-to-not",
+ description = "Exclude values to an upper bound of the field customInt6 of the Task.")
@JsonProperty("custom-int-6-to-not")
private final Integer customInt6ToNot;
/** Filter by the value of the field customInt7 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-7",
+ description =
+ "Filter by the value of the field customInt7 of the Task. This is an exact match.")
@JsonProperty("custom-int-7")
private final Integer[] customInt7In;
/** Exclude values of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-not",
+ description = "Exclude values of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-not")
private final Integer[] customInt7NotIn;
/** Filter by the range of value of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-within",
+ description = "Filter by the range of value of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-within")
private final Integer[] customInt7Within;
/** Exclude range of values of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-not-within",
+ description = "Exclude range of values of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-not-within")
private final Integer[] customInt7NotWithin;
/**
@@ -236,9 +679,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-7-within'.")
@JsonProperty("custom-int-7-from")
private final Integer customInt7From;
/** Exclude values from a lower bound of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-from-not",
+ description = "Exclude values from a lower bound of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-from-not")
private final Integer customInt7FromNot;
/**
@@ -246,22 +697,43 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-7-within'.")
@JsonProperty("custom-int-7-to")
private final Integer customInt7To;
/** Exclude values to an upper bound of the field customInt7 of the Task. */
+ @Schema(
+ name = "custom-int-7-to-not",
+ description = "Exclude values to an upper bound of the field customInt7 of the Task.")
@JsonProperty("custom-int-7-to-not")
private final Integer customInt7ToNot;
/** Filter by the value of the field customInt8 of the Task. This is an exact match. */
+ @Schema(
+ name = "custom-int-8",
+ description =
+ "Filter by the value of the field customInt8 of the Task. This is an exact match.")
@JsonProperty("custom-int-8")
private final Integer[] customInt8In;
/** Exclude values of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-not",
+ description = "Exclude values of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-not")
private final Integer[] customInt8NotIn;
/** Filter by the range of value of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-within",
+ description = "Filter by the range of value of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-within")
private final Integer[] customInt8Within;
/** Exclude range of values of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-not-within",
+ description = "Exclude range of values of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-not-within")
private final Integer[] customInt8NotWithin;
/**
@@ -269,9 +741,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-8-within'.")
@JsonProperty("custom-int-8-from")
private final Integer customInt8From;
/** Exclude values from a lower bound of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-from-not",
+ description = "Exclude values from a lower bound of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-from-not")
private final Integer customInt8FromNot;
/**
@@ -279,9 +759,17 @@ public class TaskQueryFilterCustomIntFields implements QueryParameter This parameter can't be used together with "
+ + "'custom-int-8-within'.")
@JsonProperty("custom-int-8-to")
private final Integer customInt8To;
/** Exclude values to an upper bound of the field customInt8 of the Task. */
+ @Schema(
+ name = "custom-int-8-to-not",
+ description = "Exclude values to an upper bound of the field customInt8 of the Task.")
@JsonProperty("custom-int-8-to-not")
private final Integer customInt8ToNot;
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 c1af19acb..d444add6d 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
@@ -1,6 +1,7 @@
package pro.taskana.task.rest;
import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
import java.beans.ConstructorProperties;
import java.time.Instant;
import java.util.ArrayList;
@@ -20,21 +21,652 @@ import pro.taskana.task.api.models.ObjectReference;
public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'received-from' or 'received-until'.
*/
+ @Schema(
+ name = "received",
+ description =
+ "Filter by a time interval within which the Task was received. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601. This "
+ + "parameter can't be used together with 'received-from' or 'received-until'.")
@JsonProperty("received")
private final Instant[] receivedWithin;
@@ -57,6 +695,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'received'.
*/
+ @Schema(
+ name = "receivedFrom",
+ description =
+ "Filter since a given received timestamp. The format is ISO-8601."
+ + " This parameter can't be used together with 'received'.")
@JsonProperty("received-from")
private final Instant receivedFrom;
@@ -67,6 +710,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'received'.
*/
+ @Schema(
+ name = "received-until",
+ description =
+ "Filter until a given received timestamp. The format is ISO-8601."
+ + " This parameter can't be used together with 'received'.")
@JsonProperty("received-until")
private final Instant receivedUntil;
@@ -79,6 +727,13 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'received-not-in-from' or
* 'received-not-in-until'.
*/
+ @Schema(
+ name = "received-not",
+ description =
+ "Filter by a time interval within which the Task wasn't received. To "
+ + "create an open interval you can just leave it blank. The format is ISO-8601."
+ + " This parameter can't be used together with 'received-not-in-from' or "
+ + "'received-not-in-until'.")
@JsonProperty("received-not")
private final Instant[] receivedNotIn;
@@ -89,6 +744,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'received-not-in'.
*/
+ @Schema(
+ name = "received-from-not",
+ description =
+ "Filter since a given timestamp where it wasn't received. The format is "
+ + "ISO-8601. This parameter can't be used together with 'received-not-in'.")
@JsonProperty("received-from-not")
private final Instant receivedFromNot;
@@ -99,6 +759,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'received-not-in'.
*/
+ @Schema(
+ name = "received-until-not",
+ description =
+ "Filter until a given timestamp where it wasn't received. The format is "
+ + "ISO-8601. This parameter can't be used together with 'received-not-in'.")
@JsonProperty("received-until-not")
private final Instant receivedUntilNot;
// endregion
@@ -111,6 +776,12 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'created-from' or 'created-until'.
*/
+ @Schema(
+ name = "created",
+ description =
+ "Filter by a time interval within which the Task was created. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601. This "
+ + "parameter can't be used together with 'created-from' or 'created-until'.")
@JsonProperty("created")
private final Instant[] createdWithin;
@@ -121,6 +792,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'created'.
*/
+ @Schema(
+ name = "created-from",
+ description =
+ "Filter since a given created timestamp. The format is ISO-8601. This parameter "
+ + "can't be used together with 'created'.")
@JsonProperty("created-from")
private final Instant createdFrom;
@@ -131,6 +807,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'created'.
*/
+ @Schema(
+ name = "created-until",
+ description =
+ "Filter until a given created timestamp. The format is ISO-8601. This parameter "
+ + "can't be used together with 'created'.")
@JsonProperty("created-until")
private final Instant createdUntil;
@@ -142,6 +823,13 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'created-not-in-from' or 'created-not-in-until'.
*/
+ @Schema(
+ name = "created-not",
+ description =
+ "Filter by a time interval within which the Task wasn't created. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601. This "
+ + "parameter can't be used together with 'created-not-in-from' or "
+ + "'created-not-in-until'.")
@JsonProperty("created-not")
private final Instant[] createdNotWithin;
@@ -152,6 +840,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'created-not-in'.
*/
+ @Schema(
+ name = "created-from-not",
+ description =
+ "Filter not since a given timestamp where it wasn't created. The format is ISO-8601."
+ + " This parameter can't be used together with 'created-not-in'.")
@JsonProperty("created-from-not")
private final Instant createdFromNot;
@@ -162,6 +855,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'created-not-in'.
*/
+ @Schema(
+ name = "created-until-not",
+ description =
+ "Filter not until a given timestamp where it wasn't created. The format is ISO-8601."
+ + " This parameter can't be used together with 'created-not-in'.")
@JsonProperty("created-until-not")
private final Instant createdUntilNot;
// endregion
@@ -172,6 +870,11 @@ public class TaskQueryFilterParameter implements QueryParameter The format is ISO-8601.
*/
+ @Schema(
+ name = "claimed",
+ description =
+ "Filter by a time interval within which the Task was claimed. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601.")
@JsonProperty("claimed")
private final Instant[] claimedWithin;
@@ -181,6 +884,11 @@ public class TaskQueryFilterParameter implements QueryParameter The format is ISO-8601.
*/
+ @Schema(
+ name = "claimed-not",
+ description =
+ "Filter by a time interval within which the Task wasn't claimed. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601.")
@JsonProperty("claimed-not")
private final Instant[] claimedNotWithin;
// endregion
@@ -191,6 +899,11 @@ public class TaskQueryFilterParameter implements QueryParameter The format is ISO-8601.
*/
+ @Schema(
+ name = "modified",
+ description =
+ "Filter by a time interval within which the Task was modified. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601.")
@JsonProperty("modified")
private final Instant[] modifiedWithin;
@@ -200,6 +913,11 @@ public class TaskQueryFilterParameter implements QueryParameter The format is ISO-8601.
*/
+ @Schema(
+ name = "modified-not",
+ description =
+ "Filter by a time interval within which the Task wasn't modified. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601.")
@JsonProperty("modified-not")
private final Instant[] modifiedNotWithin;
// endregion
@@ -212,6 +930,12 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'planned-from' or 'planned-until'.
*/
+ @Schema(
+ name = "planned",
+ description =
+ "Filter by a time interval within which the Task was planned. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601. This "
+ + "parameter can't be used together with 'planned-from' or 'planned-until'.")
@JsonProperty("planned")
private final Instant[] plannedWithin;
@@ -222,6 +946,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'planned'.
*/
+ @Schema(
+ name = "planned-from",
+ description =
+ "Filter since a given planned timestamp. The format is ISO-8601. This parameter "
+ + "can't be used together with 'planned'.")
@JsonProperty("planned-from")
private final Instant plannedFrom;
@@ -232,6 +961,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'planned'.
*/
+ @Schema(
+ name = "planned-until",
+ description =
+ "Filter until a given planned timestamp. The format is ISO-8601. This parameter "
+ + "can't be used together with 'planned'.")
@JsonProperty("planned-until")
private final Instant plannedUntil;
@@ -243,6 +977,13 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'planned-not-in-from' or 'planned-not-in-until'.
*/
+ @Schema(
+ name = "planned-not",
+ description =
+ "Filter by a time interval within which the Task was planned. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601. This "
+ + "parameter can't be used together with 'planned-not-in-from' or "
+ + "'planned-not-in-until'.")
@JsonProperty("planned-not")
private final Instant[] plannedNotWithin;
@@ -253,6 +994,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'planned-not-in'.
*/
+ @Schema(
+ name = "planned-from-not",
+ description =
+ "Filter since a given timestamp where it wasn't planned. The format is ISO-8601."
+ + " This parameter can't be used together with 'planned-not-in'.")
@JsonProperty("planned-from-not")
private final Instant plannedFromNot;
@@ -263,6 +1009,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'planned-not-in'.
*/
+ @Schema(
+ name = "planned-until-not",
+ description =
+ "Filter until a given timestamp where it wasn't planned. The format is ISO-8601."
+ + " This parameter can't be used together with 'planned-not-in'.")
@JsonProperty("planned-until-not")
private final Instant plannedUntilNot;
// endregion
@@ -275,6 +1026,12 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'due-from' or 'due-until'.
*/
+ @Schema(
+ name = "due",
+ description =
+ "Filter by a time interval within which the Task was due. To create an open interval "
+ + "you can just leave it blank. The format is ISO-8601. This parameter can't be"
+ + " used together with 'due-from' or 'due-until'.")
@JsonProperty("due")
private final Instant[] dueWithin;
@@ -285,6 +1042,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'due'.
*/
+ @Schema(
+ name = "due-from",
+ description =
+ "Filter since a given due timestamp. The format is ISO-8601. This parameter can't "
+ + "be used together with 'due'.")
@JsonProperty("due-from")
private final Instant dueFrom;
@@ -295,6 +1057,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'due'.
*/
+ @Schema(
+ name = "due-until",
+ description =
+ "Filter until a given due timestamp. The format is ISO-8601. This parameter can't "
+ + "be used together with 'due'.")
@JsonProperty("due-until")
private final Instant dueUntil;
@@ -306,6 +1073,12 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'due-not-in-from' or 'due-not-in-until'.
*/
+ @Schema(
+ name = "due-not",
+ description =
+ "Filter by a time interval within which the Task wasn't due. To create an open interval"
+ + " you can just leave it blank. The format is ISO-8601. This parameter can't be"
+ + " used together with 'due-not-in-from' or 'due-not-in-until'.")
@JsonProperty("due-not")
private final Instant[] dueNotWithin;
@@ -316,6 +1089,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'due-not-in'.
*/
+ @Schema(
+ name = "due-from-not",
+ description =
+ "Filter since a given timestamp where it isn't due. The format is ISO-8601. This "
+ + "parameter can't be used together with 'due-not-in'.")
@JsonProperty("due-from-not")
private final Instant dueFromNot;
@@ -326,6 +1104,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'due-not-in'.
*/
+ @Schema(
+ name = "due-until-not",
+ description =
+ "Filter until a given timestamp where it isn't due. The format is ISO-8601. This "
+ + "parameter can't be used together with 'due-not-in'.")
@JsonProperty("due-until-not")
private final Instant dueUntilNot;
// endregion
@@ -338,6 +1121,12 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'completed-from' or 'completed-until'.
*/
+ @Schema(
+ name = "completed",
+ description =
+ "Filter by a time interval within which the Task was completed. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601. This parameter"
+ + " can't be used together with 'completed-from' or 'completed-until'.")
@JsonProperty("completed")
private final Instant[] completedWithin;
@@ -348,6 +1137,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'completed'.
*/
+ @Schema(
+ name = "completed-from",
+ description =
+ "Filter since a given completed timestamp. The format is ISO-8601. This parameter "
+ + "can't be used together with 'completed'.")
@JsonProperty("completed-from")
private final Instant completedFrom;
@@ -358,6 +1152,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'completed'.
*/
+ @Schema(
+ name = "completed-until",
+ description =
+ "Filter until a given completed timestamp. The format is ISO-8601. This parameter "
+ + "can't be used together with 'completed'.")
@JsonProperty("completed-until")
private final Instant completedUntil;
@@ -370,6 +1169,12 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'completed-not-in-from' or
* 'completed-not-in-until'.
*/
+ @Schema(
+ name = "completed-not",
+ description =
+ "Filter by a time interval within which the Task wasn't completed. To create an open "
+ + "interval you can just leave it blank. The format is ISO-8601. This parameter "
+ + "can't be used together with 'completed-not-in-from' or 'completed-not-in-until'.")
@JsonProperty("completed-not")
private final Instant[] completedNotWithin;
@@ -380,6 +1185,11 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'completed-not-in'.
*/
+ @Schema(
+ name = "completed-from-not",
+ description =
+ "Filter since a given timestamp where it wasn't completed. The format is ISO-8601. "
+ + " This parameter can't be used together with 'completed-not-in'.")
@JsonProperty("completed-from-not")
private final Instant completedFromNot;
@@ -390,15 +1200,24 @@ public class TaskQueryFilterParameter implements QueryParameter This parameter can't be used together with 'completed-not-in'.
*/
+ @Schema(
+ name = "completed-until-not",
+ description =
+ "Filter until a given timestamp where it wasn't completed. The format is ISO-8601. "
+ + " This parameter can't be used together with 'completed-not-in'.")
@JsonProperty("completed-until-not")
private final Instant completedUntilNot;
// endregion
// region name
/** Filter by the name of the Task. This is an exact match. */
+ @Schema(name = "name", description = "Filter by the name of the Task. This is an exact match.")
@JsonProperty("name")
private final String[] nameIn;
/** Filter by what the name of the Task shouldn't be. This is an exact match. */
+ @Schema(
+ name = "name-not",
+ description = "Filter by what the name of the Task shouldn't be. This is an exact match.")
@JsonProperty("name-not")
private final String[] nameNotIn;
@@ -407,6 +1226,12 @@ public class TaskQueryFilterParameter implements QueryParameter, S extends QuerySortBy
// the javadoc comment for this field is above its getter. This is done to define the type
// parameter S by overriding that getter and allowing spring-auto-rest-docs to properly detect
// the type parameter S.
+ @Schema(
+ name = "sort-by",
+ description =
+ "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.")
@JsonProperty("sort-by")
private final List
sortBy;
@@ -20,6 +26,13 @@ public class QuerySortParameter, S extends QuerySortBy
* 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 value.
*/
+ @Schema(
+ name = "order",
+ description =
+ "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 value.")
@JsonProperty("order")
private final List