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.

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

[DOCS] Add warning to create inference API #3311

Merged
merged 6 commits into from
Dec 17, 2024
Merged

[DOCS] Add warning to create inference API #3311

merged 6 commits into from
Dec 17, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Dec 14, 2024

Relates to elastic/elasticsearch#118073

This PR adds the warnings from https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html to https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put

The utils.ts file is updated to address an error when I used @cluster_privileges manage_inference

Copy link
Contributor

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

API Status Request Response
inference.put Missing test Missing test

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

Copy link
Contributor

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

API Status Request Response
inference.put Missing test Missing test

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

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

Left comments inline wrt to a sentence that might need a tweak. The sentence appears in multiple files. Otherwise, LGTM

output/openapi/elasticsearch-openapi.json Show resolved Hide resolved
output/schema/schema.json Show resolved Hide resolved
output/schema/schema.json Outdated Show resolved Hide resolved
specification/inference/put/PutRequest.ts Outdated Show resolved Hide resolved
Copy link
Contributor

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

API Status Request Response
inference.put Missing test Missing test

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

Copy link
Contributor

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

API Status Request Response
inference.put Missing test Missing test

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

@lcawl lcawl merged commit 679ae2b into main Dec 17, 2024
9 checks passed
@lcawl lcawl deleted the inference-warning branch December 17, 2024 02:46
github-actions bot pushed a commit that referenced this pull request Dec 17, 2024
Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
(cherry picked from commit 679ae2b)
github-actions bot pushed a commit that referenced this pull request Dec 17, 2024
Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
(cherry picked from commit 679ae2b)
lcawl added a commit that referenced this pull request Dec 17, 2024
Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
(cherry picked from commit 679ae2b)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
lcawl added a commit that referenced this pull request Dec 19, 2024
Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
(cherry picked from commit 679ae2b)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
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.

2 participants