From a7f120213bcfd9c5c7821a1b7c2e5bbc9b451e9d Mon Sep 17 00:00:00 2001 From: Akshit Joshi Date: Wed, 27 Nov 2024 17:09:56 +0530 Subject: [PATCH] feat(rest): Add documentation for new clearing size parameter. Signed-off-by: Akshit Joshi --- .../rest/resourceserver/restdocs/ClearingRequestSpecTest.java | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/rest/resource-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ClearingRequestSpecTest.java b/rest/resource-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ClearingRequestSpecTest.java index 2b29066ad9..e59c709096 100644 --- a/rest/resource-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ClearingRequestSpecTest.java +++ b/rest/resource-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ClearingRequestSpecTest.java @@ -80,6 +80,7 @@ public void before() throws TException, IOException { clearingRequest.setRequestingUser("test.admin@sw60.org"); clearingRequest.setRequestingUserComment("testing comment"); clearingRequest.setClearingType(ClearingRequestType.DEEP); + clearingRequest.setClearingSize(ClearingRequestSize.VERY_SMALL); clearingRequest.setTimestamp(1599285578); clearingRequest.setModifiedOn(1599285580); @@ -228,6 +229,7 @@ public void should_document_get_clearingrequest() throws Exception { fieldWithPath("projectId").description("The id of the Project, for which clearing request is created"), fieldWithPath("requestedClearingDate").description("The requested clearing date of releases"), fieldWithPath("clearingType").description("The clearing type of the request, e.g., DEEP."), + fieldWithPath("clearingSize").description("The size of the clearing request, determined dynamically based on the maximum number of open releases. Reflects the effort required to clear the request. Possible values are: " + Arrays.asList(ClearingRequestSize.values())), fieldWithPath("requestingUser").description("The user who created the clearing request"), fieldWithPath("requestingUserComment").description("The comment from requesting user"), fieldWithPath("priority").description("The priority of clearing request. Possible values are: " + Arrays.asList(ClearingRequestPriority.values())), @@ -263,6 +265,7 @@ public void should_document_get_clearingrequest_by_projectid() throws Exception fieldWithPath("projectId").description("The id of the Project, for which clearing request is created"), fieldWithPath("requestedClearingDate").description("The requested clearing date of releases"), fieldWithPath("clearingType").description("The clearing type of the request, e.g., DEEP."), + fieldWithPath("clearingSize").description("The size of the clearing request, determined dynamically based on the maximum number of open releases. Reflects the effort required to clear the request. Possible values are: " + Arrays.asList(ClearingRequestSize.values())), fieldWithPath("requestingUser").description("The user who created the clearing request"), fieldWithPath("requestingUserComment").description("The comment from requesting user"), fieldWithPath("priority").description("The priority of clearing request. Possible values are: " + Arrays.asList(ClearingRequestPriority.values())), @@ -442,6 +445,7 @@ public void should_document_patch_clearingrequest () throws Exception { subsectionWithPath("_embedded.requestingUser").description("Requesting user detail"), subsectionWithPath("_links").description("Links to other resources"), fieldWithPath("clearingType").description("The type of clearing, e.g., DEEP"), + fieldWithPath("clearingSize").description("The size of the clearing request, determined dynamically based on the maximum number of open releases. Reflects the effort required to clear the request. Possible values are: " + Arrays.asList(ClearingRequestSize.values())), fieldWithPath("_embedded.totalRelease").description("Total number of releases"), fieldWithPath("_embedded.openRelease").description("Number of open releases"), fieldWithPath("_embedded.lastUpdatedOn").description("Last updated date for the clearing request"),