Skip to content

Add documentation for opensearch_api source#12470

Open
divakarsingh wants to merge 2 commits into
opensearch-project:mainfrom
divakarsingh:docs/opensearch-api-source
Open

Add documentation for opensearch_api source#12470
divakarsingh wants to merge 2 commits into
opensearch-project:mainfrom
divakarsingh:docs/opensearch-api-source

Conversation

@divakarsingh

Copy link
Copy Markdown

Description

Adds documentation page for the opensearch_api source plugin. This source accepts HTTP requests compatible with the OpenSearch Bulk API, allowing standard OpenSearch clients (Flink connector, opensearch-py, Logstash) to send data directly to Data Prepper. The page covers configuration parameters, authentication, supported bulk actions, event metadata attributes, response format, buffer compatibility, metrics, and usage examples.

Issues Resolved

Closes #12460

Version

2.6--current

Frontend features

N/A - this is a backend/pipeline documentation page.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.

@github-actions

Copy link
Copy Markdown

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference).

  Resolves opensearch-project#12460

  Signed-off-by: Divakar Pratap Singh <divakar.p.singh@gmail.com>

Signed-off-by: Divakar Pratap Singh <divakar.p.singh@gmail.com>
@divakarsingh divakarsingh force-pushed the docs/opensearch-api-source branch from 61d60f6 to bd0ebf6 Compare May 27, 2026 09:02
@kolchfa-aws

Copy link
Copy Markdown
Collaborator

@dlvenable Could you review this PR please?

added doc changes as per the response format changes made in this PR opensearch-project#6878

Signed-off-by: Divakar Singh <divakarsingh@users.noreply.github.com>
@divakarsingh

Copy link
Copy Markdown
Author

@dlvenable Could you review this PR please?

Made a change (return format) in doc as per this PR: opensearch-project/data-prepper#6878

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.

[DOC] Add documentation page for opensearch_api source in Data Prepper

2 participants