[UA][Core][API Deprecations] Add deprecate type and update copy #198800
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bamieh
added
release_note:skip
florent-leborgne
approved these changes
Nov 4, 2024
examples/routing_example/server/routes/deprecated_routes/versioned.ts
Outdated
Show resolved
Hide resolved
packages/core/deprecations/core-deprecations-server-internal/src/deprecations/i18n_texts.ts
Outdated
Show resolved
Hide resolved
Bamieh
added
the
auto-backport
|
@elasticmachine merge upstream |
…oned.ts Co-authored-by: florent-leborgne <[email protected]>
Bamieh
commented
Nov 4, 2024
packages/core/deprecations/core-deprecations-server-internal/src/deprecations/i18n_texts.ts
Outdated
Show resolved
Hide resolved
…rc/deprecations/i18n_texts.ts
Bamieh
added
the
backport:prev-minor
…ations/deprecated_type
TinaHeiligers
approved these changes
Nov 4, 2024
packages/core/deprecations/core-deprecations-server-internal/src/deprecations/i18n_texts.ts
Show resolved
Hide resolved
4 tasks
|
@elasticmachine merge upstream |
💚 Build Succeeded
Metrics [docs]
History
|
mattkime
approved these changes
Nov 6, 2024
|
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/11697914083 |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Nov 6, 2024
…tic#198800) ## Summary - [x] Add `deprecate` Type to the API Deprecations reasons. - [x] Add a `message` optional field that is surfaced in the UA - [x] Add IDE documentation in the autocomplete for all deprecation fields. - [x] Updated README and example plugin for the `deprecate` type - [x] Update copy for `deprecate`. Closes elastic#197721 ## Testing Run kibana locally with the test example plugin that has deprecated routes ``` yarn start --plugin-path=examples/routing_example --plugin-path=examples/developer_examples ``` The following comprehensive deprecated routes examples are registered inside the folder: `examples/routing_example/server/routes/deprecated_routes` Run them in the dev console to trigger the deprecation condition so they show up in the UA: ``` GET kbn:/api/routing_example/d/deprecated_route ``` <img width="628" alt="image" src="https://github.com/user-attachments/assets/3c0e1829-9a07-49bd-94a3-398514f448e2"> --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: florent-leborgne <[email protected]> (cherry picked from commit 665cf98)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Nov 6, 2024
…#198800) (#199079) # Backport This will backport the following commits from `main` to `8.x`: - [[UA][Core][API Deprecations] Add deprecate type and update copy (#198800)](#198800) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Ahmad Bamieh","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-06T05:43:56Z","message":"[UA][Core][API Deprecations] Add deprecate type and update copy (#198800)\n\n## Summary\r\n\r\n- [x] Add `deprecate` Type to the API Deprecations reasons.\r\n- [x] Add a `message` optional field that is surfaced in the UA\r\n- [x] Add IDE documentation in the autocomplete for all deprecation\r\nfields.\r\n- [x] Updated README and example plugin for the `deprecate` type\r\n- [x] Update copy for `deprecate`.\r\n\r\n\r\nCloses https://github.com/elastic/kibana/issues/197721\r\n\r\n## Testing\r\n\r\nRun kibana locally with the test example plugin that has deprecated\r\nroutes\r\n```\r\nyarn start --plugin-path=examples/routing_example --plugin-path=examples/developer_examples\r\n```\r\n\r\nThe following comprehensive deprecated routes examples are registered\r\ninside the folder:\r\n`examples/routing_example/server/routes/deprecated_routes`\r\n\r\nRun them in the dev console to trigger the deprecation condition so they\r\nshow up in the UA:\r\n\r\n```\r\nGET kbn:/api/routing_example/d/deprecated_route\r\n```\r\n\r\n<img width=\"628\" alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/3c0e1829-9a07-49bd-94a3-398514f448e2\">\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: florent-leborgne <[email protected]>","sha":"665cf98067b6fbd8850866c75e189c937e1c2dbd","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","auto-backport","backport:prev-minor","v8.17.0"],"title":"[UA][Core][API Deprecations] Add deprecate type and update copy","number":198800,"url":"https://github.com/elastic/kibana/pull/198800","mergeCommit":{"message":"[UA][Core][API Deprecations] Add deprecate type and update copy (#198800)\n\n## Summary\r\n\r\n- [x] Add `deprecate` Type to the API Deprecations reasons.\r\n- [x] Add a `message` optional field that is surfaced in the UA\r\n- [x] Add IDE documentation in the autocomplete for all deprecation\r\nfields.\r\n- [x] Updated README and example plugin for the `deprecate` type\r\n- [x] Update copy for `deprecate`.\r\n\r\n\r\nCloses https://github.com/elastic/kibana/issues/197721\r\n\r\n## Testing\r\n\r\nRun kibana locally with the test example plugin that has deprecated\r\nroutes\r\n```\r\nyarn start --plugin-path=examples/routing_example --plugin-path=examples/developer_examples\r\n```\r\n\r\nThe following comprehensive deprecated routes examples are registered\r\ninside the folder:\r\n`examples/routing_example/server/routes/deprecated_routes`\r\n\r\nRun them in the dev console to trigger the deprecation condition so they\r\nshow up in the UA:\r\n\r\n```\r\nGET kbn:/api/routing_example/d/deprecated_route\r\n```\r\n\r\n<img width=\"628\" alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/3c0e1829-9a07-49bd-94a3-398514f448e2\">\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: florent-leborgne <[email protected]>","sha":"665cf98067b6fbd8850866c75e189c937e1c2dbd"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/198800","number":198800,"mergeCommit":{"message":"[UA][Core][API Deprecations] Add deprecate type and update copy (#198800)\n\n## Summary\r\n\r\n- [x] Add `deprecate` Type to the API Deprecations reasons.\r\n- [x] Add a `message` optional field that is surfaced in the UA\r\n- [x] Add IDE documentation in the autocomplete for all deprecation\r\nfields.\r\n- [x] Updated README and example plugin for the `deprecate` type\r\n- [x] Update copy for `deprecate`.\r\n\r\n\r\nCloses https://github.com/elastic/kibana/issues/197721\r\n\r\n## Testing\r\n\r\nRun kibana locally with the test example plugin that has deprecated\r\nroutes\r\n```\r\nyarn start --plugin-path=examples/routing_example --plugin-path=examples/developer_examples\r\n```\r\n\r\nThe following comprehensive deprecated routes examples are registered\r\ninside the folder:\r\n`examples/routing_example/server/routes/deprecated_routes`\r\n\r\nRun them in the dev console to trigger the deprecation condition so they\r\nshow up in the UA:\r\n\r\n```\r\nGET kbn:/api/routing_example/d/deprecated_route\r\n```\r\n\r\n<img width=\"628\" alt=\"image\"\r\nsrc=\"https://github.com/user-attachments/assets/3c0e1829-9a07-49bd-94a3-398514f448e2\">\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>\r\nCo-authored-by: florent-leborgne <[email protected]>","sha":"665cf98067b6fbd8850866c75e189c937e1c2dbd"}},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Ahmad Bamieh <[email protected]>
mgadewoll
pushed a commit
to mgadewoll/kibana
that referenced
this pull request
Nov 7, 2024
…tic#198800) ## Summary - [x] Add `deprecate` Type to the API Deprecations reasons. - [x] Add a `message` optional field that is surfaced in the UA - [x] Add IDE documentation in the autocomplete for all deprecation fields. - [x] Updated README and example plugin for the `deprecate` type - [x] Update copy for `deprecate`. Closes elastic#197721 ## Testing Run kibana locally with the test example plugin that has deprecated routes ``` yarn start --plugin-path=examples/routing_example --plugin-path=examples/developer_examples ``` The following comprehensive deprecated routes examples are registered inside the folder: `examples/routing_example/server/routes/deprecated_routes` Run them in the dev console to trigger the deprecation condition so they show up in the UA: ``` GET kbn:/api/routing_example/d/deprecated_route ``` <img width="628" alt="image" src="https://github.com/user-attachments/assets/3c0e1829-9a07-49bd-94a3-398514f448e2"> --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: florent-leborgne <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
deprecateType to the API Deprecations reasons.messageoptional field that is surfaced in the UAdeprecatetypedeprecate.Closes #197721
Testing
Run kibana locally with the test example plugin that has deprecated routes
The following comprehensive deprecated routes examples are registered inside the folder:
examples/routing_example/server/routes/deprecated_routesRun them in the dev console to trigger the deprecation condition so they show up in the UA: