diff --git a/dashboards-observability/public/components/notebooks/docs/poc/OpenSearch_Dashboards_Embeddable_Documentation.md b/dashboards-observability/public/components/notebooks/docs/poc/OpenSearch_Dashboards_Embeddable_Documentation.md index a7ac63ece..2845d2273 100644 --- a/dashboards-observability/public/components/notebooks/docs/poc/OpenSearch_Dashboards_Embeddable_Documentation.md +++ b/dashboards-observability/public/components/notebooks/docs/poc/OpenSearch_Dashboards_Embeddable_Documentation.md @@ -17,35 +17,35 @@ ![Embeddable API](../dev/images/Embeddable_API.png) * [Source](https://github.com/elastic/kibana/issues/19875) -* [Code](https://github.com/elastic/kibana/tree/master/src/plugins/embeddable) -* [README](https://github.com/elastic/kibana/blob/master/src/plugins/embeddable/README.md) +* [Code](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable) +* [README](https://github.com/elastic/kibana/blob/main/src/plugins/embeddable/README.md) 1. Visualizations, Saved Search and Dashboard embeddable are part of this API now. 2. Embeddable Factory allows to create objects: 1. with “.create()” menthod → needs input of data/source/query/time range explicitly 2. with “.createFromSavedObject()” method → either inherits values from containers or takes from explicit input provided 3. Each of the above has a implementation has to inherit an embeddable & Factory API like: - 1. [Viz. Embeddable](https://github.com/elastic/kibana/blob/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts) & [Factory](https://github.com/elastic/kibana/blob/master/src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx) - 2. [Creating Custom Embeddable Example](https://github.com/elastic/kibana/blob/master/examples/embeddable_examples/public/multi_task_todo/multi_task_todo_embeddable.tsx) & [Factory](https://github.com/elastic/kibana/blob/master/examples/embeddable_examples/public/multi_task_todo/multi_task_todo_embeddable_factory.ts) by Value - 3. [Creating Custom Embeddable Example](https://github.com/elastic/kibana/blob/master/examples/embeddable_examples/public/todo/todo_ref_embeddable.tsx) & [Factory](https://github.com/elastic/kibana/blob/master/examples/embeddable_examples/public/todo/todo_ref_embeddable_factory.tsx) by reference -4. [Visualizations Embeddable API Code](https://github.com/streamich/kibana/tree/master/src/plugins/visualizations/public/embeddable) -5. [Dashboard Container](https://github.com/elastic/kibana/blob/master/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx) is exposed as an embeddable - to have multiple embeddable in a GRID like structure just like the Dashboard Plugin. + 1. [Viz. Embeddable](https://github.com/elastic/kibana/blob/main/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts) & [Factory](https://github.com/elastic/kibana/blob/main/src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx) + 2. [Creating Custom Embeddable Example](https://github.com/elastic/kibana/blob/main/examples/embeddable_examples/public/multi_task_todo/multi_task_todo_embeddable.tsx) & [Factory](https://github.com/elastic/kibana/blob/main/examples/embeddable_examples/public/multi_task_todo/multi_task_todo_embeddable_factory.ts) by Value + 3. [Creating Custom Embeddable Example](https://github.com/elastic/kibana/blob/main/examples/embeddable_examples/public/todo/todo_ref_embeddable.tsx) & [Factory](https://github.com/elastic/kibana/blob/main/examples/embeddable_examples/public/todo/todo_ref_embeddable_factory.tsx) by reference +4. [Visualizations Embeddable API Code](https://github.com/streamich/kibana/tree/main/src/plugins/visualizations/public/embeddable) +5. [Dashboard Container](https://github.com/elastic/kibana/blob/main/src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx) is exposed as an embeddable - to have multiple embeddable in a GRID like structure just like the Dashboard Plugin. **Embeddable Examples** - Examples folder in OpenSearch Dashboards has all the usage samples for new APIs - Use to create new embeddable objects -- [Embeddable Examples](https://github.com/elastic/kibana/tree/master/examples/embeddable_examples) shows how to create new embeddable inheriting the API -- [Embeddable Explorer](https://github.com/elastic/kibana/tree/master/examples/embeddable_explorer)shows usage of these embeddable examples in a Panel Container -- [Dashboard Embeddable](https://github.com/elastic/kibana/tree/master/examples/dashboard_embeddable_examples) shows usage of these embeddable examples in a Dashboard Container +- [Embeddable Examples](https://github.com/elastic/kibana/tree/main/examples/embeddable_examples) shows how to create new embeddable inheriting the API +- [Embeddable Explorer](https://github.com/elastic/kibana/tree/main/examples/embeddable_explorer)shows usage of these embeddable examples in a Panel Container +- [Dashboard Embeddable](https://github.com/elastic/kibana/tree/main/examples/dashboard_embeddable_examples) shows usage of these embeddable examples in a Dashboard Container **Embeddable Renderer** -- The OpenSearch Dashboards react Element/Prop to create new embeddable objects: [Code](https://github.com/elastic/kibana/blob/master/src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx) +- The OpenSearch Dashboards react Element/Prop to create new embeddable objects: [Code](https://github.com/elastic/kibana/blob/main/src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx) - Embeddable container use the renderer to create/update each child(an embeddable object) - - [Example Dashboard Container](https://github.com/elastic/kibana/blob/master/src/plugins/dashboard/public/application/embeddable/dashboard_container_by_value_renderer.tsx) - - [Example of Static Embedding](https://github.com/elastic/kibana/blob/master/examples/embeddable_explorer/public/hello_world_embeddable_example.tsx#L59) (without factory) - - [Example of Embedding with factory.create() method](https://github.com/elastic/kibana/blob/master/examples/embeddable_explorer/public/hello_world_embeddable_example.tsx#L73) (with factory) + - [Example Dashboard Container](https://github.com/elastic/kibana/blob/main/src/plugins/dashboard/public/application/embeddable/dashboard_container_by_value_renderer.tsx) + - [Example of Static Embedding](https://github.com/elastic/kibana/blob/main/examples/embeddable_explorer/public/hello_world_embeddable_example.tsx#L59) (without factory) + - [Example of Embedding with factory.create() method](https://github.com/elastic/kibana/blob/main/examples/embeddable_explorer/public/hello_world_embeddable_example.tsx#L73) (with factory) ## Embedding Visualizations in Notebooks Plugin diff --git a/opensearch-observability/build.gradle b/opensearch-observability/build.gradle index fcbf8c3c3..7c2541cef 100644 --- a/opensearch-observability/build.gradle +++ b/opensearch-observability/build.gradle @@ -151,7 +151,7 @@ validateNebulaPom.enabled = false dependencyLicenses.enabled = false thirdPartyAudit.enabled = false // Allow @Test to be used in test classes not inherited from LuceneTestCase. -// see https://github.com/elastic/elasticsearch/blob/master/buildSrc/src/main/resources/forbidden/es-test-signatures.txt +// see https://github.com/elastic/elasticsearch/blob/26c3dd6857d047054b2108f85bc2b040a9c81fe4/build-tools-internal/src/main/resources/forbidden/es-test-signatures.txt forbiddenApis.ignoreFailures = true // Allow test cases to be named Tests without having to be inherited from LuceneTestCase. // see https://github.com/elastic/elasticsearch/blob/323f312bbc829a63056a79ebe45adced5099f6e6/buildSrc/src/main/java/org/elasticsearch/gradle/precommit/TestingConventionsTasks.java diff --git a/opensearch-observability/src/main/plugin-metadata/plugin-security.policy b/opensearch-observability/src/main/plugin-metadata/plugin-security.policy index e16884cb7..20f5b2a5c 100644 --- a/opensearch-observability/src/main/plugin-metadata/plugin-security.policy +++ b/opensearch-observability/src/main/plugin-metadata/plugin-security.policy @@ -4,7 +4,7 @@ */ grant { - // needed to find the classloader to load whitelisted classes. + // needed to find the classloader to load allowlisted classes. permission java.lang.RuntimePermission "createClassLoader"; permission java.lang.RuntimePermission "getClassLoader";