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.

Sign up for GitHub

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

Jump to bottom

Fix put rollup job api documentation #3637

Merged
merged 2 commits into from
Apr 10, 2023
Merged

Fix put rollup job api documentation #3637

merged 2 commits into from
Apr 10, 2023

Conversation

tanqiuliu
Copy link
Contributor

Description

  • In the current example request for Index Rollup API -> Create or update an index rollup job, dimensions and metrics fields are incorrect and will encounter parsing_exception when calling with OpenSearch.
  • This PR fix the the example request following the correct format. Tested against OpenSearch and the call succeeded.
  • Referred to Index Rollup ISM operation and Index Rollup API source code to come up with the correct request.
  • Also updated the description of dimensions and metrics field. Referred to Index Transform API documentation for the wording.

Issues Resolved

More details described in #3636

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.

@tanqiuliu tanqiuliu requested a review from a team as a code owner March 30, 2023 08:03
@tanqiuliu tanqiuliu mentioned this pull request Mar 30, 2023
Closed
4 tasks
@ariamarble ariamarble self-assigned this Mar 30, 2023
@tanqiuliu
Copy link
Contributor Author

@Naarcha-AWS @ariamarble Could you review this PR when you have time? It should be quite straight forward

vagimeli
vagimeli approved these changes Apr 10, 2023
View reviewed changes
Copy link
Collaborator

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

@ariamarble Looks good. Minimal comments.

_im-plugin/index-rollups/rollup-api.md Outdated Show resolved Hide resolved
_im-plugin/index-rollups/rollup-api.md Outdated Show resolved Hide resolved
@ariamarble ariamarble added API backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x index-management 4 - Doc review PR: Doc review in progress backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 Sev3 Medium priority. Content that's missing, driven by dev, PM or the community. backport 2.6 PR: Backport label for 2.6 labels Apr 10, 2023
@ariamarble ariamarble added this to the Q3 - 2023 milestone Apr 10, 2023
@ariamarble ariamarble merged commit 165e4cb into opensearch-project:main Apr 10, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 10, 2023
@github-actions @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
42842f1 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
(cherry picked from commit 165e4cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This was referenced Apr 10, 2023
Merged
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 10, 2023
@github-actions @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
803e5a9 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
(cherry picked from commit 165e4cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 10, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 10, 2023
@github-actions @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
8af5907 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
(cherry picked from commit 165e4cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 10, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 10, 2023
@github-actions @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
9cb5f91 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
(cherry picked from commit 165e4cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 10, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 10, 2023
@github-actions @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
015f28e 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
(cherry picked from commit 165e4cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 10, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 10, 2023
@github-actions @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
90ba978 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
(cherry picked from commit 165e4cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 10, 2023
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 10, 2023
@github-actions @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
840929b 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
(cherry picked from commit 165e4cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 10, 2023
@github-actions @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
cc603b9 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
(cherry picked from commit 165e4cb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Apr 10, 2023
Merged
ariamarble added a commit that referenced this pull request Apr 10, 2023
@opensearch-trigger-bot @github-actions
@ariamarble @vagimeli
Fix put rollup job api documentation (#3637) (#3740)
193689e 
* Fix put rollup job api documentation



* Apply suggestions from code review



---------




(cherry picked from commit 165e4cb)

Signed-off-by: Tanqiu Liu <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
ariamarble added a commit that referenced this pull request Apr 10, 2023
@opensearch-trigger-bot @github-actions
@ariamarble @vagimeli
Fix put rollup job api documentation (#3637) (#3734)
6717e81 
* Fix put rollup job api documentation



* Apply suggestions from code review



---------




(cherry picked from commit 165e4cb)

Signed-off-by: Tanqiu Liu <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
ariamarble added a commit that referenced this pull request Apr 10, 2023
@opensearch-trigger-bot @github-actions
@ariamarble @vagimeli
Fix put rollup job api documentation (#3637) (#3738)
311b762 
* Fix put rollup job api documentation



* Apply suggestions from code review



---------




(cherry picked from commit 165e4cb)

Signed-off-by: Tanqiu Liu <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
ariamarble added a commit that referenced this pull request Apr 10, 2023
@opensearch-trigger-bot @github-actions
@ariamarble @vagimeli
Fix put rollup job api documentation (#3637) (#3739)
f78227a 
* Fix put rollup job api documentation



* Apply suggestions from code review



---------




(cherry picked from commit 165e4cb)

Signed-off-by: Tanqiu Liu <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
ariamarble added a commit that referenced this pull request Apr 10, 2023
@opensearch-trigger-bot @github-actions
@ariamarble @vagimeli
Fix put rollup job api documentation (#3637) (#3737)
4e3ad89 
* Fix put rollup job api documentation



* Apply suggestions from code review



---------




(cherry picked from commit 165e4cb)

Signed-off-by: Tanqiu Liu <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
ariamarble added a commit that referenced this pull request Apr 10, 2023
@opensearch-trigger-bot @github-actions
@ariamarble @vagimeli
Fix put rollup job api documentation (#3637) (#3735)
f32c2d5 
* Fix put rollup job api documentation



* Apply suggestions from code review



---------




(cherry picked from commit 165e4cb)

Signed-off-by: Tanqiu Liu <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
ariamarble added a commit that referenced this pull request Apr 10, 2023
@opensearch-trigger-bot @github-actions
@ariamarble @vagimeli
Fix put rollup job api documentation (#3637) (#3733)
3903366 
* Fix put rollup job api documentation



* Apply suggestions from code review



---------




(cherry picked from commit 165e4cb)

Signed-off-by: Tanqiu Liu <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Naarcha-AWS pushed a commit that referenced this pull request Apr 11, 2023
@opensearch-trigger-bot @github-actions
@ariamarble @vagimeli
Fix put rollup job api documentation (#3637) (#3736)
5025e2a 
* Fix put rollup job api documentation



* Apply suggestions from code review



---------




(cherry picked from commit 165e4cb)

Signed-off-by: Tanqiu Liu <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
vagimeli added a commit that referenced this pull request Apr 25, 2023
@tanqiuliu @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
2d74967 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
vagimeli added a commit that referenced this pull request Apr 25, 2023
@vagimeli
Revert "Fix put rollup job api documentation (#3637)"
2a26593 
This reverts commit 2d74967.
vagimeli added a commit that referenced this pull request May 4, 2023
@tanqiuliu @ariamarble @vagimeli
Fix put rollup job api documentation (#3637)
d015a8c 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
vagimeli added a commit that referenced this pull request May 4, 2023
@vagimeli
Revert "Fix put rollup job api documentation (#3637)"
5916a53 
This reverts commit d015a8c.
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
@tanqiuliu @ariamarble
@vagimeli @harshavamsi
Fix put rollup job api documentation (opensearch-project#3637)
abb89db 
* Fix put rollup job api documentation

Signed-off-by: Tanqiu Liu <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Tanqiu Liu <[email protected]>
Co-authored-by: Aria Marble <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Naarcha-AWS Naarcha-AWS Naarcha-AWS approved these changes

@vagimeli vagimeli vagimeli approved these changes

Assignees

@ariamarble ariamarble

Labels
4 - Doc review PR: Doc review in progress API backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 index-management Sev3 Medium priority. Content that's missing, driven by dev, PM or the community.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tanqiuliu @Naarcha-AWS @vagimeli @ariamarble