From d156a42a5ec14992a2ea9ebf39b368a113cb9b6b Mon Sep 17 00:00:00 2001 From: "julian.schallenmueller" Date: Tue, 17 Jul 2018 13:57:52 +0200 Subject: [PATCH] TSK-491: Updated rest documentation --- ...sificationControllerRestDocumentation.java | 22 +++---- .../api/TaskControllerRestDocumentation.java | 62 +++++++++---------- ...WorkbasketControllerRestDocumentation.java | 22 +++---- 3 files changed, 53 insertions(+), 53 deletions(-) diff --git a/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/ClassificationControllerRestDocumentation.java b/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/ClassificationControllerRestDocumentation.java index 52a008e8b..ff59becc2 100644 --- a/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/ClassificationControllerRestDocumentation.java +++ b/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/ClassificationControllerRestDocumentation.java @@ -149,8 +149,6 @@ public class ClassificationControllerRestDocumentation { fieldWithPath("classificationId").description(classificationFieldDescriptionsMap.get("classificationId")), fieldWithPath("key").description(classificationFieldDescriptionsMap.get("key")), - fieldWithPath("parentId").description(classificationFieldDescriptionsMap.get("parentId")), - fieldWithPath("parentKey").description(classificationFieldDescriptionsMap.get("parentKey")), fieldWithPath("category").description(classificationFieldDescriptionsMap.get("category")), fieldWithPath("type").description(classificationFieldDescriptionsMap.get("type")), fieldWithPath("domain").description(classificationFieldDescriptionsMap.get("domain")), @@ -158,18 +156,20 @@ public class ClassificationControllerRestDocumentation { fieldWithPath("created").ignored(), fieldWithPath("modified").ignored(), fieldWithPath("name").description(classificationFieldDescriptionsMap.get("name")), + fieldWithPath("parentId").description(classificationFieldDescriptionsMap.get("parentId")), + fieldWithPath("parentKey").description(classificationFieldDescriptionsMap.get("parentKey")), fieldWithPath("description").ignored(), fieldWithPath("priority").description(classificationFieldDescriptionsMap.get("priority")), - fieldWithPath("serviceLevel").ignored(), + fieldWithPath("serviceLevel").description(classificationFieldDescriptionsMap.get("serviceLevel")), fieldWithPath("applicationEntryPoint").ignored(), - fieldWithPath("custom1").ignored(), - fieldWithPath("custom2").ignored(), - fieldWithPath("custom3").ignored(), - fieldWithPath("custom4").ignored(), - fieldWithPath("custom5").ignored(), - fieldWithPath("custom6").ignored(), - fieldWithPath("custom7").ignored(), - fieldWithPath("custom8").ignored(), + fieldWithPath("custom1").description(classificationFieldDescriptionsMap.get("custom1")), + fieldWithPath("custom2").description(classificationFieldDescriptionsMap.get("custom2")), + fieldWithPath("custom3").description(classificationFieldDescriptionsMap.get("custom3")), + fieldWithPath("custom4").description(classificationFieldDescriptionsMap.get("custom4")), + fieldWithPath("custom5").description(classificationFieldDescriptionsMap.get("custom5")), + fieldWithPath("custom6").description(classificationFieldDescriptionsMap.get("custom6")), + fieldWithPath("custom7").description(classificationFieldDescriptionsMap.get("custom7")), + fieldWithPath("custom8").description(classificationFieldDescriptionsMap.get("custom8")), fieldWithPath("_links.self.href").ignored() }; diff --git a/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/TaskControllerRestDocumentation.java b/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/TaskControllerRestDocumentation.java index f81f0e18a..1172a5e57 100644 --- a/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/TaskControllerRestDocumentation.java +++ b/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/TaskControllerRestDocumentation.java @@ -149,6 +149,8 @@ public class TaskControllerRestDocumentation { fieldWithPath("primaryObjRef.systemInstance").description(taskFieldDescriptionsMap.get("primaryObjRef.systemInstance")), fieldWithPath("primaryObjRef.type").description(taskFieldDescriptionsMap.get("primaryObjRef.type")), fieldWithPath("primaryObjRef.value").description(taskFieldDescriptionsMap.get("primaryObjRef.value")), + fieldWithPath("read").description(taskFieldDescriptionsMap.get("read")), + fieldWithPath("transferred").description(taskFieldDescriptionsMap.get("transferred")), fieldWithPath("customAttributes").description(taskFieldDescriptionsMap.get("customAttributes")), fieldWithPath("attachments").description(taskFieldDescriptionsMap.get("attachments")), fieldWithPath("custom1").description(taskFieldDescriptionsMap.get("custom1")).type("String"), @@ -167,8 +169,6 @@ public class TaskControllerRestDocumentation { fieldWithPath("custom14").description(taskFieldDescriptionsMap.get("custom14")).type("String"), fieldWithPath("custom15").description(taskFieldDescriptionsMap.get("custom15")).type("String"), fieldWithPath("custom16").description(taskFieldDescriptionsMap.get("custom16")).type("String"), - fieldWithPath("read").description(taskFieldDescriptionsMap.get("read")), - fieldWithPath("transferred").description(taskFieldDescriptionsMap.get("transferred")), fieldWithPath("_links.self.href").ignored() }; @@ -183,41 +183,41 @@ public class TaskControllerRestDocumentation { fieldWithPath("due").description(taskFieldDescriptionsMap.get("due")).type("String"), fieldWithPath("name").description(taskFieldDescriptionsMap.get("name")), fieldWithPath("creator").description(taskFieldDescriptionsMap.get("creator")), - fieldWithPath("description").description(taskFieldDescriptionsMap.get("description")), + fieldWithPath("description").ignored(), fieldWithPath("note").description(taskFieldDescriptionsMap.get("note")).description("Some custom Note"), fieldWithPath("priority").description(taskFieldDescriptionsMap.get("priority")), fieldWithPath("state").description(taskFieldDescriptionsMap.get("state")), subsectionWithPath("classificationSummaryResource").description(taskFieldDescriptionsMap.get("classificationSummaryResource")), subsectionWithPath("workbasketSummaryResource").description(taskFieldDescriptionsMap.get("workbasketSummaryResource")), - fieldWithPath("businessProcessId").ignored(), - fieldWithPath("parentBusinessProcessId").ignored(), - fieldWithPath("owner").ignored(), - fieldWithPath("primaryObjRef.id").ignored(), - fieldWithPath("primaryObjRef.company").ignored(), - fieldWithPath("primaryObjRef.system").ignored(), - fieldWithPath("primaryObjRef.systemInstance").ignored(), - fieldWithPath("primaryObjRef.type").ignored(), - fieldWithPath("primaryObjRef.value").ignored(), + fieldWithPath("businessProcessId").description(taskFieldDescriptionsMap.get("businessProcessId")), + fieldWithPath("parentBusinessProcessId").description(taskFieldDescriptionsMap.get("parentBusinessProcessId")), + fieldWithPath("owner").description(taskFieldDescriptionsMap.get("owner")), + fieldWithPath("primaryObjRef.id").description(taskFieldDescriptionsMap.get("primaryObjRef.id")).type("String"), + fieldWithPath("primaryObjRef.company").description(taskFieldDescriptionsMap.get("primaryObjRef.company")), + fieldWithPath("primaryObjRef.system").description(taskFieldDescriptionsMap.get("primaryObjRef.system")), + fieldWithPath("primaryObjRef.systemInstance").description(taskFieldDescriptionsMap.get("primaryObjRef.systemInstance")), + fieldWithPath("primaryObjRef.type").description(taskFieldDescriptionsMap.get("primaryObjRef.type")), + fieldWithPath("primaryObjRef.value").description(taskFieldDescriptionsMap.get("primaryObjRef.value")), + fieldWithPath("read").description(taskFieldDescriptionsMap.get("read")), + fieldWithPath("transferred").description(taskFieldDescriptionsMap.get("transferred")), fieldWithPath("customAttributes").ignored(), - fieldWithPath("attachments").ignored(), - fieldWithPath("custom1").ignored(), - fieldWithPath("custom2").ignored(), - fieldWithPath("custom3").ignored(), - fieldWithPath("custom4").ignored(), - fieldWithPath("custom5").ignored(), - fieldWithPath("custom6").ignored(), - fieldWithPath("custom7").ignored(), - fieldWithPath("custom8").ignored(), - fieldWithPath("custom9").ignored(), - fieldWithPath("custom10").ignored(), - fieldWithPath("custom11").ignored(), - fieldWithPath("custom12").ignored(), - fieldWithPath("custom13").ignored(), - fieldWithPath("custom14").ignored(), - fieldWithPath("custom15").ignored(), - fieldWithPath("custom16").ignored(), - fieldWithPath("read").ignored(), - fieldWithPath("transferred").ignored(), + fieldWithPath("attachments").description(taskFieldDescriptionsMap.get("attachments")), + fieldWithPath("custom1").description(taskFieldDescriptionsMap.get("custom1")), + fieldWithPath("custom2").description(taskFieldDescriptionsMap.get("custom2")), + fieldWithPath("custom3").description(taskFieldDescriptionsMap.get("custom3")), + fieldWithPath("custom4").description(taskFieldDescriptionsMap.get("custom4")), + fieldWithPath("custom5").description(taskFieldDescriptionsMap.get("custom5")), + fieldWithPath("custom6").description(taskFieldDescriptionsMap.get("custom6")), + fieldWithPath("custom7").description(taskFieldDescriptionsMap.get("custom7")), + fieldWithPath("custom8").description(taskFieldDescriptionsMap.get("custom8")), + fieldWithPath("custom9").description(taskFieldDescriptionsMap.get("custom9")), + fieldWithPath("custom10").description(taskFieldDescriptionsMap.get("custom10")), + fieldWithPath("custom11").description(taskFieldDescriptionsMap.get("custom11")), + fieldWithPath("custom12").description(taskFieldDescriptionsMap.get("custom12")), + fieldWithPath("custom13").description(taskFieldDescriptionsMap.get("custom13")), + fieldWithPath("custom14").description(taskFieldDescriptionsMap.get("custom14")), + fieldWithPath("custom15").description(taskFieldDescriptionsMap.get("custom15")), + fieldWithPath("custom16").description(taskFieldDescriptionsMap.get("custom16")), fieldWithPath("_links.self.href").ignored() }; diff --git a/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/WorkbasketControllerRestDocumentation.java b/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/WorkbasketControllerRestDocumentation.java index 864549b5d..d887a6974 100644 --- a/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/WorkbasketControllerRestDocumentation.java +++ b/rest/taskana-rest-spring-example/src/test/java/pro/taskana/doc/api/WorkbasketControllerRestDocumentation.java @@ -130,21 +130,21 @@ public class WorkbasketControllerRestDocumentation { fieldWithPath("workbasketId").description(workbasketFieldDescriptionsMap.get("workbasketId")), fieldWithPath("key").description(workbasketFieldDescriptionsMap.get("key")), - fieldWithPath("name").description(workbasketFieldDescriptionsMap.get("name")), - fieldWithPath("domain").description(workbasketFieldDescriptionsMap.get("domain")), - fieldWithPath("type").description(workbasketFieldDescriptionsMap.get("type")), - fieldWithPath("description").description(workbasketFieldDescriptionsMap.get("description")), - fieldWithPath("owner").description(workbasketFieldDescriptionsMap.get("owner")), - fieldWithPath("orgLevel1").description(workbasketFieldDescriptionsMap.get("orgLevel1")), - fieldWithPath("orgLevel2").description(workbasketFieldDescriptionsMap.get("orgLevel2")), - fieldWithPath("orgLevel3").description(workbasketFieldDescriptionsMap.get("orgLevel3")), - fieldWithPath("orgLevel4").description(workbasketFieldDescriptionsMap.get("orgLevel4")), fieldWithPath("created").description(workbasketFieldDescriptionsMap.get("created")), fieldWithPath("modified").description(workbasketFieldDescriptionsMap.get("modified")), + fieldWithPath("name").description(workbasketFieldDescriptionsMap.get("name")), + fieldWithPath("description").description(workbasketFieldDescriptionsMap.get("description")), + fieldWithPath("owner").description(workbasketFieldDescriptionsMap.get("owner")), + fieldWithPath("domain").description(workbasketFieldDescriptionsMap.get("domain")), + fieldWithPath("type").description(workbasketFieldDescriptionsMap.get("type")), fieldWithPath("custom1").description(workbasketFieldDescriptionsMap.get("custom1")), fieldWithPath("custom2").description(workbasketFieldDescriptionsMap.get("custom2")), fieldWithPath("custom3").description(workbasketFieldDescriptionsMap.get("custom3")), fieldWithPath("custom4").description(workbasketFieldDescriptionsMap.get("custom4")), + fieldWithPath("orgLevel1").description(workbasketFieldDescriptionsMap.get("orgLevel1")), + fieldWithPath("orgLevel2").description(workbasketFieldDescriptionsMap.get("orgLevel2")), + fieldWithPath("orgLevel3").description(workbasketFieldDescriptionsMap.get("orgLevel3")), + fieldWithPath("orgLevel4").description(workbasketFieldDescriptionsMap.get("orgLevel4")), fieldWithPath("_links.distributionTargets.href").description(workbasketFieldDescriptionsMap.get("_links.distributionTargets.href")), fieldWithPath("_links.removeDistributionTargets.href").description(workbasketFieldDescriptionsMap.get("_links.removeDistributionTargets.href")), fieldWithPath("_links.accessItems.href").description(workbasketFieldDescriptionsMap.get("_links.accessItems.href")), @@ -157,10 +157,10 @@ public class WorkbasketControllerRestDocumentation { fieldWithPath("workbasketId").description(workbasketFieldDescriptionsMap.get("workbasketId")), fieldWithPath("key").description(workbasketFieldDescriptionsMap.get("key")), fieldWithPath("name").description(workbasketFieldDescriptionsMap.get("name")), - fieldWithPath("domain").description(workbasketFieldDescriptionsMap.get("domain")), - fieldWithPath("type").description(workbasketFieldDescriptionsMap.get("type")), fieldWithPath("description").description(workbasketFieldDescriptionsMap.get("description")), fieldWithPath("owner").description(workbasketFieldDescriptionsMap.get("owner")), + fieldWithPath("domain").description(workbasketFieldDescriptionsMap.get("domain")), + fieldWithPath("type").description(workbasketFieldDescriptionsMap.get("type")), fieldWithPath("custom1").description(workbasketFieldDescriptionsMap.get("custom1")), fieldWithPath("custom2").description(workbasketFieldDescriptionsMap.get("custom2")), fieldWithPath("custom3").description(workbasketFieldDescriptionsMap.get("custom3")),