kibana/examples
Kibana Machine 113055b89d
[8.x] [UA][Core][API Deprecations] Add deprecate type and update copy (#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)](https://github.com/elastic/kibana/pull/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":"ahmad.bamyeh@elastic.co"},"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
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Elastic Machine
<elasticmachine@users.noreply.github.com>\r\nCo-authored-by:
florent-leborgne
<florent.leborgne@elastic.co>","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
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Elastic Machine
<elasticmachine@users.noreply.github.com>\r\nCo-authored-by:
florent-leborgne
<florent.leborgne@elastic.co>","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
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Elastic Machine
<elasticmachine@users.noreply.github.com>\r\nCo-authored-by:
florent-leborgne
<florent.leborgne@elastic.co>","sha":"665cf98067b6fbd8850866c75e189c937e1c2dbd"}},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Ahmad Bamieh <ahmad.bamyeh@elastic.co>
2024-11-06 01:27:19 -06:00
..
bfetch_explorer Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
content_management_examples [react@18] More breaking type fixes (should be the last pr) (#192266) 2024-09-12 13:54:18 +02:00
controls_example [8.x] [Embeddable Rebuild] [Controls] Remove non-React controls from &#x60;controls&#x60; plugin (#192017) (#193174) 2024-09-17 10:43:58 -05:00
data_view_field_editor_example Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
developer_examples Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
discover_customization_examples [8.x] [OneDiscover] Contextual App Menu Extension Point (#195448) (#198320) 2024-10-30 09:25:31 -05:00
embeddable_examples [8.x] Fix various EuiFormControlLayout usages (#192779) (#193925) 2024-09-24 17:21:13 -05:00
error_boundary Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
eso_model_version_example Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
esql_ast_inspector [8.x] [ES|QL] Add&#x60;SORT&#x60; command mutation APIs (#197185) (#198440) 2024-10-30 17:16:07 -05:00
esql_validation_example Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
expressions_explorer Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
feature_control_examples [8.x] Added scope field to features config. (#191634) (#193389) 2024-09-19 10:42:43 -05:00
feature_flags_example [8.x] [Feature Flags Service] Hello world 👋 (#188562) (#193519) 2024-09-20 12:21:41 +02:00
field_formats_example Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
files_example Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
grid_example [8.x] [Dashboard] [Collapsable Panels] Add panel management API (#195513) (#199040) 2024-11-05 14:03:31 -06:00
guided_onboarding_example [8.x] [Expamples][Guided onboarding] - added missing EuiProvider to fix errors (#199070) (#199076) 2024-11-05 22:00:12 -06:00
hello_world Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
locator_examples Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
locator_explorer Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
partial_results_example Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
portable_dashboards_example [8.x] [dashboard] decouple DashboardCreationOptions from DashboardContainer (#194875) (#195322) 2024-10-08 00:50:43 +02:00
preboot_example Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
resizable_layout_examples Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
response_stream [8.x] [ML] AIOps: Log Rate Analysis embeddable (#197943) (#198963) 2024-11-05 10:36:04 -06:00
routing_example [8.x] [UA][Core][API Deprecations] Add deprecate type and update copy (#198800) (#199079) 2024-11-06 01:27:19 -06:00
screenshot_mode_example Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
search_examples [react@18] More breaking type fixes (should be the last pr) (#192266) 2024-09-12 13:54:18 +02:00
share_examples [8.x] [Reporting] fix dashboard &quot;Copy Post URL&quot; action (#192530) (#195334) 2024-10-08 03:44:43 +02:00
state_containers_examples Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
ui_action_examples Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
ui_actions_explorer Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
unified_doc_viewer Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
unified_field_list_examples Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
user_profile_examples Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
v8_profiler_examples Adds AGPL 3.0 license (#192025) 2024-09-06 19:02:41 -06:00
README.asciidoc Adds run without basepath configured to examples readme (#173086) 2023-12-12 11:22:02 -07:00

[[example-plugins]]
== Example plugins

This folder contains example plugins.  To run the plugins in this folder, use the `--run-examples` flag (without a basepath), via

[source,bash]
----
yarn start --run-examples
----