-
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
Changes deprecated SO HTTP APIs deprecation field to object #197936
Changes deprecated SO HTTP APIs deprecation field to object #197936
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
run docs-build |
@elasticmachine merge upstream |
@elasticmachine merge upstream |
@elasticmachine merge upstream |
blocked by #198800. |
@elasticmachine merge upstream |
Starting backport for target branches: 8.x |
💚 Build Succeeded
Metrics [docs]Public APIs missing comments
Async chunks
Public APIs missing exports
Page load bundle
Unknown metric groupsAPI count
History
|
💔 All backports failed
Manual backportTo create the backport manually run:
Questions ?Please refer to the Backport tool documentation |
…197936) fix elastic#197721. The route deprecation field changed from a boolean to an object, where the object contains information that is used in deprecation issues that the Upgrade Assistant shows. This PR makes the necessary changes in the deprecated Saved Objects HTTP APIs. This PR also includes a release notes entry for the API deprecations that was missing. ![Screenshot 2024-10-29 at 12 01 29](https://github.com/user-attachments/assets/5c47c697-fbae-4b2e-8c6c-cd4701a667df) ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### How to test this: - Pull PR, run es against a trial license and start kibana as usual. - Make a curl request to Kibana to get the config saved object: ``` curl --location 'localhost:5601/abc/api/saved_objects/config/9.0.0' \ --header 'Content-Type: application/json' \ --header 'Accept-Encoding: gzip, deflate, br' \ --header 'kbn-xsrf: kibana' \ --header 'Kbn-Version: 9.0.0' \ --header 'Authorization: Basic ZWxhc3RpYzpjaGFuZ2VtZQ==' ``` - Navigate to Upgrade Assistant and observe Kibana has at least 1 deprecation warning. - View Kibana's warnings, you should see a warning entry for `The "GET /api/saved_objects/{type}/{id}" route is deprecated` ![Screenshot 2024-11-06 at 16 26 26](https://github.com/user-attachments/assets/3b6a5644-3e5e-403e-a0f6-015686675b9f) - click on the deprecation and you should see more detail about the deprecated API that's been used in the flyout: ![Screenshot 2024-11-06 at 16 26 44](https://github.com/user-attachments/assets/696aaf8f-fb6b-4c61-bc3c-b3745f85059a) - resolve the deprecation warning - Kibana should continue to issue requests to the deprecated SO HTTP APIs because these APIs have not been removed yet. ### Risk Matrix | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | End user concern from the deprecation warning that says the routes have been deprecated | Low | Low | The APIs have been deprecated since 8.7 and recommends using public APIs instead. | ### For maintainers - [x] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: kibanamachine <[email protected]>
…197936) fix elastic#197721. The route deprecation field changed from a boolean to an object, where the object contains information that is used in deprecation issues that the Upgrade Assistant shows. This PR makes the necessary changes in the deprecated Saved Objects HTTP APIs. This PR also includes a release notes entry for the API deprecations that was missing. ![Screenshot 2024-10-29 at 12 01 29](https://github.com/user-attachments/assets/5c47c697-fbae-4b2e-8c6c-cd4701a667df) ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### How to test this: - Pull PR, run es against a trial license and start kibana as usual. - Make a curl request to Kibana to get the config saved object: ``` curl --location 'localhost:5601/abc/api/saved_objects/config/9.0.0' \ --header 'Content-Type: application/json' \ --header 'Accept-Encoding: gzip, deflate, br' \ --header 'kbn-xsrf: kibana' \ --header 'Kbn-Version: 9.0.0' \ --header 'Authorization: Basic ZWxhc3RpYzpjaGFuZ2VtZQ==' ``` - Navigate to Upgrade Assistant and observe Kibana has at least 1 deprecation warning. - View Kibana's warnings, you should see a warning entry for `The "GET /api/saved_objects/{type}/{id}" route is deprecated` ![Screenshot 2024-11-06 at 16 26 26](https://github.com/user-attachments/assets/3b6a5644-3e5e-403e-a0f6-015686675b9f) - click on the deprecation and you should see more detail about the deprecated API that's been used in the flyout: ![Screenshot 2024-11-06 at 16 26 44](https://github.com/user-attachments/assets/696aaf8f-fb6b-4c61-bc3c-b3745f85059a) - resolve the deprecation warning - Kibana should continue to issue requests to the deprecated SO HTTP APIs because these APIs have not been removed yet. ### Risk Matrix | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | End user concern from the deprecation warning that says the routes have been deprecated | Low | Low | The APIs have been deprecated since 8.7 and recommends using public APIs instead. | ### For maintainers - [x] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: kibanamachine <[email protected]>
Friendly reminder: Looks like this PR hasn’t been backported yet. |
Friendly reminder: Looks like this PR hasn’t been backported yet. |
1 similar comment
Friendly reminder: Looks like this PR hasn’t been backported yet. |
Friendly reminder: Looks like this PR hasn’t been backported yet. |
2 similar comments
Friendly reminder: Looks like this PR hasn’t been backported yet. |
Friendly reminder: Looks like this PR hasn’t been backported yet. |
Friendly reminder: Looks like this PR hasn’t been backported yet. |
1 similar comment
Friendly reminder: Looks like this PR hasn’t been backported yet. |
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…197936) fix elastic#197721. The route deprecation field changed from a boolean to an object, where the object contains information that is used in deprecation issues that the Upgrade Assistant shows. This PR makes the necessary changes in the deprecated Saved Objects HTTP APIs. This PR also includes a release notes entry for the API deprecations that was missing. ![Screenshot 2024-10-29 at 12 01 29](https://github.com/user-attachments/assets/5c47c697-fbae-4b2e-8c6c-cd4701a667df) ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### How to test this: - Pull PR, run es against a trial license and start kibana as usual. - Make a curl request to Kibana to get the config saved object: ``` curl --location 'localhost:5601/abc/api/saved_objects/config/9.0.0' \ --header 'Content-Type: application/json' \ --header 'Accept-Encoding: gzip, deflate, br' \ --header 'kbn-xsrf: kibana' \ --header 'Kbn-Version: 9.0.0' \ --header 'Authorization: Basic ZWxhc3RpYzpjaGFuZ2VtZQ==' ``` - Navigate to Upgrade Assistant and observe Kibana has at least 1 deprecation warning. - View Kibana's warnings, you should see a warning entry for `The "GET /api/saved_objects/{type}/{id}" route is deprecated` ![Screenshot 2024-11-06 at 16 26 26](https://github.com/user-attachments/assets/3b6a5644-3e5e-403e-a0f6-015686675b9f) - click on the deprecation and you should see more detail about the deprecated API that's been used in the flyout: ![Screenshot 2024-11-06 at 16 26 44](https://github.com/user-attachments/assets/696aaf8f-fb6b-4c61-bc3c-b3745f85059a) - resolve the deprecation warning - Kibana should continue to issue requests to the deprecated SO HTTP APIs because these APIs have not been removed yet. ### Risk Matrix | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | End user concern from the deprecation warning that says the routes have been deprecated | Low | Low | The APIs have been deprecated since 8.7 and recommends using public APIs instead. | ### For maintainers - [x] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 0df2e98) # Conflicts: # oas_docs/output/kibana.serverless.yaml # oas_docs/output/kibana.yaml # packages/core/deprecations/core-deprecations-server-internal/src/routes/post_validation_handler.ts # packages/core/http/core-http-server/index.ts # packages/core/http/core-http-server/src/router/index.ts
…97936) (#201154) # Backport This will backport the following commits from `main` to `8.x`: - [Changes deprecated SO HTTP APIs deprecation field to object (#197936)](#197936) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Christiane (Tina) Heiligers","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-07T20:49:05Z","message":"Changes deprecated SO HTTP APIs deprecation field to object (#197936)\n\nfix https://github.com/elastic/kibana/issues/197721.\r\n\r\nThe route deprecation field changed from a boolean to an object, where\r\nthe object contains information that is used in deprecation issues that\r\nthe Upgrade Assistant shows.\r\n\r\nThis PR makes the necessary changes in the deprecated Saved Objects HTTP\r\nAPIs.\r\n\r\nThis PR also includes a release notes entry for the API deprecations\r\nthat was missing.\r\n![Screenshot 2024-10-29 at 12 01\r\n29](https://github.com/user-attachments/assets/5c47c697-fbae-4b2e-8c6c-cd4701a667df)\r\n\r\n### Checklist\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n\r\n### How to test this:\r\n\r\n- Pull PR, run es against a trial license and start kibana as usual.\r\n- Make a curl request to Kibana to get the config saved object: \r\n\r\n```\r\ncurl --location 'localhost:5601/abc/api/saved_objects/config/9.0.0' \\\r\n--header 'Content-Type: application/json' \\\r\n--header 'Accept-Encoding: gzip, deflate, br' \\\r\n--header 'kbn-xsrf: kibana' \\\r\n--header 'Kbn-Version: 9.0.0' \\\r\n--header 'Authorization: Basic ZWxhc3RpYzpjaGFuZ2VtZQ=='\r\n```\r\n\r\n- Navigate to Upgrade Assistant and observe Kibana has at least 1\r\ndeprecation warning.\r\n- View Kibana's warnings, you should see a warning entry for `The \"GET\r\n/api/saved_objects/{type}/{id}\" route is deprecated`\r\n\r\n![Screenshot 2024-11-06 at 16 26\r\n26](https://github.com/user-attachments/assets/3b6a5644-3e5e-403e-a0f6-015686675b9f)\r\n\r\n- click on the deprecation and you should see more detail about the\r\ndeprecated API that's been used in the flyout:\r\n\r\n![Screenshot 2024-11-06 at 16 26\r\n44](https://github.com/user-attachments/assets/696aaf8f-fb6b-4c61-bc3c-b3745f85059a)\r\n\r\n- resolve the deprecation warning\r\n- Kibana should continue to issue requests to the deprecated SO HTTP\r\nAPIs because these APIs have not been removed yet.\r\n\r\n\r\n### Risk Matrix\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes |\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n| End user concern from the deprecation warning that says the routes\r\nhave been deprecated | Low | Low | The APIs have been deprecated since\r\n8.7 and recommends using public APIs instead. |\r\n\r\n### For maintainers\r\n\r\n- [x] This will appear in the **Release Notes** and follow the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"0df2e9838119d202eba0c6b2bcb7068b160f6005","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:deprecation","Team:Core","Feature:Saved Objects","backport missing","v9.0.0","docs","backport:prev-minor","Epic:Deprecations","Feature:OAS","v8.17.0"],"number":197936,"url":"https://github.com/elastic/kibana/pull/197936","mergeCommit":{"message":"Changes deprecated SO HTTP APIs deprecation field to object (#197936)\n\nfix https://github.com/elastic/kibana/issues/197721.\r\n\r\nThe route deprecation field changed from a boolean to an object, where\r\nthe object contains information that is used in deprecation issues that\r\nthe Upgrade Assistant shows.\r\n\r\nThis PR makes the necessary changes in the deprecated Saved Objects HTTP\r\nAPIs.\r\n\r\nThis PR also includes a release notes entry for the API deprecations\r\nthat was missing.\r\n![Screenshot 2024-10-29 at 12 01\r\n29](https://github.com/user-attachments/assets/5c47c697-fbae-4b2e-8c6c-cd4701a667df)\r\n\r\n### Checklist\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n\r\n### How to test this:\r\n\r\n- Pull PR, run es against a trial license and start kibana as usual.\r\n- Make a curl request to Kibana to get the config saved object: \r\n\r\n```\r\ncurl --location 'localhost:5601/abc/api/saved_objects/config/9.0.0' \\\r\n--header 'Content-Type: application/json' \\\r\n--header 'Accept-Encoding: gzip, deflate, br' \\\r\n--header 'kbn-xsrf: kibana' \\\r\n--header 'Kbn-Version: 9.0.0' \\\r\n--header 'Authorization: Basic ZWxhc3RpYzpjaGFuZ2VtZQ=='\r\n```\r\n\r\n- Navigate to Upgrade Assistant and observe Kibana has at least 1\r\ndeprecation warning.\r\n- View Kibana's warnings, you should see a warning entry for `The \"GET\r\n/api/saved_objects/{type}/{id}\" route is deprecated`\r\n\r\n![Screenshot 2024-11-06 at 16 26\r\n26](https://github.com/user-attachments/assets/3b6a5644-3e5e-403e-a0f6-015686675b9f)\r\n\r\n- click on the deprecation and you should see more detail about the\r\ndeprecated API that's been used in the flyout:\r\n\r\n![Screenshot 2024-11-06 at 16 26\r\n44](https://github.com/user-attachments/assets/696aaf8f-fb6b-4c61-bc3c-b3745f85059a)\r\n\r\n- resolve the deprecation warning\r\n- Kibana should continue to issue requests to the deprecated SO HTTP\r\nAPIs because these APIs have not been removed yet.\r\n\r\n\r\n### Risk Matrix\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes |\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n| End user concern from the deprecation warning that says the routes\r\nhave been deprecated | Low | Low | The APIs have been deprecated since\r\n8.7 and recommends using public APIs instead. |\r\n\r\n### For maintainers\r\n\r\n- [x] This will appear in the **Release Notes** and follow the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"0df2e9838119d202eba0c6b2bcb7068b160f6005"}},"sourceBranch":"main","suggestedTargetBranches":["8.17"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/197936","number":197936,"mergeCommit":{"message":"Changes deprecated SO HTTP APIs deprecation field to object (#197936)\n\nfix https://github.com/elastic/kibana/issues/197721.\r\n\r\nThe route deprecation field changed from a boolean to an object, where\r\nthe object contains information that is used in deprecation issues that\r\nthe Upgrade Assistant shows.\r\n\r\nThis PR makes the necessary changes in the deprecated Saved Objects HTTP\r\nAPIs.\r\n\r\nThis PR also includes a release notes entry for the API deprecations\r\nthat was missing.\r\n![Screenshot 2024-10-29 at 12 01\r\n29](https://github.com/user-attachments/assets/5c47c697-fbae-4b2e-8c6c-cd4701a667df)\r\n\r\n### Checklist\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n\r\n\r\n### How to test this:\r\n\r\n- Pull PR, run es against a trial license and start kibana as usual.\r\n- Make a curl request to Kibana to get the config saved object: \r\n\r\n```\r\ncurl --location 'localhost:5601/abc/api/saved_objects/config/9.0.0' \\\r\n--header 'Content-Type: application/json' \\\r\n--header 'Accept-Encoding: gzip, deflate, br' \\\r\n--header 'kbn-xsrf: kibana' \\\r\n--header 'Kbn-Version: 9.0.0' \\\r\n--header 'Authorization: Basic ZWxhc3RpYzpjaGFuZ2VtZQ=='\r\n```\r\n\r\n- Navigate to Upgrade Assistant and observe Kibana has at least 1\r\ndeprecation warning.\r\n- View Kibana's warnings, you should see a warning entry for `The \"GET\r\n/api/saved_objects/{type}/{id}\" route is deprecated`\r\n\r\n![Screenshot 2024-11-06 at 16 26\r\n26](https://github.com/user-attachments/assets/3b6a5644-3e5e-403e-a0f6-015686675b9f)\r\n\r\n- click on the deprecation and you should see more detail about the\r\ndeprecated API that's been used in the flyout:\r\n\r\n![Screenshot 2024-11-06 at 16 26\r\n44](https://github.com/user-attachments/assets/696aaf8f-fb6b-4c61-bc3c-b3745f85059a)\r\n\r\n- resolve the deprecation warning\r\n- Kibana should continue to issue requests to the deprecated SO HTTP\r\nAPIs because these APIs have not been removed yet.\r\n\r\n\r\n### Risk Matrix\r\n\r\n| Risk | Probability | Severity | Mitigation/Notes |\r\n\r\n|---------------------------|-------------|----------|-------------------------|\r\n| End user concern from the deprecation warning that says the routes\r\nhave been deprecated | Low | Low | The APIs have been deprecated since\r\n8.7 and recommends using public APIs instead. |\r\n\r\n### For maintainers\r\n\r\n- [x] This will appear in the **Release Notes** and follow the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"0df2e9838119d202eba0c6b2bcb7068b160f6005"}},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: Christiane (Tina) Heiligers <[email protected]> Co-authored-by: kibanamachine <[email protected]>
fix #197721.
The route deprecation field changed from a boolean to an object, where the object contains information that is used in deprecation issues that the Upgrade Assistant shows.
This PR makes the necessary changes in the deprecated Saved Objects HTTP APIs.
This PR also includes a release notes entry for the API deprecations that was missing.
Checklist
How to test this:
The "GET /api/saved_objects/{type}/{id}" route is deprecated
Risk Matrix
For maintainers