Skip to content

Document file output message type option#2710

Draft
Mirochill wants to merge 1 commit into
certtools:developfrom
Mirochill:docs-2095-output-message-with-type
Draft

Document file output message type option#2710
Mirochill wants to merge 1 commit into
certtools:developfrom
Mirochill:docs-2095-output-message-with-type

Conversation

@Mirochill
Copy link
Copy Markdown

@Mirochill Mirochill commented May 25, 2026

Summary

  • Document the shared event export options supported by the File and Files output bots.
  • Add the missing message_with_type parameter alongside the related raw-field and JSON-dictionary options.

Validation

  • git diff --check -- docs/user/bots.md
  • Fork CI: ReUse License Check passed (run 26417479477).
  • Fork CI: Unit tests passed (run 26417479480).
  • Upstream PR workflows are waiting for maintainer approval.

Fixes #2095

FileOutputBot and FilesOutputBot both use the shared output exporter, which supports keeping the raw field, stringifying JSON dictionary fields, and including the message type in the serialized event. Their user documentation only listed hierarchical_output and single_key, so document the remaining export parameters alongside them.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

file output bot docs: missing parameter description of message_with_type

1 participant