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] Adds descriptions for Enrich APIs #2215

Merged
merged 5 commits into from
Aug 2, 2023
Merged

Conversation

szabosteve
Copy link
Contributor

Overview

Related to #964.

Adds descriptions to Enrich API properties. Source of info: https://www.elastic.co/guide/en/elasticsearch/reference/master/enrich-apis.html

@szabosteve szabosteve changed the title Szabosteve/enrich [DOCS] Adds descriptions for Enrich APIs Aug 2, 2023
Copy link
Contributor

@abdonpijpelink abdonpijpelink left a comment

Choose a reason for hiding this comment

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

LGTM. Left a few non-blocking comments.

/**
* Objects containing information about each coordinating ingest node for
* configured enrich processors.
*/
coordinator_stats: CoordinatorStats[]
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe that's on your radar already, but we shouldn't forget to add descriptions for ExecutingPolicy and CoordinatorStats too (here).

specification/enrich/put_policy/PutEnrichPolicyRequest.ts Outdated Show resolved Hide resolved
@szabosteve
Copy link
Contributor Author

@abdonpijpelink Thanks for your review. I addressed your comments via b2361b7.

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2023

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

API Status Request Response
enrich.delete_policy 🟢 5/5 5/5
enrich.execute_policy 🟢 6/6 6/6
enrich.get_policy 🟢 6/6 6/6
enrich.put_policy 🟢 6/6 6/6
enrich.stats 🟢 5/5 5/5

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

@szabosteve szabosteve merged commit e4cbd9f into main Aug 2, 2023
5 checks passed
@szabosteve szabosteve deleted the szabosteve/enrich branch August 2, 2023 11:51
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