Skip to content

feat: add support for shortdesc, tags and examples in searchbnf.conf#1977

Open
Benni0 wants to merge 1 commit intosplunk:developfrom
Benni0:develop
Open

feat: add support for shortdesc, tags and examples in searchbnf.conf#1977
Benni0 wants to merge 1 commit intosplunk:developfrom
Benni0:develop

Conversation

@Benni0
Copy link
Contributor

@Benni0 Benni0 commented Jan 31, 2026

PR Type

What kind of change does this PR introduce?

  • Feature
  • Bug Fix
  • Refactoring (no functional or API changes)
  • Documentation Update
  • Maintenance (dependency updates, CI, etc.)

Summary

Added support for additional config parameters of searchbnf.conf. This PR allows to specify shortdesc, tags and examples for each custom search command. This parameters are used to display the command description in search assistant.

Changes

Added the parameters shortdesc, tags and examples for custom search command to the schema and modified the generator and the template for searchbnf.conf to support these parameters.

User experience

Now the user can specify the parameters shortdesc, tags and examples in the globalConfig.json which provides the ability to enhance the information displayed in the search assistant.

Checklist

If an item doesn't apply to your changes, leave it unchecked.

Review

  • self-review - I have performed a self-review of this change according to the development guidelines
  • Changes are documented. The documentation is understandable, examples work (more info)
  • PR title and description follows the contributing principles
  • meeting - I have scheduled a meeting or recorded a demo to explain these changes (if there is a video, put a link below and in the ticket)

Tests

See the testing doc.

  • Unit - tests have been added/modified to cover the changes
  • Smoke - tests have been added/modified to cover the changes
  • UI - tests have been added/modified to cover the changes
  • coverage - I have checked the code coverage of my changes (see more)

Demo/meeting:

Reviewers are encouraged to request meetings or demos if any part of the change is unclear

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant