mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
11 commits
Author | SHA1 | Message | Date | |
---|---|---|---|---|
|
6de695a55c
|
Sustainable Kibana Architecture: Move modules owned by @elastic/security-generative-ai (#202848)
## 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. #### 1 plugin(s) are going to be relocated: | Id | Target folder | | -- | ------------- | | `@kbn/elastic-assistant-plugin` | `x-pack/solutions/security/plugins/elastic_assistant` | #### 3 packages(s) are going to be relocated: | Id | Target folder | | -- | ------------- | | `@kbn/elastic-assistant` | `x-pack/platform/packages/shared/kbn-elastic-assistant` | | `@kbn/elastic-assistant-common` | `x-pack/platform/packages/shared/kbn-elastic-assistant-common` | | `@kbn/langchain` | `x-pack/platform/packages/shared/kbn-langchain` | <details > <summary>Updated references</summary> ``` ./.buildkite/scripts/steps/code_generation/elastic_assistant_codegen.sh ./.buildkite/scripts/steps/openapi_bundling/security_solution_openapi_bundling.sh ./.eslintrc.js ./.github/codeql/codeql-config.yml ./docs/developer/plugin-list.asciidoc ./oas_docs/scripts/merge_ess_oas.js ./oas_docs/scripts/merge_serverless_oas.js ./package.json ./packages/kbn-repo-packages/package-map.json ./packages/kbn-ts-projects/config-paths.json ./tsconfig.base.json ./tsconfig.base.type_check.json ./tsconfig.refs.json ./x-pack/.i18nrc.json ./x-pack/packages/kbn-elastic-assistant-common/README.md ./x-pack/platform/packages/shared/kbn-elastic-assistant-common/README.md ./x-pack/platform/packages/shared/kbn-elastic-assistant-common/env/README.md ./x-pack/platform/packages/shared/kbn-elastic-assistant-common/impl/capabilities/README.md ./x-pack/platform/packages/shared/kbn-elastic-assistant-common/jest.config.js ./x-pack/platform/packages/shared/kbn-elastic-assistant/README.md ./x-pack/platform/packages/shared/kbn-elastic-assistant/jest.config.js ./x-pack/platform/packages/shared/kbn-langchain/jest.config.js ./x-pack/plugins/elastic_assistant/README.md ./x-pack/plugins/security_solution/docs/openapi/README.md ./x-pack/solutions/security/plugins/elastic_assistant/README.md ./x-pack/solutions/security/plugins/elastic_assistant/jest.config.js ./x-pack/solutions/security/plugins/elastic_assistant/scripts/create_conversations_script.ts ./x-pack/solutions/security/plugins/elastic_assistant/server/__mocks__/docs_from_directory_loader.ts ./x-pack/solutions/security/plugins/elastic_assistant/server/knowledge_base/security_labs/embedding_security_in_llm_workflows.md ./x-pack/solutions/security/plugins/elastic_assistant/server/lib/attack_discovery/graphs/default_attack_discovery_graph/index.ts ./yarn.lock ``` </details><details > <summary>Updated relative paths</summary> ``` x-pack/platform/packages/shared/kbn-elastic-assistant-common/jest.config.js:21 x-pack/platform/packages/shared/kbn-elastic-assistant-common/scripts/openapi/bundle.js:8 x-pack/platform/packages/shared/kbn-elastic-assistant-common/scripts/openapi/generate.js:8 x-pack/platform/packages/shared/kbn-elastic-assistant-common/tsconfig.json:2 x-pack/platform/packages/shared/kbn-elastic-assistant/jest.config.js:21 x-pack/platform/packages/shared/kbn-elastic-assistant/tsconfig.json:15 x-pack/platform/packages/shared/kbn-elastic-assistant/tsconfig.json:2 x-pack/platform/packages/shared/kbn-langchain/jest.config.js:20 x-pack/platform/packages/shared/kbn-langchain/tsconfig.json:2 x-pack/solutions/security/plugins/elastic_assistant/jest.config.js:14 x-pack/solutions/security/plugins/elastic_assistant/scripts/create_conversations.js:8 x-pack/solutions/security/plugins/elastic_assistant/scripts/draw_graph.js:8 x-pack/solutions/security/plugins/elastic_assistant/scripts/model_evaluator.js:8 x-pack/solutions/security/plugins/elastic_assistant/tsconfig.json:13 x-pack/solutions/security/plugins/elastic_assistant/tsconfig.json:2 ``` </details> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> |
||
|
42af4e60a4
|
Sustainable Kibana Architecture: Move modules owned by @elastic/security-defend-workflows (#202840)
|
||
|
58b8b47928
|
Sustainable Kibana Architecture: Move modules owned by @elastic/ml-ui (#202764)
## 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. > Do not attempt to push any changes unless you know what you are doing. > Please use [#sustainable_kibana_architecture](https://elastic.slack.com/archives/C07TCKTA22E) Slack channel for feedback. #### 4 plugin(s) are going to be relocated: | Id | Target folder | | -- | ------------- | | `@kbn/aiops-plugin` | `x-pack/platform/plugins/shared/aiops` | | `@kbn/data-visualizer-plugin` | `x-pack/platform/plugins/private/data_visualizer` | | `@kbn/ml-plugin` | `x-pack/platform/plugins/shared/ml` | | `@kbn/transform-plugin` | `x-pack/platform/plugins/private/transform` | #### 42 package(s) are going to be relocated: | Id | Target folder | | -- | ------------- | | `@kbn/aiops-change-point-detection` | `x-pack/platform/packages/private/ml/aiops_change_point_detection` | | `@kbn/aiops-common` | `x-pack/platform/packages/shared/ml/aiops_common` | | `@kbn/aiops-components` | `x-pack/platform/packages/private/ml/aiops_components` | | `@kbn/aiops-log-pattern-analysis` | `x-pack/platform/packages/shared/ml/aiops_log_pattern_analysis` | | `@kbn/aiops-log-rate-analysis` | `x-pack/platform/packages/shared/ml/aiops_log_rate_analysis` | | `@kbn/aiops-test-utils` | `x-pack/platform/packages/private/ml/aiops_test_utils` | | `@kbn/deeplinks-ml` | `src/platform/packages/shared/deeplinks/ml` | | `@kbn/default-nav-ml` | `src/platform/packages/private/default-nav/ml` | | `@kbn/inference_integration_flyout` | `x-pack/platform/packages/private/ml/inference_integration_flyout` | | `@kbn/json-schemas` | `x-pack/platform/packages/private/ml/json_schemas` | | `@kbn/ml-agg-utils` | `x-pack/platform/packages/private/ml/agg_utils` | | `@kbn/ml-anomaly-utils` | `x-pack/platform/packages/shared/ml/anomaly_utils` | | `@kbn/ml-cancellable-search` | `x-pack/platform/packages/private/ml/cancellable_search` | | `@kbn/ml-category-validator` | `x-pack/platform/packages/private/ml/category_validator` | | `@kbn/ml-chi2test` | `x-pack/platform/packages/shared/ml/chi2test` | | `@kbn/ml-creation-wizard-utils` | `x-pack/platform/packages/private/ml/creation_wizard_utils` | | `@kbn/ml-data-frame-analytics-utils` | `x-pack/platform/packages/private/ml/data_frame_analytics_utils` | | `@kbn/ml-data-grid` | `x-pack/platform/packages/private/ml/data_grid` | | `@kbn/ml-data-view-utils` | `x-pack/platform/packages/private/ml/data_view_utils` | | `@kbn/ml-date-picker` | `x-pack/platform/packages/private/ml/date_picker` | | `@kbn/ml-date-utils` | `x-pack/platform/packages/private/ml/date_utils` | | `@kbn/ml-error-utils` | `x-pack/platform/packages/shared/ml/error_utils` | | `@kbn/ml-field-stats-flyout` | `x-pack/platform/packages/private/ml/field_stats_flyout` | | `@kbn/ml-in-memory-table` | `x-pack/platform/packages/private/ml/in_memory_table` | | `@kbn/ml-is-defined` | `x-pack/platform/packages/private/ml/is_defined` | | `@kbn/ml-is-populated-object` | `x-pack/platform/packages/private/ml/is_populated_object` | | `@kbn/ml-kibana-theme` | `x-pack/platform/packages/private/ml/kibana_theme` | | `@kbn/ml-local-storage` | `x-pack/platform/packages/private/ml/local_storage` | | `@kbn/ml-nested-property` | `x-pack/platform/packages/private/ml/nested_property` | | `@kbn/ml-number-utils` | `x-pack/platform/packages/private/ml/number_utils` | | `@kbn/ml-parse-interval` | `x-pack/platform/packages/private/ml/parse_interval` | | `@kbn/ml-query-utils` | `x-pack/platform/packages/private/ml/query_utils` | | `@kbn/ml-random-sampler-utils` | `x-pack/platform/packages/shared/ml/random_sampler_utils` | | `@kbn/ml-response-stream` | `x-pack/platform/packages/shared/ml/response_stream` | | `@kbn/ml-route-utils` | `x-pack/platform/packages/private/ml/route_utils` | | `@kbn/ml-runtime-field-utils` | `x-pack/platform/packages/shared/ml/runtime_field_utils` | | `@kbn/ml-string-hash` | `x-pack/platform/packages/private/ml/string_hash` | | `@kbn/ml-time-buckets` | `x-pack/platform/packages/private/ml/time_buckets` | | `@kbn/ml-trained-models-utils` | `x-pack/platform/packages/shared/ml/trained_models_utils` | | `@kbn/ml-ui-actions` | `x-pack/platform/packages/private/ml/ui_actions` | | `@kbn/ml-url-state` | `x-pack/platform/packages/private/ml/url_state` | | `@kbn/ml-validators` | `x-pack/platform/packages/private/ml/validators` | <details> <summary>Updated references</summary> ``` ./.eslintrc.js ./docs/developer/plugin-list.asciidoc ./docs/redirects.asciidoc ./oas_docs/scripts/merge_ess_oas.js ./oas_docs/scripts/merge_serverless_oas.js ./package.json ./packages/kbn-repo-packages/package-map.json ./packages/kbn-synthetic-package-map/synthetic-packages.json ./packages/kbn-ts-projects/config-paths.json ./src/platform/packages/private/default-nav/ml/jest.config.js ./src/platform/packages/shared/deeplinks/ml/jest.config.js ./tsconfig.base.json ./tsconfig.refs.json ./x-pack/.i18nrc.json ./x-pack/packages/security-solution/navigation/src/constants.ts ./x-pack/platform/packages/private/ml/agg_utils/jest.config.js ./x-pack/platform/packages/private/ml/aiops_change_point_detection/jest.config.js ./x-pack/platform/packages/private/ml/aiops_components/jest.config.js ./x-pack/platform/packages/private/ml/aiops_test_utils/jest.config.js ./x-pack/platform/packages/private/ml/cancellable_search/jest.config.js ./x-pack/platform/packages/private/ml/category_validator/jest.config.js ./x-pack/platform/packages/private/ml/creation_wizard_utils/jest.config.js ./x-pack/platform/packages/private/ml/data_frame_analytics_utils/jest.config.js ./x-pack/platform/packages/private/ml/data_grid/jest.config.js ./x-pack/platform/packages/private/ml/data_view_utils/jest.config.js ./x-pack/platform/packages/private/ml/date_picker/jest.config.js ./x-pack/platform/packages/private/ml/date_utils/jest.config.js ./x-pack/platform/packages/private/ml/field_stats_flyout/jest.config.js ./x-pack/platform/packages/private/ml/in_memory_table/jest.config.js ./x-pack/platform/packages/private/ml/inference_integration_flyout/jest.config.js ./x-pack/platform/packages/private/ml/is_defined/jest.config.js ./x-pack/platform/packages/private/ml/is_populated_object/jest.config.js ./x-pack/platform/packages/private/ml/json_schemas/jest.config.js ./x-pack/platform/packages/private/ml/kibana_theme/jest.config.js ./x-pack/platform/packages/private/ml/local_storage/jest.config.js ./x-pack/platform/packages/private/ml/nested_property/jest.config.js ./x-pack/platform/packages/private/ml/number_utils/jest.config.js ./x-pack/platform/packages/private/ml/parse_interval/jest.config.js ./x-pack/platform/packages/private/ml/query_utils/jest.config.js ./x-pack/platform/packages/private/ml/route_utils/jest.config.js ./x-pack/platform/packages/private/ml/string_hash/jest.config.js ./x-pack/platform/packages/private/ml/time_buckets/jest.config.js ./x-pack/platform/packages/private/ml/ui_actions/jest.config.js ./x-pack/platform/packages/private/ml/url_state/jest.config.js ./x-pack/platform/packages/private/ml/validators/jest.config.js ./x-pack/platform/packages/shared/ml/aiops_common/jest.config.js ./x-pack/platform/packages/shared/ml/aiops_log_pattern_analysis/jest.config.js ./x-pack/platform/packages/shared/ml/aiops_log_rate_analysis/jest.config.js ./x-pack/platform/packages/shared/ml/anomaly_utils/jest.config.js ./x-pack/platform/packages/shared/ml/chi2test/jest.config.js ./x-pack/platform/packages/shared/ml/error_utils/jest.config.js ./x-pack/platform/packages/shared/ml/random_sampler_utils/jest.config.js ./x-pack/platform/packages/shared/ml/response_stream/jest.config.js ./x-pack/platform/packages/shared/ml/runtime_field_utils/jest.config.js ./x-pack/platform/packages/shared/ml/trained_models_utils/jest.config.js ./x-pack/platform/plugins/private/data_visualizer/jest.config.js ./x-pack/platform/plugins/private/transform/jest.config.js ./x-pack/platform/plugins/private/transform/readme.md ./x-pack/platform/plugins/shared/aiops/README.md ./x-pack/platform/plugins/shared/aiops/jest.config.js ./x-pack/platform/plugins/shared/aiops/public/application/utils/build_extended_base_filter_criteria.ts ./x-pack/platform/plugins/shared/aiops/public/application/utils/search_utils.ts ./x-pack/platform/plugins/shared/ml/jest.config.js ./x-pack/platform/plugins/shared/ml/readme.md ./x-pack/plugins/aiops/README.md ./x-pack/plugins/security_solution/common/machine_learning/affected_job_ids.ts ./x-pack/plugins/security_solution/common/machine_learning/helpers.ts ./yarn.lock ``` </details> <details> <summary>Updated relative paths</summary> ``` src/platform/packages/private/default-nav/ml/jest.config.js:12 src/platform/packages/private/default-nav/ml/tsconfig.json:2 src/platform/packages/shared/deeplinks/ml/jest.config.js:12 src/platform/packages/shared/deeplinks/ml/tsconfig.json:2 x-pack/platform/packages/private/ml/agg_utils/jest.config.js:10 x-pack/platform/packages/private/ml/agg_utils/tsconfig.json:2 x-pack/platform/packages/private/ml/aiops_change_point_detection/jest.config.js:10 x-pack/platform/packages/private/ml/aiops_change_point_detection/tsconfig.json:2 x-pack/platform/packages/private/ml/aiops_components/jest.config.js:10 x-pack/platform/packages/private/ml/aiops_components/tsconfig.json:2 x-pack/platform/packages/private/ml/aiops_test_utils/jest.config.js:10 x-pack/platform/packages/private/ml/aiops_test_utils/tsconfig.json:2 x-pack/platform/packages/private/ml/cancellable_search/jest.config.js:10 x-pack/platform/packages/private/ml/cancellable_search/tsconfig.json:2 x-pack/platform/packages/private/ml/category_validator/jest.config.js:10 x-pack/platform/packages/private/ml/category_validator/tsconfig.json:2 x-pack/platform/packages/private/ml/creation_wizard_utils/jest.config.js:10 x-pack/platform/packages/private/ml/creation_wizard_utils/tsconfig.json:2 x-pack/platform/packages/private/ml/data_frame_analytics_utils/jest.config.js:10 x-pack/platform/packages/private/ml/data_frame_analytics_utils/tsconfig.json:2 x-pack/platform/packages/private/ml/data_grid/jest.config.js:10 x-pack/platform/packages/private/ml/data_grid/tsconfig.json:2 x-pack/platform/packages/private/ml/data_view_utils/jest.config.js:10 x-pack/platform/packages/private/ml/data_view_utils/tsconfig.json:2 x-pack/platform/packages/private/ml/date_picker/jest.config.js:10 x-pack/platform/packages/private/ml/date_picker/tsconfig.json:2 x-pack/platform/packages/private/ml/date_utils/jest.config.js:10 x-pack/platform/packages/private/ml/date_utils/tsconfig.json:2 x-pack/platform/packages/private/ml/field_stats_flyout/jest.config.js:10 x-pack/platform/packages/private/ml/field_stats_flyout/tsconfig.json:2 x-pack/platform/packages/private/ml/in_memory_table/jest.config.js:10 x-pack/platform/packages/private/ml/in_memory_table/tsconfig.json:2 x-pack/platform/packages/private/ml/inference_integration_flyout/jest.config.js:10 x-pack/platform/packages/private/ml/inference_integration_flyout/tsconfig.json:2 x-pack/platform/packages/private/ml/is_defined/jest.config.js:10 x-pack/platform/packages/private/ml/is_defined/tsconfig.json:2 x-pack/platform/packages/private/ml/is_populated_object/jest.config.js:10 x-pack/platform/packages/private/ml/is_populated_object/tsconfig.json:2 x-pack/platform/packages/private/ml/json_schemas/jest.config.js:10 x-pack/platform/packages/private/ml/json_schemas/package.json:7 x-pack/platform/packages/private/ml/json_schemas/tsconfig.json:2 x-pack/platform/packages/private/ml/kibana_theme/jest.config.js:10 x-pack/platform/packages/private/ml/kibana_theme/tsconfig.json:2 x-pack/platform/packages/private/ml/local_storage/jest.config.js:10 x-pack/platform/packages/private/ml/local_storage/tsconfig.json:2 x-pack/platform/packages/private/ml/nested_property/jest.config.js:10 x-pack/platform/packages/private/ml/nested_property/tsconfig.json:2 x-pack/platform/packages/private/ml/number_utils/jest.config.js:10 x-pack/platform/packages/private/ml/number_utils/tsconfig.json:2 x-pack/platform/packages/private/ml/parse_interval/jest.config.js:10 x-pack/platform/packages/private/ml/parse_interval/tsconfig.json:2 x-pack/platform/packages/private/ml/query_utils/jest.config.js:10 x-pack/platform/packages/private/ml/query_utils/tsconfig.json:2 x-pack/platform/packages/private/ml/route_utils/jest.config.js:10 x-pack/platform/packages/private/ml/route_utils/tsconfig.json:2 x-pack/platform/packages/private/ml/string_hash/jest.config.js:10 x-pack/platform/packages/private/ml/string_hash/tsconfig.json:2 x-pack/platform/packages/private/ml/time_buckets/jest.config.js:10 x-pack/platform/packages/private/ml/time_buckets/tsconfig.json:2 x-pack/platform/packages/private/ml/ui_actions/jest.config.js:10 x-pack/platform/packages/private/ml/ui_actions/tsconfig.json:2 x-pack/platform/packages/private/ml/url_state/jest.config.js:10 x-pack/platform/packages/private/ml/url_state/tsconfig.json:2 x-pack/platform/packages/private/ml/validators/jest.config.js:10 x-pack/platform/packages/private/ml/validators/tsconfig.json:2 x-pack/platform/packages/shared/ml/aiops_common/jest.config.js:10 x-pack/platform/packages/shared/ml/aiops_common/tsconfig.json:2 x-pack/platform/packages/shared/ml/aiops_log_pattern_analysis/jest.config.js:10 x-pack/platform/packages/shared/ml/aiops_log_pattern_analysis/tsconfig.json:2 x-pack/platform/packages/shared/ml/aiops_log_rate_analysis/jest.config.js:10 x-pack/platform/packages/shared/ml/aiops_log_rate_analysis/tsconfig.json:2 x-pack/platform/packages/shared/ml/anomaly_utils/jest.config.js:10 x-pack/platform/packages/shared/ml/anomaly_utils/tsconfig.json:2 x-pack/platform/packages/shared/ml/chi2test/jest.config.js:10 x-pack/platform/packages/shared/ml/chi2test/tsconfig.json:2 x-pack/platform/packages/shared/ml/error_utils/jest.config.js:10 x-pack/platform/packages/shared/ml/error_utils/tsconfig.json:2 x-pack/platform/packages/shared/ml/random_sampler_utils/jest.config.js:10 x-pack/platform/packages/shared/ml/random_sampler_utils/tsconfig.json:2 x-pack/platform/packages/shared/ml/response_stream/jest.config.js:10 x-pack/platform/packages/shared/ml/response_stream/tsconfig.json:2 x-pack/platform/packages/shared/ml/runtime_field_utils/jest.config.js:10 x-pack/platform/packages/shared/ml/runtime_field_utils/tsconfig.json:2 x-pack/platform/packages/shared/ml/trained_models_utils/jest.config.js:10 x-pack/platform/packages/shared/ml/trained_models_utils/tsconfig.json:2 x-pack/platform/plugins/private/data_visualizer/jest.config.js:10 x-pack/platform/plugins/private/data_visualizer/tsconfig.json:2 x-pack/platform/plugins/private/data_visualizer/tsconfig.json:7 x-pack/platform/plugins/private/transform/jest.config.js:10 x-pack/platform/plugins/private/transform/tsconfig.json:10 x-pack/platform/plugins/private/transform/tsconfig.json:2 x-pack/platform/plugins/shared/aiops/jest.config.js:10 x-pack/platform/plugins/shared/aiops/tsconfig.json:2 x-pack/platform/plugins/shared/aiops/tsconfig.json:7 x-pack/platform/plugins/shared/ml/jest.config.js:10 x-pack/platform/plugins/shared/ml/readme.md:186 x-pack/platform/plugins/shared/ml/readme.md:192 x-pack/platform/plugins/shared/ml/tsconfig.json:12 x-pack/platform/plugins/shared/ml/tsconfig.json:2 x-pack/platform/plugins/shared/ml/tsconfig.json:24 ``` </details> <details> <summary>Script errors</summary> ``` ``` </details> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Walter Rafelsberger <walter.rafelsberger@elastic.co> |
||
|
e0838147bd
|
OpenAPI docs for APM UI APIs (#197946)
## Summary
Closes #197582
This PR adds missing OpenAPI specification for APM UI APIs.
Documentation specs have been divided into files per path. See
[readme](
|
||
|
52abebf0cb
|
[Fleet] remove old bundled.yaml from oas, fixed tags (#194788)
## Summary Closes https://github.com/elastic/kibana/issues/184685 **Release notes**: These schema changes shouldn't be breaking, but there were some incorrect/missing response schemas in the old openapi spec. For example the API `POST /api/fleet/agents/{agentId}/actions` response was incorrectly documented: https://petstore.swagger.io/?url=https://raw.githubusercontent.com/elastic/kibana/main/x-pack/plugins/fleet/common/openapi/bundled.json#/Elastic%20Agent%20actions/new-agent-action ``` { "body": [ 0 ], "statusCode": 0, "headers": "string" } ``` Fixed here: |
||
|
102297ca15
|
[HTTP/OAS] Include Security Solution domain OAS to production docs (#194132)
*Epic:** https://github.com/elastic/security-team/issues/9401 (internal) ## Summary This PR includes Security Solution OpenAPI domain bundles into the production OpenAPI Kibana bundle. The result Kibana bundler is expected to be published to Bump.sh manually by @lcawl. |
||
|
b6287708f6
|
Adds AGPL 3.0 license (#192025)
Updates files outside of x-pack to be triple-licensed under Elastic License 2.0, AGPL 3.0, or SSPL 1.0. |
||
|
4a3fa7ea22
|
[OAS] Include connector APIs (#191679) | ||
|
444b8d010e
|
[DOCS][OAS] Add Fleet APIs (#190571) | ||
|
1144c0cea7
|
[OAS][DOCS] Temporarily omit security APIs from docs (#190467) | ||
|
7a2e7bef96
|
[HTTP/OAS] Merge OpenAPI specs by using kbn-openapi-bundler (#189262)
**Addresses:** https://github.com/elastic/kibana/issues/186356 **Relates to:** https://github.com/elastic/kibana/issues/184428 ## Summary This PR adds a merging JS script based on the utility implemented in https://github.com/elastic/kibana/issues/186356. Resulted OpenAPI bundle as committed in `oas_docs/output/kibana.serverless.bundled.yaml`. ## Details https://github.com/elastic/kibana/pull/188110 implements and exposes `merge` utility design to merge source OpenAPI specs without processing. It's has only a programmatic API. To merge OpenAPI specs it's required to add a JS script like below ```js const { merge } = require('@kbn/openapi-bundler'); (async () => { await merge({ sourceGlobs: [/* a list of source globs goes here */], outputFilePath: 'path/to/the/output/file.yaml', }); })(); ``` The JS script added in this PR includes source OpenAPI specs presented in `oas_docs/makefile` plus Security Solution OpenAPI specs based on https://github.com/elastic/kibana/issues/184428. **To run** the script use the following command from Kibana root folder ```bash node ./oas_docs/scripts/merge_serverless_oas.js ``` ## Known linting issues with Security Solution OpenAPI specs Running Spectral OpenAPI linter on the result bundle shows a number of errors caused by `no-$ref-siblings` rule. This caused by the current code generator implementation which requires `default` property to be set next to `$ref` though it's not correct for OpenAPI `3.0.3` while it's allowed in `3.1`. It seems that Bump.sh handles such cases properly though by properly showing a default value. We need to analyze the problem and decide if/when we should fix it. The rest of warnings look fixable and will be addressed in the next stage after setting up linter rules. ## Next steps Since `@kbn/openapi-bundler` package is tailored specifically for Kibana it should replace Redocly currently used to merge OpenAPI specs. It also means `oas_docs/makefile` should be superseded by JS script(s) using `merge` utility form `@kbn/openapi-bundler` package. `@kbn/openapi-bundler` SHOULD NOT replace OpenAPI linters since it doesn't perform thorough linting. It's good if we continue adopting `spectral-cli` for linting purposes. |