Documentation / Elasticsearch query endpoint - query samples

[josegar74]

Checklist

• I have read the contribution guidelines
• Pull request provided for main branch, backports managed with label
• Good housekeeping of code, cleaning up comments, tests, and documentation
• Clean commit history broken into understandable chucks, avoiding big commits with hundreds of files, cautious of reformatting and whitespace changes
• Clean commit messages, longer verbose messages are encouraged
• API Changes are identified in commit messages
• Testing provided for features or enhancements using automatic tests
• User documentation provided for new features or enhancements in manual
• Build documentation provided for development instructions in README.md files
• Library management using pom.xml dependency management. Update build documentation with intended library use and library tutorials or documentation

[jodygarnett]

This is very much appreciated, I am providing some suggestions inline, but they are not required.

• The previous documentation (which people are migrating from provided) some discussion of the parameters, and ready to use example against localhost: https://docs.geonetwork-opensource.org/3.12/api/search/#query-examples

• Running from swagger is arguably more useful (than providing localhost:8080 example).

Following the instructions I was able to produce the following curl command:

curl -X POST "https://how2map.geocat.live/geonetwork/srv/api/search/records/_search?bucket=metadata" -H "accept: application/json" -H "Content-Type: application/json" -H "X-XSRF-TOKEN: 5c4837fd-3e39-489b-8e80-db298503541d" -d "{\"query\":{\"bool\":{\"must\":[{\"query_string\":{\"query\":\"+anytext: ocean \"}}],\"filter\":[{\"term\":{\"isTemplate\":{\"value\":\"n\"}}}]}}}"

[jodygarnett]

@josegar74 I have updated the PR based on my feedback.

Changes:

• Documented both _search and _msearch
• Headings for each example (so we can specifically link to them when sharing an example with a customer).
• Ideally I would like this page to grow over time as we answer support questions