-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[Console] Update autocomplete definitions for 8.16 #196284
[Console] Update autocomplete definitions for 8.16 #196284
Conversation
Pinging @elastic/kibana-management (Team:Kibana Management) |
💚 Build Succeeded
Metrics [docs]
cc @ElenaStoeva |
@@ -14,8 +14,8 @@ | |||
], | |||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html", | |||
"availability": { | |||
"stack": true, | |||
"serverless": true | |||
"stack": false, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does it mean when both stack
and serverless
is false?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It usually means that the endpoint is experimental, but since this specific endpoint has been available before and is not anymore I suppose it is being removed. I will check with @elastic/devtools-team.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems that the visibility
property of serverless' and stack's availability
for this endpoint has been changed from public
to private
in elastic/elasticsearch-specification#2675 and elastic/elasticsearch-specification@4f9e620 (see changes in output/schema/schema.json
), which is the reason for these changes from our side.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This API has a bug, which is why we have excluded it from clients. I'm not sure if Kibana should have it or not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good and work well
Starting backport for target branches: 8.x |
Closes elastic#194601 ## Summary This PR updates the script-generated Console autocomplete definitions for 8.16. ### Testing We currently don't have automated tests for all autocomplete definition endpoints, so we should test the changes manually. We do this by running Kibana and verifying in Console that the changed endpoints are suggested correctly. It's important that we also test in serverless and make sure that the changed endpoints are only available in the specified offerings, based on the `availability` property. For example, if an autocompletion definition has the following `availability` property: ``` "availability": { "stack": true, "serverless": false } ``` this means that the endpoint should be suggested in stateful Kibana, but not in serverless. (cherry picked from commit 404e268)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…196503) # Backport This will backport the following commits from `main` to `8.x`: - [[Console] Update autocomplete definitions for 8.16 (#196284)](#196284) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Elena Stoeva","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-16T09:03:33Z","message":"[Console] Update autocomplete definitions for 8.16 (#196284)\n\nCloses https://github.com/elastic/kibana/issues/194601\r\n\r\n## Summary\r\n\r\nThis PR updates the script-generated Console autocomplete definitions\r\nfor 8.16.\r\n\r\n\r\n### Testing\r\nWe currently don't have automated tests for all autocomplete definition\r\nendpoints, so we should test the changes manually. We do this by running\r\nKibana and verifying in Console that the changed endpoints are suggested\r\ncorrectly. It's important that we also test in serverless and make sure\r\nthat the changed endpoints are only available in the specified\r\nofferings, based on the `availability` property. For example, if an\r\nautocompletion definition has the following `availability` property:\r\n```\r\n \"availability\": {\r\n \"stack\": true,\r\n \"serverless\": false\r\n }\r\n```\r\nthis means that the endpoint should be suggested in stateful Kibana, but\r\nnot in serverless.","sha":"404e268596d3e477bb750f3794b418a6026db3c2","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Console","Team:Kibana Management","release_note:skip","v9.0.0","backport:prev-minor"],"title":"[Console] Update autocomplete definitions for 8.16","number":196284,"url":"https://github.com/elastic/kibana/pull/196284","mergeCommit":{"message":"[Console] Update autocomplete definitions for 8.16 (#196284)\n\nCloses https://github.com/elastic/kibana/issues/194601\r\n\r\n## Summary\r\n\r\nThis PR updates the script-generated Console autocomplete definitions\r\nfor 8.16.\r\n\r\n\r\n### Testing\r\nWe currently don't have automated tests for all autocomplete definition\r\nendpoints, so we should test the changes manually. We do this by running\r\nKibana and verifying in Console that the changed endpoints are suggested\r\ncorrectly. It's important that we also test in serverless and make sure\r\nthat the changed endpoints are only available in the specified\r\nofferings, based on the `availability` property. For example, if an\r\nautocompletion definition has the following `availability` property:\r\n```\r\n \"availability\": {\r\n \"stack\": true,\r\n \"serverless\": false\r\n }\r\n```\r\nthis means that the endpoint should be suggested in stateful Kibana, but\r\nnot in serverless.","sha":"404e268596d3e477bb750f3794b418a6026db3c2"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/196284","number":196284,"mergeCommit":{"message":"[Console] Update autocomplete definitions for 8.16 (#196284)\n\nCloses https://github.com/elastic/kibana/issues/194601\r\n\r\n## Summary\r\n\r\nThis PR updates the script-generated Console autocomplete definitions\r\nfor 8.16.\r\n\r\n\r\n### Testing\r\nWe currently don't have automated tests for all autocomplete definition\r\nendpoints, so we should test the changes manually. We do this by running\r\nKibana and verifying in Console that the changed endpoints are suggested\r\ncorrectly. It's important that we also test in serverless and make sure\r\nthat the changed endpoints are only available in the specified\r\nofferings, based on the `availability` property. For example, if an\r\nautocompletion definition has the following `availability` property:\r\n```\r\n \"availability\": {\r\n \"stack\": true,\r\n \"serverless\": false\r\n }\r\n```\r\nthis means that the endpoint should be suggested in stateful Kibana, but\r\nnot in serverless.","sha":"404e268596d3e477bb750f3794b418a6026db3c2"}}]}] BACKPORT--> Co-authored-by: Elena Stoeva <[email protected]>
Closes #194601
Summary
This PR updates the script-generated Console autocomplete definitions for 8.16.
Testing
We currently don't have automated tests for all autocomplete definition endpoints, so we should test the changes manually. We do this by running Kibana and verifying in Console that the changed endpoints are suggested correctly. It's important that we also test in serverless and make sure that the changed endpoints are only available in the specified offerings, based on the
availability
property. For example, if an autocompletion definition has the followingavailability
property:this means that the endpoint should be suggested in stateful Kibana, but not in serverless.