Search/Simple API endpoints do not provide Descriptions for Parameters in API Browser

[drewmiranda-gl]

The Search/Simple API endpoints were introduced to both allow for easier use of programmatically querying and exporting data form graylog, as well as replace the use of existing and deprecated methods.

However, these API endpoints have parameters that are not self explanatory and the API Browser does not provide descriptions for the parameters:

get /search/aggregate

get /search/messages

Expected Behavior

API Browser provides documentation and descriptions for parameters so that users can understand how to use them.

Current Behavior

Missing parameter descriptions.

Possible Solution

Add parameter descriptions.

Steps to Reproduce (for bugs)

Context

This topic is of recent relevance as there have been breaking changes to the existing API endpoints.

Your Environment

• Graylog Version: 6.1.1
• Java Version: Bundled
• OpenSearch Version: 2.15.0
• MongoDB Version: 7.0.14
• Operating System: Ubuntu Server 22.04 LTS
• Browser version: Google Chrome Version 130.0.6723.70 (Official Build) (arm64)

Please let me know if there are any questions.