Add operation summaries for index template APIs #2634

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

lcawl merged 8 commits into main from oas-docs

Jun 27, 2024

Contributor

lcawl commented Jun 20, 2024 •

edited

Loading

This PR adds the sumarries for the index template APIs (using text from the appropriate pages under https://www.elastic.co/guide/en/elasticsearch/reference/current/indices.html).

It also updates the make lint-docs command to lint all the *.json files in the output folder and updates the readme to include the other new make commands.


          Add summary for simulate index API

a0494e4

github-actions bot added documentation specification labels

Contributor

github-actions bot commented Jun 20, 2024

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

API	Status	Request	Response
`indices.simulate_index_template`	🔴	6/7	5/7

You can validate this API yourself by using the make validate target.


          Add operation summary explanation

6b1e923

Contributor

github-actions bot commented Jun 20, 2024

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

API	Status	Request	Response
`indices.simulate_index_template`	🔴	6/7	5/7

You can validate this API yourself by using the make validate target.

lcawl requested a review from l-trotta

June 20, 2024 17:35

lcawl mentioned this pull request

[DOCS] Improve serverless operation summaries #2635

Closed

shainaraskas reviewed

View reviewed changes

docs/doc-comments-guide.md Outdated Show resolved Hide resolved


          Update docs/doc-comments-guide.md

Co-authored-by: shainaraskas <[email protected]>

Contributor

github-actions bot commented Jun 21, 2024

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

API	Status	Request	Response
`indices.simulate_index_template`	🔴	6/7	5/7

You can validate this API yourself by using the make validate target.


          Add summary to IndicesGetIndexTemplateRequest

098ce3f

Contributor

github-actions bot commented Jun 21, 2024

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

API	Status	Request	Response
`indices.get_index_template`	🔴	19/19	15/19
`indices.simulate_index_template`	🔴	6/7	5/7

You can validate these APIs yourself by using the make validate target.


          Add more index template operation summaries

1e57712

Contributor

github-actions bot commented Jun 21, 2024

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

API	Status	Request	Response
`indices.delete_index_template`	🟢	1/1	1/1
`indices.exists_template`	🟢	15/15	15/15
`indices.get_index_template`	🔴	19/19	15/19
`indices.get_template`	🟢	30/30	30/30
`indices.put_index_template`	🔴	50/52	52/52
`indices.put_template`	🔴	44/49	49/49
`indices.simulate_index_template`	🔴	6/7	5/7
`indices.simulate_template`	🔴	5/5	4/5

You can validate these APIs yourself by using the make validate target.

lcawl changed the title ~~Add summary for simulate index API~~ Add operation summaries for index template APIs


          Add lint-docs-serverless

7ac943a

Contributor

github-actions bot commented Jun 21, 2024

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

API	Status	Request	Response
`indices.delete_index_template`	🟢	1/1	1/1
`indices.exists_template`	🟢	15/15	15/15
`indices.get_index_template`	🔴	19/19	15/19
`indices.get_template`	🟢	30/30	30/30
`indices.put_index_template`	🔴	50/52	52/52
`indices.put_template`	🔴	44/49	49/49
`indices.simulate_index_template`	🔴	6/7	5/7
`indices.simulate_template`	🔴	5/5	4/5

You can validate these APIs yourself by using the make validate target.


          Merge branch 'main' into oas-docs

b48b1ec

Contributor

github-actions bot commented Jun 27, 2024

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

API	Status	Request	Response
`indices.delete_index_template`	🟢	1/1	1/1
`indices.exists_template`	🟢	15/15	15/15
`indices.get_index_template`	🔴	19/19	15/19
`indices.get_template`	🟢	30/30	30/30
`indices.put_index_template`	🔴	50/52	52/52
`indices.put_template`	🔴	44/49	49/49
`indices.simulate_index_template`	🔴	6/7	5/7
`indices.simulate_template`	🔴	5/5	4/5

You can validate these APIs yourself by using the make validate target.


          Fix note about operation summaries

66acbb5

Contributor

github-actions bot commented Jun 27, 2024

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

API	Status	Request	Response
`indices.delete_index_template`	🟢	1/1	1/1
`indices.exists_template`	🟢	15/15	15/15
`indices.get_index_template`	🔴	19/19	15/19
`indices.get_template`	🟢	30/30	30/30
`indices.put_index_template`	🔴	50/52	52/52
`indices.put_template`	🔴	44/49	49/49
`indices.simulate_index_template`	🔴	6/7	5/7
`indices.simulate_template`	🔴	5/5	4/5

You can validate these APIs yourself by using the make validate target.

l-trotta approved these changes

View reviewed changes

lcawl merged commit 745db53 into main

6 checks passed

lcawl deleted the oas-docs branch

June 27, 2024 14:39

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation specification