Adds index API requests and responses - part 1 #2979

szabosteve · 2024-10-02T15:16:53Z

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.

github-actions · 2024-10-02T15:18:42Z

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 · 2024-10-02T15:24:32Z

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 · 2024-10-02T15:24:39Z

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 · 2024-10-03T02:04:57Z

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 · 2024-10-03T02:13:08Z

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 · 2024-10-03T02:21:20Z

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 · 2024-10-03T02:27:46Z

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 · 2024-10-03T02:36:43Z

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 · 2024-10-03T16:50:39Z

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 · 2024-10-03T17:12:04Z

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 · 2024-10-03T20:08:57Z

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 · 2024-10-03T20:15:27Z

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 · 2024-10-03T20:36:51Z

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 · 2024-10-03T20:39:47Z

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 · 2024-10-03T20:40:03Z

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 · 2024-10-03T20:55:23Z

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

LGTM

github-actions · 2024-10-03T20:57:00Z

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 · 2024-10-07T07:12:13Z

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.

szabosteve added 2 commits September 25, 2024 16:49

Add indices API request and response examples - add block to close.

fe02053

Adds index API requests and responses - part 1.

b91c04f

szabosteve added the backport 8.x label Oct 2, 2024

github-actions bot added specification and removed backport 8.x labels Oct 2, 2024

szabosteve added the backport 8.x label Oct 2, 2024

szabosteve requested a review from lcawl October 2, 2024 15:17

szabosteve mentioned this pull request Oct 2, 2024

[DOCS] Add examples to API endpoints #2482

Open

58 tasks

szabosteve added 2 commits October 2, 2024 17:22

Fixes format.

02db0ac

Merge branch 'main' into api-examples-pt6

8eb7f05

Add overlay for add block example

4025363

Add overlay for analyze example

c2e215f

Add overlay for clone index example

0103eae

Add overlay for close index example

eec95d8

Add overlay for create index examples

9729a32

Add example overlay for data stream stats and delete lifecycle

e71f2a3

Add example overlays for open index, get data stream, get lifecycle

4456048

Add example overlays for update data stream lifecycle

d2d7eef

Add example overlay for explain data stream lifecycle

d46dc04

Comment out extra example fields

eaa911e

lcawl added 2 commits October 3, 2024 13:37

Fix extra spaces

f5f399e

Merge branch 'main' into api-examples-pt6

815ac39

lcawl added 2 commits October 3, 2024 13:53

Comment out more example fields

4d4d23a

Comment out more example fields

76455d6

lcawl approved these changes Oct 3, 2024

View reviewed changes

szabosteve merged commit 470590b into main Oct 7, 2024
6 checks passed

szabosteve deleted the api-examples-pt6 branch October 7, 2024 07:11

This was referenced Oct 7, 2024

[8.x] Adds index API requests and responses - part 1 #2988

Merged

Adds index API requests and responses - part 2 #2993

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds index API requests and responses - part 1 #2979

Adds index API requests and responses - part 1 #2979

szabosteve commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

lcawl left a comment

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 7, 2024

Adds index API requests and responses - part 1 #2979

Adds index API requests and responses - part 1 #2979

Conversation

szabosteve commented Oct 2, 2024

Overview

github-actions bot commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

github-actions bot commented Oct 2, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 3, 2024

lcawl left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 3, 2024

github-actions bot commented Oct 7, 2024