Skip to content

refactor(config): remove component base metadata - #26459

Merged
pront merged 2 commits into
masterfrom
pront-remove-component-base-metadata
Sep 22, 2026
Merged

pront merged 2 commits into
masterfrom
pront-remove-component-base-metadata

Conversation

@pront

@pront pront commented Sep 22, 2026 •

Copy link
Copy Markdown
Member

Summary

Previously, SourceOuter carried an extra tag:

"_metadata": {
  "docs::component_base_type": "source"
}

The docs generator searched for that tag to find the shared source configuration.

Now it follows the relationship already in the schema—simplified here:

{
  "properties": {
    "sources": {
      "additionalProperties": {
        "$ref": "#/definitions/SourceOuter"
      }
    }
  }
}

That says: every entry under sources uses SourceOuter. So we can discover the wrapper without separately tagging it.

The same reference also tells the schema generator to preserve that definition instead of inlining it. The same approach applies to sinks and transforms.

No user configuration changes. Same validation and generated docs; one redundant metadata tag removed.

References

Related: #26450. This PR is based directly on master and does not include the coercion changes.

Vector configuration

Not applicable; configuration behavior is unchanged.

How did you test this PR?

  • 78 schema/config tests and 12 component-docs tests passed, including new root-map discovery, reference-cycle, and wrapper-preservation regressions.
  • Clippy passed for all targets in vector-config-common, vector-config, docs-renderer, and vdev.
  • Compared full default-feature schemas before and after the change: identical after removing only the retired metadata from the baseline.
  • Regenerated component docs, VRL docs, and examples with the updated local generator; no generated files changed.
  • make fmt and git diff --check passed.

Does this PR include user facing changes?

  • Yes.
  • No. A maintainer will apply the no-changelog label to this PR.

Contributor Guidelines

  • Please read our Vector contributor resources.
  • Do not hesitate to use @vectordotdev/vector to reach out to us regarding this PR.
  • Before pushing, follow our pre-push guidance.
  • After a review is requested, please avoid force pushes to help us review incrementally.
    • Feel free to push as many commits as you want. They will be squashed into one before merging.
    • For example, you can run git merge origin master and git push.

@pront
pront requested a review from a team as a code owner September 22, 2026 15:01
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-22T15:05:31.085081Z b2b8a31 PR opened
🔒 Security Review ✅ Completed 2026-09-22T15:06:19.324671Z b2b8a31 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions github-actions Bot added the domain: vdev Anything related to the vdev tooling label Sep 22, 2026
@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Sep 22, 2026
@pront
pront enabled auto-merge September 22, 2026 15:39
@pront
pront added this pull request to the merge queue Sep 22, 2026
Merged via the queue into master with commit 7ec3c64 Sep 22, 2026
82 checks passed
@pront
pront deleted the pront-remove-component-base-metadata branch September 22, 2026 16:34
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 22, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

domain: vdev Anything related to the vdev tooling 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