Merge pull request #2149 from siemens/feat/searchDocEndpoint

feat(Rest): Modifying the document for search endpoint Reviewed by: anupam.ghosh@siemens.com
eclipse-sw360 · Oct 18, 2023 · 87295de · 87295de
2 parents d52da37 + b89bde7
commit 87295de
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/...e-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/SearchSpecTest.java b/...e-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/SearchSpecTest.java
@@ -87,7 +87,10 @@ public void should_document_get_searchresult() throws Exception {
                 .andDo(this.documentationHandler.document(
                         requestParameters(
                                 parameterWithName("searchText").description("The search text"),
-                                parameterWithName("typeMasks").description("The type of resource. Possible values are " +List.of("project", "component", "license", "release", "obligation", "user", "vendor")),
+                                parameterWithName("typeMasks").description("The type of resource. Possible values are " +List.of("project", "component", "license", "release", "obligation", "user", "vendor", "document") 
+                                + "\nNote: If document is excluded in typeMasks, then search will be restricted to " + "Name for Project, Component and Release, " 
+                                + "Fullname for License, User and Vendor, " 
+                                + "Title for Obligation"),
                                 parameterWithName("page").description("Page of search results"),
                                 parameterWithName("page_entries").description("Amount of search results per page"),
                                 parameterWithName("sort").description("Defines order of the search results")