TSK-967: Refactor taskana-rest-spring-test to only use test files
This commit is contained in:
parent
71c33670d6
commit
3401d9ee04
2
pom.xml
2
pom.xml
|
|
@ -41,7 +41,7 @@
|
||||||
<version.maven.javadoc>3.1.0</version.maven.javadoc>
|
<version.maven.javadoc>3.1.0</version.maven.javadoc>
|
||||||
<version.maven.resources>3.0.2</version.maven.resources>
|
<version.maven.resources>3.0.2</version.maven.resources>
|
||||||
<version.maven.surefire>3.0.0-M3</version.maven.surefire>
|
<version.maven.surefire>3.0.0-M3</version.maven.surefire>
|
||||||
<version.maven.asciidoctor>1.5.3</version.maven.asciidoctor>
|
<version.maven.asciidoctor>1.5.6</version.maven.asciidoctor>
|
||||||
<version.maven.wildfly>2.0.0.Final</version.maven.wildfly>
|
<version.maven.wildfly>2.0.0.Final</version.maven.wildfly>
|
||||||
|
|
||||||
<!-- release dependencies -->
|
<!-- release dependencies -->
|
||||||
|
|
|
||||||
|
|
@ -27,34 +27,39 @@
|
||||||
</dependencies>
|
</dependencies>
|
||||||
</dependencyManagement>
|
</dependencyManagement>
|
||||||
|
|
||||||
|
<!-- Tests -->
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.boot</groupId>
|
|
||||||
<artifactId>spring-boot-starter-web</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.boot</groupId>
|
|
||||||
<artifactId>spring-boot-starter-jdbc</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.plugin</groupId>
|
|
||||||
<artifactId>spring-plugin-core</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.boot</groupId>
|
|
||||||
<artifactId>spring-boot-starter-security</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>com.h2database</groupId>
|
|
||||||
<artifactId>h2</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>pro.taskana</groupId>
|
<groupId>pro.taskana</groupId>
|
||||||
<artifactId>taskana-rest-spring-example-common</artifactId>
|
<artifactId>taskana-rest-spring-example-common</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-web</artifactId>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-jdbc</artifactId>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.plugin</groupId>
|
||||||
|
<artifactId>spring-plugin-core</artifactId>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-starter-security</artifactId>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.h2database</groupId>
|
||||||
|
<artifactId>h2</artifactId>
|
||||||
|
<scope>test</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
<!-- Tests -->
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.boot</groupId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<artifactId>spring-boot-starter-test</artifactId>
|
<artifactId>spring-boot-starter-test</artifactId>
|
||||||
|
|
@ -123,9 +128,10 @@
|
||||||
</goals>
|
</goals>
|
||||||
<configuration>
|
<configuration>
|
||||||
<backend>html</backend>
|
<backend>html</backend>
|
||||||
|
<sourceDirectory>${basedir}/src/test/resources/asciidoc</sourceDirectory>
|
||||||
<doctype>book</doctype>
|
<doctype>book</doctype>
|
||||||
<attributes>
|
<attributes>
|
||||||
<snippets>target/generated-snippets</snippets>
|
<snippets>${basedir}/target/generated-snippets</snippets>
|
||||||
<docinfo>shared</docinfo>
|
<docinfo>shared</docinfo>
|
||||||
</attributes>
|
</attributes>
|
||||||
</configuration>
|
</configuration>
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,64 +0,0 @@
|
||||||
<!-- Sourcecode at https://stackoverflow.com/questions/34481638/how-to-use-tocify-with-asciidoctor-for-a-dynamic-toc -->
|
|
||||||
|
|
||||||
<script src="./jquery-1.11.3.min.js"></script>
|
|
||||||
<script src="./jquery-ui.min.js"></script>
|
|
||||||
<script src="./jquery.tocify.min.js"></script>
|
|
||||||
|
|
||||||
<style>
|
|
||||||
.tocify-header {
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
.tocify-subheader {
|
|
||||||
font-style: normal;
|
|
||||||
font-size: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.tocify ul {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.tocify-focus {
|
|
||||||
color: #7a2518;
|
|
||||||
background-color: rgba(0, 0, 0, 0.1);
|
|
||||||
}
|
|
||||||
|
|
||||||
.tocify-focus > a {
|
|
||||||
color: #7a2518;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
|
|
||||||
<script type="text/javascript">
|
|
||||||
$(function () {
|
|
||||||
$("#toc").append("<div id='generated-toc'></div>");
|
|
||||||
$("#generated-toc").tocify({
|
|
||||||
extendPage: true,
|
|
||||||
context: "#content",
|
|
||||||
highlightOnScroll: true,
|
|
||||||
hideEffect: "slideUp",
|
|
||||||
hashGenerator: function(text, element) {
|
|
||||||
return $(element).attr("id");
|
|
||||||
},
|
|
||||||
smoothScroll: false,
|
|
||||||
theme: "none",
|
|
||||||
selectors: $( "#content" ).has( "h1" ).size() > 0 ? "h1,h2,h3,h4,h5" : "h2,h3,h4,h5",
|
|
||||||
ignoreSelector: ".discrete"
|
|
||||||
});
|
|
||||||
|
|
||||||
var handleTocOnResize = function() {
|
|
||||||
if ($(document).width() < 768) {
|
|
||||||
$("#generated-toc").hide();
|
|
||||||
$(".sectlevel0").show();
|
|
||||||
$(".sectlevel1").show();
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
$("#generated-toc").show();
|
|
||||||
$(".sectlevel0").hide();
|
|
||||||
$(".sectlevel1").hide();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$(window).resize(handleTocOnResize);
|
|
||||||
handleTocOnResize();
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -84,13 +84,13 @@ If a resource has embedded resources these are found in a map named *_embedded*.
|
||||||
|
|
||||||
Every Resource contains at least the link to itself.
|
Every Resource contains at least the link to itself.
|
||||||
|
|
||||||
include::../../../{snippets}/CommonFields/response-fields.adoc[]
|
include::{snippets}/CommonFields/response-fields.adoc[]
|
||||||
|
|
||||||
=== Response Fields common to all Summary Resources
|
=== Response Fields common to all Summary Resources
|
||||||
|
|
||||||
Summary Resources contain embedded resources and can be requested in a <<paged-request, paged format>>.
|
Summary Resources contain embedded resources and can be requested in a <<paged-request, paged format>>.
|
||||||
|
|
||||||
include::../../../{snippets}/CommonSummaryResourceFields/response-fields.adoc[]
|
include::{snippets}/CommonSummaryResourceFields/response-fields.adoc[]
|
||||||
|
|
||||||
== Tasks-Resource
|
== Tasks-Resource
|
||||||
|
|
||||||
|
|
@ -100,15 +100,15 @@ A `GET` request is used to retrieve a task summary.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllTasksDocTest/http-request.adoc[]
|
include::{snippets}/GetAllTasksDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllTasksDocTest/http-response.adoc[]
|
include::{snippets}/GetAllTasksDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllTasksDocTest/response-fields.adoc[]
|
include::{snippets}/GetAllTasksDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Filter and sort options
|
=== Filter and sort options
|
||||||
|
|
||||||
|
|
@ -125,16 +125,16 @@ A `GET` request is used to retrieve a task.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetSpecificTaskDocTest/http-request.adoc[]
|
include::{snippets}/GetSpecificTaskDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetSpecificTaskDocTest/http-response.adoc[]
|
include::{snippets}/GetSpecificTaskDocTest/http-response.adoc[]
|
||||||
|
|
||||||
[[task]]
|
[[task]]
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetSpecificTaskDocTest/response-fields.adoc[]
|
include::{snippets}/GetSpecificTaskDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Update a task
|
=== Update a task
|
||||||
|
|
||||||
|
|
@ -142,19 +142,19 @@ A `PUT` request is used to update a task.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/UpdateTaskDocTest/http-request.adoc[]
|
include::{snippets}/UpdateTaskDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Request Structure
|
==== Request Structure
|
||||||
|
|
||||||
include::../../../{snippets}/UpdateTaskDocTest/request-fields.adoc[]
|
include::{snippets}/UpdateTaskDocTest/request-fields.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/UpdateTaskDocTest/http-response.adoc[]
|
include::{snippets}/UpdateTaskDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/UpdateTaskDocTest/response-fields.adoc[]
|
include::{snippets}/UpdateTaskDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Claim a task
|
=== Claim a task
|
||||||
|
|
||||||
|
|
@ -164,11 +164,11 @@ A `POST` request is used to claim a task
|
||||||
|
|
||||||
Note the empty request-body in the example.
|
Note the empty request-body in the example.
|
||||||
|
|
||||||
include::../../../{snippets}/ClaimTaskDocTest/http-request.adoc[]
|
include::{snippets}/ClaimTaskDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/ClaimTaskDocTest/http-response.adoc[]
|
include::{snippets}/ClaimTaskDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -183,11 +183,11 @@ A `POST` request is used to complete a task
|
||||||
|
|
||||||
Note the empty request-body in the example.
|
Note the empty request-body in the example.
|
||||||
|
|
||||||
include::../../../{snippets}/CompleteTaskDocTest/http-request.adoc[]
|
include::{snippets}/CompleteTaskDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/CompleteTaskDocTest/http-response.adoc[]
|
include::{snippets}/CompleteTaskDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -202,16 +202,16 @@ A `POST` request is used to create a new task.
|
||||||
|
|
||||||
This minimal example shows only the required fields to create a new task. The <<create-task-request-structure, request structure>> shows all possible fields for creating a task.
|
This minimal example shows only the required fields to create a new task. The <<create-task-request-structure, request structure>> shows all possible fields for creating a task.
|
||||||
|
|
||||||
include::../../../{snippets}/CreateTaskDocTest/http-request.adoc[]
|
include::{snippets}/CreateTaskDocTest/http-request.adoc[]
|
||||||
|
|
||||||
[[create-task-request-structure, request structure]]
|
[[create-task-request-structure, request structure]]
|
||||||
==== Request Structure
|
==== Request Structure
|
||||||
|
|
||||||
include::../../../{snippets}/CreateTaskDocTest/request-fields.adoc[]
|
include::{snippets}/CreateTaskDocTest/request-fields.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/CreateTaskDocTest/http-response.adoc[]
|
include::{snippets}/CreateTaskDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -224,11 +224,11 @@ A `DELETE` request is used to delete a task.
|
||||||
|
|
||||||
==== Example request
|
==== Example request
|
||||||
|
|
||||||
include::../../../{snippets}/DeleteTaskDocTest/http-request.adoc[]
|
include::{snippets}/DeleteTaskDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example response
|
==== Example response
|
||||||
|
|
||||||
include::../../../{snippets}/DeleteTaskDocTest/http-response.adoc[]
|
include::{snippets}/DeleteTaskDocTest/http-response.adoc[]
|
||||||
|
|
||||||
=== Transfer a task to another workbasket
|
=== Transfer a task to another workbasket
|
||||||
|
|
||||||
|
|
@ -236,11 +236,11 @@ A `POST` request is used to transfer a task from one to another workbasket.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/TransferTaskDocTest/http-request.adoc[]
|
include::{snippets}/TransferTaskDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/TransferTaskDocTest/http-response.adoc[]
|
include::{snippets}/TransferTaskDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -257,15 +257,15 @@ A `GET` request is used to retrieve a classification summary.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllClassificationsDocTest/http-request.adoc[]
|
include::{snippets}/GetAllClassificationsDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllClassificationsDocTest/http-response.adoc[]
|
include::{snippets}/GetAllClassificationsDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllClassificationsDocTest/response-fields.adoc[]
|
include::{snippets}/GetAllClassificationsDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
The response-body is essentially the same as for getting a single classification. +
|
The response-body is essentially the same as for getting a single classification. +
|
||||||
Therefore for the response fields you can refer to the structure of the <<workbasket, single workbasket>>.
|
Therefore for the response fields you can refer to the structure of the <<workbasket, single workbasket>>.
|
||||||
|
|
@ -286,16 +286,16 @@ A `GET` request is used to retrieve a classification.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetSpecificClassificationDocTest/http-request.adoc[]
|
include::{snippets}/GetSpecificClassificationDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetSpecificClassificationDocTest/http-response.adoc[]
|
include::{snippets}/GetSpecificClassificationDocTest/http-response.adoc[]
|
||||||
|
|
||||||
[[classification]]
|
[[classification]]
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetSpecificClassificationDocTest/response-fields.adoc[]
|
include::{snippets}/GetSpecificClassificationDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Update a Classification
|
=== Update a Classification
|
||||||
|
|
||||||
|
|
@ -303,7 +303,7 @@ A `PUT` request is used to update a classification.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/UpdateClassificationDocTest/http-request.adoc[]
|
include::{snippets}/UpdateClassificationDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Request Structure
|
==== Request Structure
|
||||||
|
|
||||||
|
|
@ -312,7 +312,7 @@ Therefore for the request fields you can refer to the structure of the <<classif
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/UpdateClassificationDocTest/http-response.adoc[]
|
include::{snippets}/UpdateClassificationDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -327,16 +327,16 @@ A `POST` request is used to create a new classification.
|
||||||
|
|
||||||
This minimal example shows only the required fields to create a new classification. The <<create-classification-request-structure, request structure>> shows all possible fields for creating a classification.
|
This minimal example shows only the required fields to create a new classification. The <<create-classification-request-structure, request structure>> shows all possible fields for creating a classification.
|
||||||
|
|
||||||
include::../../../{snippets}/CreateClassificationDocTest/http-request.adoc[]
|
include::{snippets}/CreateClassificationDocTest/http-request.adoc[]
|
||||||
|
|
||||||
[[create-classification-request-structure]]
|
[[create-classification-request-structure]]
|
||||||
==== Request Structure
|
==== Request Structure
|
||||||
|
|
||||||
include::../../../{snippets}/CreateClassificationDocTest/request-fields.adoc[]
|
include::{snippets}/CreateClassificationDocTest/request-fields.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/CreateClassificationDocTest/http-response.adoc[]
|
include::{snippets}/CreateClassificationDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -349,11 +349,11 @@ A `DELETE` request is used to delete a classification.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/DeleteClassificationDocTest/http-request.adoc[]
|
include::{snippets}/DeleteClassificationDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/DeleteClassificationDocTest/http-response.adoc[]
|
include::{snippets}/DeleteClassificationDocTest/http-response.adoc[]
|
||||||
|
|
||||||
== Classification-definition-Resource
|
== Classification-definition-Resource
|
||||||
|
|
||||||
|
|
@ -364,15 +364,15 @@ A `GET` request is used to get all classification definitions.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/ExportClassificationDefinitionsDocTest/http-request.adoc[]
|
include::{snippets}/ExportClassificationDefinitionsDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/ExportClassificationDefinitionsDocTest/http-response.adoc[]
|
include::{snippets}/ExportClassificationDefinitionsDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/ExportClassificationDefinitionsDocTest/response-fields.adoc[]
|
include::{snippets}/ExportClassificationDefinitionsDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Import new classification-definitions
|
=== Import new classification-definitions
|
||||||
|
|
||||||
|
|
@ -382,11 +382,11 @@ A `POST` request is used to import new classification-definitions.
|
||||||
|
|
||||||
This minimal example shows only the required fields to import a single new classification-definition. The <<classification, classification structure>> shows all possible fields for importing (and therefore creating) new classification-definitions.
|
This minimal example shows only the required fields to import a single new classification-definition. The <<classification, classification structure>> shows all possible fields for importing (and therefore creating) new classification-definitions.
|
||||||
|
|
||||||
include::../../../{snippets}/ImportClassificationDefinitions/http-request.adoc[]
|
include::{snippets}/ImportClassificationDefinitions/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/ImportClassificationDefinitions/http-response.adoc[]
|
include::{snippets}/ImportClassificationDefinitions/http-response.adoc[]
|
||||||
|
|
||||||
== Workbaskets-Resource
|
== Workbaskets-Resource
|
||||||
|
|
||||||
|
|
@ -396,15 +396,15 @@ A `GET` request is used to retrieve a workbasket summary.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllWorkbasketsDocTest/http-request.adoc[]
|
include::{snippets}/GetAllWorkbasketsDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllWorkbasketsDocTest/http-response.adoc[]
|
include::{snippets}/GetAllWorkbasketsDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllWorkbasketsDocTest/response-fields.adoc[]
|
include::{snippets}/GetAllWorkbasketsDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Filter and sort options
|
=== Filter and sort options
|
||||||
|
|
||||||
|
|
@ -422,16 +422,16 @@ A `GET` request is used to retrieve a workbasket.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetSpecificWorkbasketDocTest/http-request.adoc[]
|
include::{snippets}/GetSpecificWorkbasketDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetSpecificWorkbasketDocTest/http-response.adoc[]
|
include::{snippets}/GetSpecificWorkbasketDocTest/http-response.adoc[]
|
||||||
|
|
||||||
[[workbasket]]
|
[[workbasket]]
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetSpecificWorkbasketDocTest/response-fields.adoc[]
|
include::{snippets}/GetSpecificWorkbasketDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Update a workbasket
|
=== Update a workbasket
|
||||||
|
|
||||||
|
|
@ -439,7 +439,7 @@ A `PUT` request is used to update a workbasket
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/UpdateWorkbasketDocTest/http-request.adoc[]
|
include::{snippets}/UpdateWorkbasketDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Request Structure
|
==== Request Structure
|
||||||
|
|
||||||
|
|
@ -448,7 +448,7 @@ Therefore for the request fields you can refer to the structure of the <<workbas
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/UpdateWorkbasketDocTest/http-response.adoc[]
|
include::{snippets}/UpdateWorkbasketDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -461,11 +461,11 @@ A `DELETE` request to dalete a workbasket
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/MarkWorkbasketForDeletionDocTest/http-request.adoc[]
|
include::{snippets}/MarkWorkbasketForDeletionDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/MarkWorkbasketForDeletionDocTest/http-response.adoc[]
|
include::{snippets}/MarkWorkbasketForDeletionDocTest/http-response.adoc[]
|
||||||
|
|
||||||
|
|
||||||
=== Remove a workbasket as distribution-target
|
=== Remove a workbasket as distribution-target
|
||||||
|
|
@ -474,11 +474,11 @@ A `DELETE` request is used to remove a workbasket as a distribution-taregt.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/RemoveWorkbasketAsDistributionTargetDocTest/http-request.adoc[]
|
include::{snippets}/RemoveWorkbasketAsDistributionTargetDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/RemoveWorkbasketAsDistributionTargetDocTest/http-response.adoc[]
|
include::{snippets}/RemoveWorkbasketAsDistributionTargetDocTest/http-response.adoc[]
|
||||||
|
|
||||||
=== Get all Access-Items for a workbasket
|
=== Get all Access-Items for a workbasket
|
||||||
|
|
||||||
|
|
@ -486,15 +486,15 @@ A `GET` request is used to get a list of all accessitems of a workbasket.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllWorkbasketAccessItemsDocTest/http-request.adoc[]
|
include::{snippets}/GetAllWorkbasketAccessItemsDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllWorkbasketAccessItemsDocTest/http-response.adoc[]
|
include::{snippets}/GetAllWorkbasketAccessItemsDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllWorkbasketAccessItemsDocTest/response-fields.adoc[]
|
include::{snippets}/GetAllWorkbasketAccessItemsDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Get all distribution-targets for a workbasket
|
=== Get all distribution-targets for a workbasket
|
||||||
|
|
||||||
|
|
@ -502,15 +502,15 @@ A `GET` request is used to get a list of the distribution-targets of a workbaske
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllWorkbasketDistributionTargets/http-request.adoc[]
|
include::{snippets}/GetAllWorkbasketDistributionTargets/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllWorkbasketDistributionTargets/http-response.adoc[]
|
include::{snippets}/GetAllWorkbasketDistributionTargets/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllWorkbasketDistributionTargets/response-fields.adoc[]
|
include::{snippets}/GetAllWorkbasketDistributionTargets/response-fields.adoc[]
|
||||||
|
|
||||||
=== Create a new Workbasket
|
=== Create a new Workbasket
|
||||||
|
|
||||||
|
|
@ -520,16 +520,16 @@ A `POST` request is used to create a new workbasket.
|
||||||
|
|
||||||
This minimal example shows only the required fields to create a new workbasket. The <<create-workbasket-request-structure, request structure>> shows all possible fields for creating a workbasket.
|
This minimal example shows only the required fields to create a new workbasket. The <<create-workbasket-request-structure, request structure>> shows all possible fields for creating a workbasket.
|
||||||
|
|
||||||
include::../../../{snippets}/CreateWorkbasketDocTest/http-request.adoc[]
|
include::{snippets}/CreateWorkbasketDocTest/http-request.adoc[]
|
||||||
|
|
||||||
[[create-workbasket-request-structure]]
|
[[create-workbasket-request-structure]]
|
||||||
==== Request Structure
|
==== Request Structure
|
||||||
|
|
||||||
include::../../../{snippets}/CreateWorkbasketDocTest/request-fields.adoc[]
|
include::{snippets}/CreateWorkbasketDocTest/request-fields.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/CreateWorkbasketDocTest/http-response.adoc[]
|
include::{snippets}/CreateWorkbasketDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -544,16 +544,16 @@ A `GET` request is used to get all workbasket definitions.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/ExportWorkbasketdefinitionsDocTest/http-request.adoc[]
|
include::{snippets}/ExportWorkbasketdefinitionsDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/ExportWorkbasketdefinitionsDocTest/http-response.adoc[]
|
include::{snippets}/ExportWorkbasketdefinitionsDocTest/http-response.adoc[]
|
||||||
|
|
||||||
[[workbasket-definitions]]
|
[[workbasket-definitions]]
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/ExportWorkbasketdefinitionsDocTest/response-fields.adoc[]
|
include::{snippets}/ExportWorkbasketdefinitionsDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Import new workbasket-definitions
|
=== Import new workbasket-definitions
|
||||||
|
|
||||||
|
|
@ -563,11 +563,11 @@ A `POST` request is used to import new workbasket-definitions.
|
||||||
|
|
||||||
This minimal example shows only the required fields to import a single new workbasket-definition. The <<workbasket, workbasket structure>> shows all possible fields for importing (and therefore creating) new workbasket-definitions.
|
This minimal example shows only the required fields to import a single new workbasket-definition. The <<workbasket, workbasket structure>> shows all possible fields for importing (and therefore creating) new workbasket-definitions.
|
||||||
|
|
||||||
include::../../../{snippets}/ImportWorkbasketDefinitions/http-request.adoc[]
|
include::{snippets}/ImportWorkbasketDefinitions/http-request.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/ImportWorkbasketDefinitions/http-response.adoc[]
|
include::{snippets}/ImportWorkbasketDefinitions/http-response.adoc[]
|
||||||
|
|
||||||
== WorkbasketAccessItems-Resource
|
== WorkbasketAccessItems-Resource
|
||||||
|
|
||||||
|
|
@ -577,15 +577,15 @@ A `GET` return all workbasketAccessItems that correspond the given data.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetWorkbasketAccessItemsDocTest/http-request.adoc[]
|
include::{snippets}/GetWorkbasketAccessItemsDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetWorkbasketAccessItemsDocTest/http-response.adoc[]
|
include::{snippets}/GetWorkbasketAccessItemsDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetWorkbasketAccessItemsDocTest/response-fields.adoc[]
|
include::{snippets}/GetWorkbasketAccessItemsDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Filter and sort options
|
=== Filter and sort options
|
||||||
|
|
||||||
|
|
@ -602,11 +602,11 @@ A `DELETE` request is used to delete a workbasketAccessItems.
|
||||||
|
|
||||||
==== Example request
|
==== Example request
|
||||||
|
|
||||||
include::../../../{snippets}/RemoveWorkbasketAccessItemsDocTest/http-request.adoc[]
|
include::{snippets}/RemoveWorkbasketAccessItemsDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example response
|
==== Example response
|
||||||
|
|
||||||
include::../../../{snippets}/RemoveWorkbasketAccessItemsDocTest/http-response.adoc[]
|
include::{snippets}/RemoveWorkbasketAccessItemsDocTest/http-response.adoc[]
|
||||||
|
|
||||||
== Monitor-Resource
|
== Monitor-Resource
|
||||||
|
|
||||||
|
|
@ -616,15 +616,15 @@ A `GET` request is used to get a task status report.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetTaskStatusReportDocTest/http-request.adoc[]
|
include::{snippets}/GetTaskStatusReportDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetTaskStatusReportDocTest/http-response.adoc[]
|
include::{snippets}/GetTaskStatusReportDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetTaskStatusReportDocTest/response-fields.adoc[]
|
include::{snippets}/GetTaskStatusReportDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Get a tasks workbasket report
|
=== Get a tasks workbasket report
|
||||||
|
|
||||||
|
|
@ -632,11 +632,11 @@ A `GET` request is used to get the number of tasks sorted by state.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetTaskWorkbasketReportDocTest/http-request.adoc[]
|
include::{snippets}/GetTaskWorkbasketReportDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetTaskWorkbasketReportDocTest/http-response.adoc[]
|
include::{snippets}/GetTaskWorkbasketReportDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -648,11 +648,11 @@ A `GET` request is used to get the number of tasks sorted by state.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetTaskClassificationReportDocTest/http-request.adoc[]
|
include::{snippets}/GetTaskClassificationReportDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetTaskClassificationReportDocTest/http-response.adoc[]
|
include::{snippets}/GetTaskClassificationReportDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -664,11 +664,11 @@ A `GET` request is used to get the number of tasks sorted by a task timestamp.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetTimestampReportDocTest/http-request.adoc[]
|
include::{snippets}/GetTimestampReportDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetTimestampReportDocTest/http-response.adoc[]
|
include::{snippets}/GetTimestampReportDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -684,15 +684,15 @@ This resource provides information which Domains exist in the system.
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllDomainsDocTest/http-request.adoc[]
|
include::{snippets}/GetAllDomainsDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllDomainsDocTest/http-response.adoc[]
|
include::{snippets}/GetAllDomainsDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllDomainsDocTest/response-fields.adoc[]
|
include::{snippets}/GetAllDomainsDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Classification-Categories-Resource
|
=== Classification-Categories-Resource
|
||||||
|
|
||||||
|
|
@ -700,15 +700,15 @@ This resource provides information which Classification Categories exist in the
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllClassificationCategoriesDocTest/http-request.adoc[]
|
include::{snippets}/GetAllClassificationCategoriesDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllClassificationCategoriesDocTest/http-response.adoc[]
|
include::{snippets}/GetAllClassificationCategoriesDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllClassificationCategoriesDocTest/response-fields.adoc[]
|
include::{snippets}/GetAllClassificationCategoriesDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Classification-Types-Resource
|
=== Classification-Types-Resource
|
||||||
|
|
||||||
|
|
@ -716,39 +716,39 @@ This resource provides information which Classification Types exist in the syste
|
||||||
|
|
||||||
==== Example Request
|
==== Example Request
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllClassificationTypesDocTest/http-request.adoc[]
|
include::{snippets}/GetAllClassificationTypesDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllClassificationTypesDocTest/http-response.adoc[]
|
include::{snippets}/GetAllClassificationTypesDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetAllClassificationTypesDocTest/response-fields.adoc[]
|
include::{snippets}/GetAllClassificationTypesDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== Current-User-Info-Resource
|
=== Current-User-Info-Resource
|
||||||
|
|
||||||
This resource provides information about the current user.
|
This resource provides information about the current user.
|
||||||
|
|
||||||
include::../../../{snippets}/GetCurrentUserInfoDocTest/http-request.adoc[]
|
include::{snippets}/GetCurrentUserInfoDocTest/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetCurrentUserInfoDocTest/http-response.adoc[]
|
include::{snippets}/GetCurrentUserInfoDocTest/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
include::../../../{snippets}/GetCurrentUserInfoDocTest/response-fields.adoc[]
|
include::{snippets}/GetCurrentUserInfoDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
=== History-Provider-Is-Enabled
|
=== History-Provider-Is-Enabled
|
||||||
|
|
||||||
This resource returns if history provider is enabled.
|
This resource returns if history provider is enabled.
|
||||||
|
|
||||||
include::../../../{snippets}/GetHistoryProviderIsEnabled/http-request.adoc[]
|
include::{snippets}/GetHistoryProviderIsEnabled/http-request.adoc[]
|
||||||
|
|
||||||
==== Example Response
|
==== Example Response
|
||||||
|
|
||||||
include::../../../{snippets}/GetHistoryProviderIsEnabled/http-response.adoc[]
|
include::{snippets}/GetHistoryProviderIsEnabled/http-response.adoc[]
|
||||||
|
|
||||||
==== Response Structure
|
==== Response Structure
|
||||||
|
|
||||||
|
|
@ -766,21 +766,21 @@ Further information at <https://github.com/spring-projects/spring-restdocs/issue
|
||||||
|
|
||||||
Subset of the <<classification, Classification Resource>>
|
Subset of the <<classification, Classification Resource>>
|
||||||
|
|
||||||
include::../../../{snippets}/ClassificationSubset/response-fields.adoc[]
|
include::{snippets}/ClassificationSubset/response-fields.adoc[]
|
||||||
|
|
||||||
[[workbasket-subset]]
|
[[workbasket-subset]]
|
||||||
=== Workbasket-Subset
|
=== Workbasket-Subset
|
||||||
|
|
||||||
Subset of the <<workbasket, Workbasket Resource>>
|
Subset of the <<workbasket, Workbasket Resource>>
|
||||||
|
|
||||||
include::../../../{snippets}/WorkbasketSubset/response-fields.adoc[]
|
include::{snippets}/WorkbasketSubset/response-fields.adoc[]
|
||||||
|
|
||||||
[[task-subset]]
|
[[task-subset]]
|
||||||
=== Task-Subset
|
=== Task-Subset
|
||||||
|
|
||||||
Subset of the <<task, Task Resource>>
|
Subset of the <<task, Task Resource>>
|
||||||
|
|
||||||
include::../../../{snippets}/TaskSubset/response-fields.adoc[]
|
include::{snippets}/TaskSubset/response-fields.adoc[]
|
||||||
|
|
||||||
== Embedded Resources
|
== Embedded Resources
|
||||||
|
|
||||||
|
|
@ -791,7 +791,7 @@ Due to a workaround for the same bug as for the <<resource-subsets, Resource-Sub
|
||||||
|
|
||||||
The access items hold information about the permissions to the workbaskets.
|
The access items hold information about the permissions to the workbaskets.
|
||||||
|
|
||||||
include::../../../{snippets}/AccessItemsDocTest/response-fields.adoc[]
|
include::{snippets}/AccessItemsDocTest/response-fields.adoc[]
|
||||||
|
|
||||||
[[paged-request]]
|
[[paged-request]]
|
||||||
== Example for a paged request (using the AbstractPagingController)
|
== Example for a paged request (using the AbstractPagingController)
|
||||||
|
|
@ -800,8 +800,8 @@ Summary Resources can be requested in a paged format.
|
||||||
|
|
||||||
=== Example request
|
=== Example request
|
||||||
|
|
||||||
include::../../../{snippets}/CommonSummaryResourceFields/http-request.adoc[]
|
include::{snippets}/CommonSummaryResourceFields/http-request.adoc[]
|
||||||
|
|
||||||
=== Example response
|
=== Example response
|
||||||
|
|
||||||
include::../../../{snippets}/CommonSummaryResourceFields/response-body.adoc[]
|
include::{snippets}/CommonSummaryResourceFields/response-body.adoc[]
|
||||||
Loading…
Reference in New Issue