Added example req bodies for _search and v1/content/search

Author: jdcmsd

dotCMS/src/main/java/com/dotcms/rest/ContentResource.java

@@ -59,6 +59,7 @@
 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.ExampleObject;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -198,7 +199,17 @@ public Response search(@Context HttpServletRequest request,
                            @QueryParam("rememberQuery") @DefaultValue("false") final boolean rememberQuery,
                            @RequestBody(description = "Search criteria including query, sort, pagination and filters",
                                       required = true,
-                                      content = @Content(schema = @Schema(implementation = SearchForm.class)))
+                                      content = @Content(schema = @Schema(implementation = SearchForm.class),
+                                              examples = @ExampleObject(
+                                                      value = "{\n" +
+                                                              "  \"query\": \"+systemType:false " +
+                                                                "+languageId:1 +deleted:false " +
+                                                                "+working:true +variant:default\",\n" +
+                                                              "  \"sort\": \"modDate desc\",\n" +
+                                                              "  \"limit\": 20,\n" +
+                                                              "  \"offset\": 0\n" +
+                                                              "}")
+                                      ))
                            final SearchForm searchForm) throws DotSecurityException, DotDataException {
 
         final InitDataObject initData = this.webResource.init

dotCMS/src/main/java/com/dotcms/rest/api/v1/content/ContentResource.java

@@ -66,6 +66,7 @@
 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.ExampleObject;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -1065,7 +1066,14 @@ private List<ExistingLanguagesForContentletView> getExistingLanguagesForContent(
     public ResponseEntityView<SearchView> search(@Context final HttpServletRequest request,
                              @Context final HttpServletResponse response,
                              @RequestBody(description = "Content search parameters", required = true,
-                                        content = @Content(schema = @Schema(implementation = ContentSearchForm.class)))
+                                        content = @Content(schema = @Schema(implementation = ContentSearchForm.class),
+                                                examples = @ExampleObject(
+                                                             value = "{\n" +
+                                                             "  \"globalSearch\": \"test\",\n" +
+                                                             "  \"perPage\": 20,\n" +
+                                                             "  \"page\": 1\n" +
+                                                             "}")
+                                        ))
                              final ContentSearchForm contentSearchForm) throws DotDataException, DotSecurityException {
         Logger.debug(this, () -> "Searching for contentlets with the following parameters: " + contentSearchForm);
         final User user = new WebResource.InitBuilder(webResource)

dotCMS/src/main/webapp/WEB-INF/openapi/openapi.yaml

@@ -717,6 +717,12 @@ paths:
       requestBody:
         content:
           application/json:
+            example:
+              query: +systemType:false +languageId:1 +deleted:false +working:true
+                +variant:default
+              sort: modDate desc
+              limit: 20
+              offset: 0
             schema:
               $ref: "#/components/schemas/SearchForm"
         description: "Search criteria including query, sort, pagination and filters"
@@ -6320,6 +6326,10 @@ paths:
       requestBody:
         content:
           application/json:
+            example:
+              globalSearch: test
+              perPage: 20
+              page: 1
             schema:
               $ref: "#/components/schemas/ContentSearchForm"
         description: Content search parameters