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

Update doc tag for migration APIs #3564

Merged
merged 1 commit into from
Jan 22, 2025
Merged

Update doc tag for migration APIs #3564

merged 1 commit into from
Jan 22, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 22, 2025

Relates to #3518, elastic/elasticsearch#118291

This PR addresses the following errors returned from make lint-docs-errs:

18464:11  error  operation-tag-defined  Operation tags must be defined in global tags.                            paths./_migration/reindex/{index}/_cancel.post.tags[0]
18499:11  error  operation-tag-defined  Operation tags must be defined in global tags.                            paths./_create_from/{source}/{dest}.put.tags[0]
18524:11  error  operation-tag-defined  Operation tags must be defined in global tags.                            paths./_create_from/{source}/{dest}.post.tags[0]
18551:11  error  operation-tag-defined  Operation tags must be defined in global tags.                            paths./_migration/reindex/{index}/_status.get.tags[0]
18634:11  error  operation-tag-defined  Operation tags must be defined in global tags.                            paths./_migration/reindex.post.tags[0]

These errors were occurring because the APIs had tags that didn't exist in the global list of tags. I am assuming these APIs ought to appear in the "Migration" section (https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-migration) and so am updating the tag accordingly. If they ought to be added to a different existing or new tag group, that's acceptable too.

Copy link
Contributor

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

API Status Request Response
migrate.cancel_reindex 🟢 2/2 2/2
migrate.create_from 🟢 2/2 2/2
migrate.get_reindex_status 🟢 1/1 1/1
migrate.reindex 🟢 2/2 2/2

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

@lcawl lcawl merged commit db6bdcf into main Jan 22, 2025
12 checks passed
@lcawl lcawl deleted the migration-tags branch January 22, 2025 21:06
github-actions bot pushed a commit that referenced this pull request Jan 22, 2025
lcawl added a commit that referenced this pull request Jan 22, 2025
(cherry picked from commit db6bdcf)

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