Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add validation requirement for message fields #9000

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

rithin-pullela-aws
Copy link

@rithin-pullela-aws rithin-pullela-aws commented Jan 3, 2025

Description

Add note clarifying that at least one field must be non-null and non-empty for successful message creation/update operations

Issues Resolved

Closes #8999

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
2.19 and above

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

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.

Add note clarifying that at least one field must be non-null
and non-empty for successful message creation/update operations

Signed-off-by: rithin-pullela-aws <rithinp@amazon.com>
Copy link

github-actions bot commented Jan 3, 2025

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial 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). The doc reviewer will arrange for an editorial review.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @rithin-pullela-aws! One suggestion.

_ml-commons-plugin/api/memory-apis/create-message.md Outdated Show resolved Hide resolved
@kolchfa-aws kolchfa-aws added release-notes PR: Include this PR in the automated release notes v2.19.0 labels Jan 3, 2025
rithin-pullela-aws and others added 2 commits January 3, 2025 09:54
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Rithin Pullela <rithinp@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes PR: Include this PR in the automated release notes v2.19.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Include Validation Requirement for Message Creation/Update
2 participants