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.

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

[OpenAPI] Edits connector API summaries #3051

Merged
merged 13 commits into from
Oct 23, 2024
Merged

[OpenAPI] Edits connector API summaries #3051

merged 13 commits into from
Oct 23, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Oct 22, 2024 •
edited
Loading

Relates to #2635

This PR updates the operation summaries and a few operation descriptions with content copied from https://www.elastic.co/guide/en/elasticsearch/reference/master/connector-apis.html

NOTE: I didn't see a difference in the old docs between the "update filtering" and "update active filtering", so I left the text as-is in the latter.

@lcawl lcawl mentioned this pull request Oct 22, 2024
Closed
@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

@lcawl lcawl marked this pull request as ready for review October 23, 2024 00:11
@lcawl lcawl requested a review from esdocs October 23, 2024 00:11
@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

leemthompo
leemthompo approved these changes Oct 23, 2024
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM with some drive-by taxonomy updates!

One question: the connectors docs have been moved to the Elasticsearch guide in 8.16. Because links are full URLs and they use current I'm guessing we can't make those changes until the version bump happen?

So we'll need to update this line (and probably more links in the generated ref if they exist) when the time comes.

docs/overlays/elasticsearch-shared-overlays.yaml Outdated Show resolved Hide resolved
output/schema/schema.json Show resolved Hide resolved
output/openapi/elasticsearch-openapi.json Show resolved Hide resolved
output/openapi/elasticsearch-serverless-openapi.json Show resolved Hide resolved
output/openapi/elasticsearch-serverless-openapi.json Outdated Show resolved Hide resolved
output/openapi/elasticsearch-openapi.json Outdated Show resolved Hide resolved
output/schema/schema.json Show resolved Hide resolved
output/schema/schema.json Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

@lcawl
Copy link
Contributor Author

lcawl commented Oct 23, 2024

One question: the connectors docs have been moved to the Elasticsearch guide in 8.16. Because links are full URLs and they use current I'm guessing we can't make those changes until the version bump happen?

Good point, I've updated the URLs to master and switched the target.
In general, we try to get around this fragility by using the @doc_id and @ext_doc_id keywords when we're linking within the specifications, which are resolved from https://github.com/elastic/elasticsearch-specification/blob/main/specification/_doc_ids/table.csv
The overlay files can't make use of that table, however, so until we get this info pushed into the spec it'll need manual maintenance... but I'll use version-specific URLs instead of current to help mitigate the maintenance.

leemthompo
leemthompo reviewed Oct 23, 2024
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

Found couple little things in preview! 🔍

docs/overlays/elasticsearch-shared-overlays.yaml Outdated Show resolved Hide resolved
docs/overlays/elasticsearch-shared-overlays.yaml Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

2 similar comments
@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 9/9 9/9
connector.get 🟢 59/59 59/59
connector.last_sync 🟢 7/7 7/7
connector.list 🟢 19/19 19/19
connector.post 🟢 7/7 7/7
connector.put 🟢 13/13 13/13
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_post 🟢 50/50 50/50
connector.update_active_filtering 🟢 1/1 1/1
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_filtering_validation 🟢 3/3 3/3
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 4/4 4/4
connector.update_name 🟢 4/4 4/4
connector.update_native 🟢 3/3 3/3
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3

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

@lcawl lcawl merged commit 6cb0ce6 into main Oct 23, 2024
6 checks passed
@lcawl lcawl deleted the lcawl/connector-apis branch October 23, 2024 19:06
github-actions bot pushed a commit that referenced this pull request Oct 23, 2024
@lcawl @github-actions
[OpenAPI] Edits connector API summaries (#3051)
fe8e864 
Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 6cb0ce6)
@github-actions github-actions bot mentioned this pull request Oct 23, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Oct 23, 2024
@lcawl @github-actions
[OpenAPI] Edits connector API summaries (#3051)
00ea254 
Co-authored-by: Liam Thompson <[email protected]>
(cherry picked from commit 6cb0ce6)
@github-actions github-actions bot mentioned this pull request Oct 23, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leemthompo leemthompo leemthompo approved these changes

@esdocs esdocs Awaiting requested review from esdocs

Assignees
No one assigned
Labels
backport 8.x backport 8.16 OpenAPI specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lcawl @leemthompo