Skip to content

docs(elasticsearch sink): fix invalid version field example - #25957

Open
ypid-work wants to merge 1 commit into
vectordotdev:masterfrom
ypid-work:docs/elasticsearch-sink
Open

docs(elasticsearch sink): fix invalid version field example#25957
ypid-work wants to merge 1 commit into
vectordotdev:masterfrom
ypid-work:docs/elasticsearch-sink

Conversation

@ypid-work

Copy link
Copy Markdown

Summary

The given example is bad because it is invalid for Elasticsearch due to:

It must be a non-negative long number.

Ref: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-version

Better use two examples to show the features of the templating.

Vector configuration

How did you test this PR?

  • Tried to create doc with a non-long version on OpenSearch v3.x -> fails with illegal_argument_exception
  • ./scripts/cue.sh fmt

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

More specifically: https://github.com/vectordotdev/vector/pull/20102/changes#diff-4ddfc8ed62933b9dda997c8f490bfe56e87de0f809eaf318f5f690e2d27e9a57R265

The given example is bad because it is invalid for Elasticsearch due to:

> It must be a non-negative long number.

Ref: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-version

Better use two examples to show the features of the templating.

Introduced in: https://github.com/vectordotdev/vector/pull/20102/changes#diff-4ddfc8ed62933b9dda997c8f490bfe56e87de0f809eaf318f5f690e2d27e9a57R265
Introduced in: 8a20f05
@ypid-work
ypid-work requested review from a team as code owners July 28, 2026 13:12
@github-actions

github-actions Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@github-actions github-actions Bot added domain: sinks Anything related to the Vector's sinks domain: external docs Anything related to Vector's external, public documentation docs review on hold The documentation team reviews PRs only after a PR is approved by the COSE team. labels Jul 28, 2026
@datadog-vectordotdev

datadog-vectordotdev Bot commented Jul 28, 2026

Copy link
Copy Markdown

Pipelines

⚠️ Warnings

🚦 1 Pipeline job failed

Changelog | validate-changelog   View in Datadog   GitHub Actions

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: efe9ba1 | Docs | Datadog PR Page | Give us feedback!

@ypid-work

Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

@pront pront left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@pront
pront enabled auto-merge July 28, 2026 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs review on hold The documentation team reviews PRs only after a PR is approved by the COSE team. domain: external docs Anything related to Vector's external, public documentation domain: sinks Anything related to the Vector's sinks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants