Skip to content

adding termvector and mtermvector api docs #10004

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

Merged

Conversation

AntonEliatra
Copy link
Contributor

Description

adding termvector and mtermvector api docs

Issues Resolved

Closes #2108

Version

all

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.

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Copy link

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.

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
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, @AntonEliatra! Could you update the path parameter and query parameter descriptions as suggested in the API Spec repo and flag @natebower for editorial review? Whenever possible, do not duplicate descriptions but rather have multiple parameters reference the same description using $ref. Once updated, please regenerate this doc.

AntonEliatra and others added 5 commits June 3, 2025 20:26
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
…a/documentation-website into adding-mtermvectors-api-docs
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
@kolchfa-aws kolchfa-aws added the Doc review PR: Doc review in progress label Jun 4, 2025
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
@AntonEliatra
Copy link
Contributor Author

@kolchfa-aws thats updated now with the api-spec changes and ready for 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.

Thanks, @AntonEliatra. Some suggestions before we move to editorial review.

Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
@AntonEliatra
Copy link
Contributor Author

@kolchfa-aws thats updated now

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.

LGTM. Thank you, @AntonEliatra!

@kolchfa-aws kolchfa-aws added Editorial review PR: Editorial review in progress and removed Doc review PR: Doc review in progress labels Jun 23, 2025
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@AntonEliatra Please see my changes and tag me for approval when addressed. Thanks!

AntonEliatra and others added 2 commits June 24, 2025 11:41
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
@AntonEliatra
Copy link
Contributor Author

@natebower thats updated now

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

Thanks @AntonEliatra! LGTM

@natebower natebower removed their assignment Jun 24, 2025
@natebower natebower removed the Editorial review PR: Editorial review in progress label Jun 24, 2025
@natebower natebower merged commit 5d8240a into opensearch-project:main Jun 24, 2025
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jun 24, 2025
* adding termvecto and mtermvector api docs

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* adding termvecto and mtermvector api docs

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

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

* updating as per the PR review

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* addressing the PR comments

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* fixing vale errors

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* updating the PR with the latest changes from the API spec

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* updating the table of response fields

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* fixing vale errors

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* fixing vale

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

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

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* removing the api spec automation to accomodate the changes requested

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

---------

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit 5d8240a)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@AntonEliatra AntonEliatra deleted the adding-mtermvectors-api-docs branch June 24, 2025 19:44
akshansh-modi pushed a commit to akshansh-modi/documentation-website that referenced this pull request Jul 2, 2025
* adding termvecto and mtermvector api docs

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* adding termvecto and mtermvector api docs

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

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

* updating as per the PR review

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* addressing the PR comments

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* fixing vale errors

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* updating the PR with the latest changes from the API spec

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* updating the table of response fields

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* fixing vale errors

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* fixing vale

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

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

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* removing the api spec automation to accomodate the changes requested

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

---------

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: apple <akshanshmodi2002@gmail.com>
epugh pushed a commit to o19s/documentation-website that referenced this pull request Jul 2, 2025
* adding termvecto and mtermvector api docs

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* adding termvecto and mtermvector api docs

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

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

* updating as per the PR review

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* addressing the PR comments

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* fixing vale errors

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* updating the PR with the latest changes from the API spec

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* updating the table of response fields

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* fixing vale errors

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* fixing vale

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

* Apply suggestions from code review

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

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>

* removing the api spec automation to accomodate the changes requested

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>

---------

Signed-off-by: Anton Rubin <anton.rubin@eliatra.com>
Signed-off-by: AntonEliatra <anton.rubin@eliatra.com>
Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC]Create documentation for _mtermvectors API
3 participants