Skip to content

Adds index API requests and responses - part 1 #2979

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
Merged
merged 18 commits into from
Oct 7, 2024
Merged

Adds index API requests and responses - part 1 #2979

merged 18 commits into from
Oct 7, 2024

Conversation

szabosteve
Copy link
Contributor

Overview

Related to #2482.
This PR adds request and response examples to the index API. As this is an extensive namespace, I separated the work into two PRs, so it's easier to overview/review.
@szabosteve szabosteve requested a review from lcawl October 2, 2024 15:17
@szabosteve szabosteve mentioned this pull request Oct 2, 2024
Closed
65 tasks
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
1 similar comment
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
1 similar comment
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
lcawl
lcawl approved these changes Oct 3, 2024
View reviewed changes
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 242/242 242/242
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1042/1128 1128/1128
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle ⚪ Missing test Missing test

You can validate these APIs yourself by using the make validate target.
@szabosteve szabosteve merged commit 470590b into main Oct 7, 2024
6 checks passed
@szabosteve szabosteve deleted the api-examples-pt6 branch October 7, 2024 07:11
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 7, 2024

The backport to 8.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub git fetch # Create a new working tree git worktree add .worktrees/backport-8.x 8.x # Navigate to the new working tree cd .worktrees/backport-8.x # Create a new branch git switch --create backport-2979-to-8.x # Cherry-pick the merged commit of this pull request and resolve the conflicts git cherry-pick -x --mainline 1 470590b5e9ca03ae236c9d3db25b01d6f9c554e1 # Push it to GitHub git push --set-upstream origin backport-2979-to-8.x # Go back to the original working tree cd ../.. # Delete the working tree git worktree remove .worktrees/backport-8.x

Then, create a pull request where the base branch is 8.x and the compare/head branch is backport-2979-to-8.x.
This was referenced Oct 7, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 8.19 specification

2 participants

@szabosteve @lcawl