Skip to content

feat(website): add docs::warnings macro support and warn about no auth#24866

Open
thomasqueirozb wants to merge 1 commit intomasterfrom
thomas/api-no-auth-warning
Open

feat(website): add docs::warnings macro support and warn about no auth#24866
thomasqueirozb wants to merge 1 commit intomasterfrom
thomas/api-no-auth-warning

Conversation

@thomasqueirozb
Copy link
Contributor

Summary

  • Adds support for a new docs::warnings metadata key in the #[configurable] macro, allowing warnings to be attached to any configuration option and emitted as warnings: [...] in the generated CUE docs
  • Applies this to the api global option to warn users that the API has no authentication and exposes all event data

Vector configuration

NA

How did you test this PR?

NA

Change Type

  • Bug fix
  • New feature
  • Dependencies
  • Non-functional (chore, refactoring, docs)
  • Performance

Is this a breaking change?

  • Yes
  • No

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the no-changelog label to this PR.

References

NA

@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Mar 6, 2026
@thomasqueirozb thomasqueirozb marked this pull request as ready for review March 6, 2026 23:29
@thomasqueirozb thomasqueirozb requested review from a team as code owners March 6, 2026 23:29
@thomasqueirozb thomasqueirozb added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Mar 6, 2026
@thomasqueirozb thomasqueirozb changed the title feat(api): add docs::warnings macro support and warn about no auth feat(website): add docs::warnings macro support and warn about no auth Mar 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain: external docs Anything related to Vector's external, public documentation no-changelog Changes in this PR do not need user-facing explanations in the release changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants