Skip to content

Add provisioned_by field to connector, model, and agent API documentation#12181

Merged
kolchfa-aws merged 2 commits into
opensearch-project:mainfrom
dbwiddis:created-by
Jun 4, 2026
Merged

Add provisioned_by field to connector, model, and agent API documentation#12181
kolchfa-aws merged 2 commits into
opensearch-project:mainfrom
dbwiddis:created-by

Conversation

@dbwiddis

@dbwiddis dbwiddis commented Mar 31, 2026

Copy link
Copy Markdown
Member

Description

Documents the new provisioned_by field added in ml-commons for OpenSearch 3.7.
This field is an optional attribution tag identifying the plugin or client that
provisioned the resource (e.g., flow-framework). Included in ML stats metrics.

Added to:

  • register-agent.md request body table
  • register-model.md request body tables (pretrained, custom, externally hosted)
  • blueprints.md connector configuration parameters table

Issues Resolved

Closes #12179

Version

3.7.0

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.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@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).

@kolchfa-aws kolchfa-aws added Tech review PR: Tech review in progress release-notes PR: Include this PR in the automated release notes v3.7.0 labels Mar 31, 2026
@dbwiddis dbwiddis requested a review from mgodwan as a code owner May 21, 2026 18:14
@dbwiddis dbwiddis changed the title Add created_by field to connector, model, and agent API documentation Add provisioned_by field to connector, model, and agent API documentation May 21, 2026
@dbwiddis dbwiddis added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Jun 4, 2026
@dbwiddis

dbwiddis commented Jun 4, 2026

Copy link
Copy Markdown
Member Author

@kolchfa-aws tech review complete

…tion

Documents the new provisioned_by field added in ml-commons for OpenSearch 3.7.
This field is an optional attribution tag identifying the plugin or client that
provisioned the resource (e.g., flow-framework). Included in ML stats metrics.

Added to:
- register-agent.md request body table
- register-model.md request body tables (pretrained, custom, externally hosted)
- blueprints.md connector configuration parameters table

Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Dan Widdis <widdisd@amazon.com>
Comment thread _ml-commons-plugin/api/agent-apis/register-agent.md Outdated
Comment thread _ml-commons-plugin/api/model-apis/register-model.md Outdated
Comment thread _ml-commons-plugin/api/model-apis/register-model.md Outdated
Comment thread _ml-commons-plugin/api/model-apis/register-model.md Outdated
Comment thread _ml-commons-plugin/api/model-apis/register-model.md Outdated
Comment thread _ml-commons-plugin/remote-models/blueprints.md Outdated
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

@kolchfa-aws kolchfa-aws left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you, @dbwiddis! Editorial review complete and changes applied.

@kolchfa-aws kolchfa-aws merged commit 97ff813 into opensearch-project:main Jun 4, 2026
6 checks passed
aryasoni98 pushed a commit to aryasoni98/documentation-website that referenced this pull request Jun 29, 2026
…tion (opensearch-project#12181)

* Add provisioned_by field to connector, model, and agent API documentation

Documents the new provisioned_by field added in ml-commons for OpenSearch 3.7.
This field is an optional attribution tag identifying the plugin or client that
provisioned the resource (e.g., flow-framework). Included in ML stats metrics.

Added to:
- register-agent.md request body table
- register-model.md request body tables (pretrained, custom, externally hosted)
- blueprints.md connector configuration parameters table

Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Dan Widdis <widdisd@amazon.com>

* Apply suggestions from code review

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

---------

Signed-off-by: Daniel Widdis <widdis@gmail.com>
Signed-off-by: Dan Widdis <widdisd@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Arya Soni <aryasoni98@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v3.7.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Add provisioned_by field to connector, model, and agent API documentation

3 participants