mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
9ecc8186dd
## Summary This PR aims at relocating some of the Kibana modules (plugins and packages) into a new folder structure, according to the _Sustainable Kibana Architecture_ initiative. > [!IMPORTANT] > * We kindly ask you to: > * Manually fix the errors in the error section below (if there are any). > * Search for the `packages[\/\\]` and `plugins[\/\\]` patterns in the source code (Babel and Eslint config files), and update them appropriately. > * Manually review `.buildkite/scripts/pipelines/pull_request/pipeline.ts` to ensure that any CI pipeline customizations continue to be correctly applied after the changed path names > * Review all of the updated files, specially the `.ts` and `.js` files listed in the sections below, as some of them contain relative paths that have been updated. > * Think of potential impact of the move, including tooling and configuration files that can be pointing to the relocated modules. E.g.: > * customised eslint rules > * docs pointing to source code > [!NOTE] > * This PR has been auto-generated. > * Any manual contributions will be lost if the 'relocate' script is re-run. > * Try to obtain the missing reviews / approvals before applying manual fixes, and/or keep your changes in a .patch / git stash. > * Please use [#sustainable_kibana_architecture](https://elastic.slack.com/archives/C07TCKTA22E) Slack channel for feedback. Are you trying to rebase this PR to solve merge conflicts? Please follow the steps describe [here](https://elastic.slack.com/archives/C07TCKTA22E/p1734019532879269?thread_ts=1734019339.935419&cid=C07TCKTA22E). #### 3 plugin(s) are going to be relocated: | Id | Target folder | | -- | ------------- | | `@kbn/security-solution-ess` | `x-pack/solutions/security/plugins/security_solution_ess` | | `@kbn/security-solution-plugin` | `x-pack/solutions/security/plugins/security_solution` | | `@kbn/security-solution-serverless` | `x-pack/solutions/security/plugins/security_solution_serverless` | #### 2 packages(s) are going to be relocated: | Id | Target folder | | -- | ------------- | | `@kbn/deeplinks-security` | `src/platform/packages/shared/deeplinks/security` | | `@kbn/serverless-security-settings` | `src/platform/packages/shared/serverless/settings/security_project` | <details open> <summary>Script errors</summary> ``` Cannot replace multiple occurrences of "../../.." in the same line, please fix manually: /Users/gsoldevila/.backport/repositories/elastic/kibana/x-pack/solutions/security/plugins/security_solution/package.json:25 Cannot replace multiple occurrences of "../../.." in the same line, please fix manually: /Users/gsoldevila/.backport/repositories/elastic/kibana/x-pack/solutions/security/plugins/security_solution/package.json:25 Cannot replace multiple occurrences of "../../.." in the same line, please fix manually: /Users/gsoldevila/.backport/repositories/elastic/kibana/x-pack/solutions/security/plugins/security_solution/package.json:25 Cannot replace multiple occurrences of "../../.." in the same line, please fix manually: /Users/gsoldevila/.backport/repositories/elastic/kibana/x-pack/solutions/security/plugins/security_solution/package.json:25 Cannot replace multiple occurrences of "../../.." in the same line, please fix manually: /Users/gsoldevila/.backport/repositories/elastic/kibana/x-pack/solutions/security/plugins/security_solution/package.json:25 Cannot replace multiple occurrences of "../../.." in the same line, please fix manually: /Users/gsoldevila/.backport/repositories/elastic/kibana/x-pack/solutions/security/plugins/security_solution/package.json:25 Cannot replace multiple occurrences of "../../.." in the same line, please fix manually: /Users/gsoldevila/.backport/repositories/elastic/kibana/x-pack/solutions/security/plugins/security_solution/package.json:25 Cannot replace multiple occurrences of "../../.." in the same line, please fix manually: /Users/gsoldevila/.backport/repositories/elastic/kibana/x-pack/solutions/security/plugins/security_solution/package.json:25 Cannot replace multiple occurrences of "../../.." in the same line, please fix manually: /Users/gsoldevila/.backport/repositories/elastic/kibana/x-pack/solutions/security/plugins/security_solution/package.json:31 ``` </details><details > <summary>Updated references</summary> ``` ./.buildkite/scripts/packer_cache.sh ./.buildkite/scripts/pipelines/security_solution_quality_gate/edr_workflows/mki_security_solution_defend_workflows.sh ./.buildkite/scripts/steps/code_generation/security_solution_codegen.sh ./.buildkite/scripts/steps/functional/defend_workflows.sh ./.buildkite/scripts/steps/functional/defend_workflows_burn.sh ./.buildkite/scripts/steps/functional/defend_workflows_serverless.sh ./.buildkite/scripts/steps/functional/defend_workflows_serverless_burn.sh ./.buildkite/scripts/steps/openapi_bundling/security_solution_openapi_bundling.sh ./.eslintrc.js ./.github/codeql/codeql-config.yml ./.gitignore ./docs/developer/plugin-list.asciidoc ./oas_docs/scripts/merge_ess_oas.js ./package.json ./packages/kbn-dependency-usage/README.md ./packages/kbn-dependency-usage/src/dependency_graph/providers/cruiser.test.ts ./packages/kbn-openapi-generator/README.md ./packages/kbn-repo-packages/package-map.json ./packages/kbn-securitysolution-io-ts-types/src/version/index.ts ./packages/kbn-ts-projects/config-paths.json ./packages/kbn-zod-helpers/README.md ./src/dev/code_coverage/docs/team_assignment/README.md ./src/dev/precommit_hook/casing_check_config.js ./src/dev/storybook/aliases.ts ./src/platform/packages/shared/deeplinks/security/jest.config.js ./src/plugins/data/server/search/search_service.ts ./src/plugins/guided_onboarding/README.md ./tsconfig.base.json ./tsconfig.refs.json ./x-pack/.i18nrc.json ./x-pack/README.md ./x-pack/platform/packages/shared/kbn-elastic-assistant-common/README.md ./x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/prompt_context/types.ts ./x-pack/platform/packages/shared/kbn-elastic-assistant/index.ts ./x-pack/platform/plugins/shared/osquery/package.json ./x-pack/plugins/cloud_defend/public/common/navigation/types.ts ./x-pack/plugins/cloud_security_posture/public/common/navigation/types.ts ./x-pack/plugins/fleet/dev_docs/fleet_ui_extensions.md ./x-pack/plugins/fleet/server/services/epm/archive/parse.ts ./x-pack/plugins/fleet/server/telemetry/sender.ts ./x-pack/plugins/lists/server/routes/utils/build_siem_response.ts ./x-pack/plugins/lists/server/routes/utils/route_validation.test.ts ./x-pack/plugins/lists/server/routes/utils/route_validation.ts ./x-pack/plugins/rule_registry/common/schemas/README.md ./x-pack/plugins/rule_registry/server/routes/utils/route_validation.ts ./x-pack/solutions/observability/plugins/synthetics/server/telemetry/sender.ts ./x-pack/solutions/security/packages/data_table/README.md ./x-pack/solutions/security/packages/expandable-flyout/README.md ./x-pack/solutions/security/packages/features/src/security/types.ts ./x-pack/solutions/security/packages/navigation/src/constants.ts ./x-pack/solutions/security/plugins/elastic_assistant/server/routes/user_conversations/find_route.ts ./x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/model/alerts/README.md ./x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff_conflict.ts ./x-pack/solutions/security/plugins/security_solution/common/api/endpoint/README.md ./x-pack/solutions/security/plugins/security_solution/common/api/endpoint/actions/response_actions/kill_process/kill_process.ts ./x-pack/solutions/security/plugins/security_solution/common/endpoint/service/response_actions/constants.ts ./x-pack/solutions/security/plugins/security_solution/common/endpoint/utils/kibana_status.ts ./x-pack/solutions/security/plugins/security_solution/common/jest.config.js ./x-pack/solutions/security/plugins/security_solution/docs/adrs/threat_hunting/0001_saving_of_timeline_associated_saved_objects.md ./x-pack/solutions/security/plugins/security_solution/docs/openapi/README.md ./x-pack/solutions/security/plugins/security_solution/docs/rfcs/detection_response/prebuilt_rules_customization.md ./x-pack/solutions/security/plugins/security_solution/jest.config.dev.js ./x-pack/solutions/security/plugins/security_solution/jest.integration.config.js ./x-pack/solutions/security/plugins/security_solution/public/app/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/assistant/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/attack_discovery/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/cases/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/cloud_security_posture/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/common/components/toasters/utils.ts ./x-pack/solutions/security/plugins/security_solution/public/common/components/with_security_context/store.ts ./x-pack/solutions/security/plugins/security_solution/public/common/hooks/use_app_toasts.ts ./x-pack/solutions/security/plugins/security_solution/public/common/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/dashboards/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/detection_engine/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/detections/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/entity_analytics/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/exceptions/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/explore/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/flyout/README.md ./x-pack/solutions/security/plugins/security_solution/public/flyout/document_details/right/hooks/use_fetch_threat_intelligence.ts ./x-pack/solutions/security/plugins/security_solution/public/flyout/document_details/shared/mocks/mock_get_fields_data.ts ./x-pack/solutions/security/plugins/security_solution/public/flyout/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/management/cypress/README.md ./x-pack/solutions/security/plugins/security_solution/public/management/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/notes/api/api.ts ./x-pack/solutions/security/plugins/security_solution/public/notes/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/onboarding/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/overview/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/resolver/documentation/schema.md ./x-pack/solutions/security/plugins/security_solution/public/resolver/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/security_integrations/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/siem_migrations/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/sourcerer/jest.config.js ./x-pack/solutions/security/plugins/security_solution/public/threat_intelligence/use_investigate_in_timeline.ts ./x-pack/solutions/security/plugins/security_solution/public/timelines/jest.config.js ./x-pack/solutions/security/plugins/security_solution/scripts/endpoint/README.md ./x-pack/solutions/security/plugins/security_solution/scripts/endpoint/api_emulator/README.md ./x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/roles_users/serverless/es_serverless_resources/README.md ./x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/vm_services.ts ./x-pack/solutions/security/plugins/security_solution/scripts/jest.config.js ./x-pack/solutions/security/plugins/security_solution/scripts/junit_transformer/__snapshots__/junit_transformer.test.ts.snap ./x-pack/solutions/security/plugins/security_solution/scripts/junit_transformer/fixtures/suite_with_failing_test.xml ./x-pack/solutions/security/plugins/security_solution/scripts/mappings/README.md ./x-pack/solutions/security/plugins/security_solution/scripts/openapi/generate.js ./x-pack/solutions/security/plugins/security_solution/scripts/quickstart/README.md ./x-pack/solutions/security/plugins/security_solution/scripts/run_cypress/utils.ts ./x-pack/solutions/security/plugins/security_solution/scripts/telemetry/README.md ./x-pack/solutions/security/plugins/security_solution/server/__mocks__/module_name_map.js ./x-pack/solutions/security/plugins/security_solution/server/assistant/jest.config.js ./x-pack/solutions/security/plugins/security_solution/server/client/jest.config.js ./x-pack/solutions/security/plugins/security_solution/server/config.ts ./x-pack/solutions/security/plugins/security_solution/server/endpoint/jest.config.js ./x-pack/solutions/security/plugins/security_solution/server/endpoint/services/agent/clients/endpoint/endpoint_agent_status_client.test.ts ./x-pack/solutions/security/plugins/security_solution/server/endpoint/services/metadata/mocks.ts ./x-pack/solutions/security/plugins/security_solution/server/fleet_integration/jest.config.js ./x-pack/solutions/security/plugins/security_solution/server/integration_tests/lib/helpers.ts ./x-pack/solutions/security/plugins/security_solution/server/jest.config.js ./x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/README.md ./x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/content/prepackaged_timelines/README.md ./x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_monitoring/logic/detection_engine_health/README.md ./x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_types/new_terms/bulk_create_suppressed_alerts_in_memory.ts ./x-pack/solutions/security/plugins/security_solution/server/lib/entity_analytics/risk_score/painless/index.test.ts ./x-pack/solutions/security/plugins/security_solution/server/lib/jest.config.js ./x-pack/solutions/security/plugins/security_solution/server/lib/risk_score/readme.md ./x-pack/solutions/security/plugins/security_solution/server/lib/telemetry/artifact.test.ts ./x-pack/solutions/security/plugins/security_solution/server/lib/timeline/routes/notes/get_notes.ts ./x-pack/solutions/security/plugins/security_solution/server/lists_integration/jest.config.js ./x-pack/solutions/security/plugins/security_solution/server/search_strategy/jest.config.js ./x-pack/solutions/security/plugins/security_solution/server/usage/jest.config.js ./x-pack/solutions/security/plugins/security_solution/server/utils/jest.config.js ./x-pack/solutions/security/plugins/security_solution_ess/jest.config.dev.js ./x-pack/solutions/security/plugins/security_solution_ess/public/jest.config.js ./x-pack/solutions/security/plugins/security_solution_serverless/common/config.ts ./x-pack/solutions/security/plugins/security_solution_serverless/common/jest.config.js ./x-pack/solutions/security/plugins/security_solution_serverless/jest.config.dev.js ./x-pack/solutions/security/plugins/security_solution_serverless/public/jest.config.js ./x-pack/solutions/security/plugins/security_solution_serverless/server/config.ts ./x-pack/solutions/security/plugins/security_solution_serverless/server/jest.config.js ./x-pack/solutions/security/plugins/threat_intelligence/README.md ./x-pack/solutions/security/plugins/threat_intelligence/common/types/indicator.ts ./x-pack/solutions/security/plugins/threat_intelligence/public/modules/timeline/hooks/use_add_to_timeline.ts ./x-pack/solutions/security/plugins/threat_intelligence/public/modules/timeline/hooks/use_investigate_in_timeline.ts ./x-pack/solutions/security/plugins/threat_intelligence/public/types.ts ./x-pack/solutions/security/plugins/threat_intelligence/public/utils/security_solution_links.ts ./x-pack/solutions/security/plugins/timelines/common/types/timeline/cells/index.ts ./x-pack/solutions/security/plugins/timelines/common/types/timeline/rows/index.ts ./x-pack/solutions/security/plugins/timelines/public/hooks/use_app_toasts.ts ./x-pack/test/security_solution_api_integration/test_suites/detections_response/detection_engine/rule_execution_logic/eql/trial_license_complete_tier/eql_alert_suppression.ts ./x-pack/test/security_solution_cypress/cypress/tsconfig.json ./x-pack/test/security_solution_cypress/package.json ./x-pack/test/security_solution_endpoint/page_objects/policy_page.ts ./x-pack/test/security_solution_playwright/package.json ./x-pack/test/security_solution_playwright/tsconfig.json ./yarn.lock .github/CODEOWNERS ``` </details><details > <summary>Updated relative paths</summary> ``` src/platform/packages/shared/deeplinks/security/jest.config.js:12 src/platform/packages/shared/deeplinks/security/tsconfig.json:2 src/platform/packages/shared/serverless/settings/security_project/tsconfig.json:2 x-pack/solutions/security/plugins/security_solution/README.md:100 x-pack/solutions/security/plugins/security_solution/README.md:22 x-pack/solutions/security/plugins/security_solution/README.md:26 x-pack/solutions/security/plugins/security_solution/README.md:31 x-pack/solutions/security/plugins/security_solution/common/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/docs/openapi/README.md:3 x-pack/solutions/security/plugins/security_solution/docs/openapi/README.md:7 x-pack/solutions/security/plugins/security_solution/jest.config.dev.js:10 x-pack/solutions/security/plugins/security_solution/jest.integration.config.js:10 x-pack/solutions/security/plugins/security_solution/package.json:10 x-pack/solutions/security/plugins/security_solution/package.json:13 x-pack/solutions/security/plugins/security_solution/package.json:16 x-pack/solutions/security/plugins/security_solution/package.json:25 x-pack/solutions/security/plugins/security_solution/package.json:31 x-pack/solutions/security/plugins/security_solution/package.json:8 x-pack/solutions/security/plugins/security_solution/package.json:9 x-pack/solutions/security/plugins/security_solution/public/app/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/assistant/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/attack_discovery/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/cases/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/cloud_security_posture/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/common/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/dashboards/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/detection_engine/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/detections/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/entity_analytics/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/exceptions/hooks/use_import_exception_list/index.tsx:25 x-pack/solutions/security/plugins/security_solution/public/exceptions/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/explore/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/flyout/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/management/cypress/cypress_base.config.ts:27 x-pack/solutions/security/plugins/security_solution/public/management/cypress/tsconfig.json:2 x-pack/solutions/security/plugins/security_solution/public/management/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/management/reporter_config.json:12 x-pack/solutions/security/plugins/security_solution/public/management/reporter_config.json:14 x-pack/solutions/security/plugins/security_solution/public/notes/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/onboarding/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/overview/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/resolver/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/security_integrations/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/siem_migrations/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/sourcerer/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/public/timelines/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/scripts/beat_docs/build.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/agent_downloader.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/endpoint_agent_emulator.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/load_agent_policies.js:10 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/load_blocklists.js:10 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/load_endpoint_policies.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/load_env_data.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/load_event_filters.js:10 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/load_host_isolation_exceptions.js:10 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/load_trusted_apps.js:10 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/resolver_generator.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/run_endpoint_agent.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/run_sentinelone_host.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/start_es_serverless_with_security_users.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/start_external_edr_server_emulator.js:8 x-pack/solutions/security/plugins/security_solution/scripts/endpoint/start_fleet_server.js:8 x-pack/solutions/security/plugins/security_solution/scripts/extract_tactics_techniques_mitre.js:8 x-pack/solutions/security/plugins/security_solution/scripts/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/scripts/junit_transformer/index.js:8 x-pack/solutions/security/plugins/security_solution/scripts/mappings/mappings_generator.js:8 x-pack/solutions/security/plugins/security_solution/scripts/mappings/mappings_loader.js:8 x-pack/solutions/security/plugins/security_solution/scripts/mappings/mappings_loader_script.ts:20 x-pack/solutions/security/plugins/security_solution/scripts/mappings/mappings_loader_script.ts:21 x-pack/solutions/security/plugins/security_solution/scripts/openapi/bundle_detections.js:8 x-pack/solutions/security/plugins/security_solution/scripts/openapi/bundle_endpoint_management.js:8 x-pack/solutions/security/plugins/security_solution/scripts/openapi/bundle_entity_analytics.js:8 x-pack/solutions/security/plugins/security_solution/scripts/openapi/bundle_timeline.js:8 x-pack/solutions/security/plugins/security_solution/scripts/openapi/generate.js:8 x-pack/solutions/security/plugins/security_solution/scripts/quickstart/run.js:8 x-pack/solutions/security/plugins/security_solution/scripts/run_playwright/playwright.ts:327 x-pack/solutions/security/plugins/security_solution/scripts/run_playwright/playwright.ts:337 x-pack/solutions/security/plugins/security_solution/scripts/run_playwright/start_playwright.js:8 x-pack/solutions/security/plugins/security_solution/scripts/siem_migration/draw_graphs.js:8 x-pack/solutions/security/plugins/security_solution/scripts/start_cypress_parallel.js:8 x-pack/solutions/security/plugins/security_solution/scripts/start_cypress_parallel_serverless.js:8 x-pack/solutions/security/plugins/security_solution/server/assistant/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/server/client/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/server/endpoint/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/server/fleet_integration/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/server/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts:18 x-pack/solutions/security/plugins/security_solution/server/lib/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/server/lists_integration/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/server/search_strategy/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/server/usage/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/server/utils/jest.config.js:10 x-pack/solutions/security/plugins/security_solution/tsconfig.json:16 x-pack/solutions/security/plugins/security_solution/tsconfig.json:2 x-pack/solutions/security/plugins/security_solution/tsconfig.json:22 x-pack/solutions/security/plugins/security_solution_ess/README.md:76 x-pack/solutions/security/plugins/security_solution_ess/jest.config.dev.js:10 x-pack/solutions/security/plugins/security_solution_ess/package.json:8 x-pack/solutions/security/plugins/security_solution_ess/package.json:9 x-pack/solutions/security/plugins/security_solution_ess/public/jest.config.js:9 x-pack/solutions/security/plugins/security_solution_ess/tsconfig.json:12 x-pack/solutions/security/plugins/security_solution_ess/tsconfig.json:2 x-pack/solutions/security/plugins/security_solution_serverless/README.md:78 x-pack/solutions/security/plugins/security_solution_serverless/common/jest.config.js:10 x-pack/solutions/security/plugins/security_solution_serverless/jest.config.dev.js:10 x-pack/solutions/security/plugins/security_solution_serverless/package.json:8 x-pack/solutions/security/plugins/security_solution_serverless/package.json:9 x-pack/solutions/security/plugins/security_solution_serverless/public/jest.config.js:10 x-pack/solutions/security/plugins/security_solution_serverless/server/jest.config.js:11 x-pack/solutions/security/plugins/security_solution_serverless/tsconfig.json:12 x-pack/solutions/security/plugins/security_solution_serverless/tsconfig.json:2 ``` </details> --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| examples | ||
| linters | ||
| output | ||
| overlays | ||
| scripts | ||
| bundle.json | ||
| kibana.info.yaml | ||
| makefile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
Kibana API reference documentation
Documentation about our OpenAPI bundling workflow and configuration. See Kibana's hosted stateful and serverless docs.
Workflow
The final goal of this workflow is to produce an OpenAPI bundle containing all Kibana's public APIs.
Step 0
OAS from Kibana's APIs are continuously extracted and captured in bundle.json and bundle.serverless.json as fully formed OAS documentation. See node scripts/capture_oas_snapshot --help for more info.
These bundles form the basis of our OpenAPI bundles to which we append and layer extra information before publishing.
Step 1
Append pre-existing bundles not extracted from code using kbn-openapi-bundler to produce the final resulting bundles.
To add more files into the final bundle, edit the appropriate oas_docs/scripts/merge*.js files.
Step 2
Apply any final overalys to the document that might include examples or final tweaks (see the "Scripts" section for more details).
Scripts
The oas_docs/scripts folder contains scripts that point to the source domain-specific OpenAPI bundles and specify additional parameters for producing the final output bundle. Currently, there are the following scripts:
-
merge_ess_oas.jsscript produces production an output bundle for ESS -
merge_serverless_oas.jsscript produces production an output bundle for Serverless
Output Kibana OpenAPI bundles
The oas_docs/output folder contains the final resulting Kibana OpenAPI bundles
kibana.yamlproduction ready ESS OpenAPI bundlekibana.serverless.yamlproduction ready Serverless OpenAPI bundle
Bundling commands
Besides the scripts in the oas_docs/scripts folder, there is an oas_docs/makefile to simplify the workflow. Use make help to see available commands.