[Backport 4.2.x] Separate docs for _search and _msearch (#7731)

* Separate docs for _search and _msearch Updated summary and description to differentiate these two end points. * remove mention of q query parameter --------- Co-authored-by: Jody Garnett <[email protected]>
geonetwork · Feb 9, 2024 · 9e4603f · 9e4603f
1 parent a4045ee
commit 9e4603f
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/services/src/main/java/org/fao/geonet/api/es/EsHTTPProxy.java b/services/src/main/java/org/fao/geonet/api/es/EsHTTPProxy.java
@@ -265,8 +265,8 @@ private static boolean hasOperation(ObjectNode doc, ReservedGroup group, Reserve
 
 
     @io.swagger.v3.oas.annotations.Operation(
-        summary = "Search endpoint",
-        description = "See https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html for search parameters details.")
+        summary = "Execute a search query and get back search hits that match the query.",
+        description = "The search API execute a search query with a JSON request body. For more information see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html for search parameters, and https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html JSON Query DSL.")
     @RequestMapping(value = "/search/records/_search",
         method = RequestMethod.POST,
         produces = MediaType.APPLICATION_JSON_VALUE,
@@ -303,8 +303,8 @@ public void search(
 
 
     @io.swagger.v3.oas.annotations.Operation(
-        summary = "Search endpoint",
-        description = "See https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html for search parameters details.")
+        summary = "Executes several searches with a Elasticsearch API request.",
+        description = "The multi search API executes several searches from a single API request. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html for search parameters, and https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html Query DSL.")
     @RequestMapping(value = "/search/records/_msearch",
         method = RequestMethod.POST,
         produces = MediaType.APPLICATION_JSON_VALUE,