github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/oas_docs
History
Gerard Soldevila 223781cdd1
Sustainable Kibana Architecture: Move modules owned by @elastic/obs-ux-logs-team (#202831) 
## 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).

#### 7 plugin(s) are going to be relocated:

| Id | Target folder |
| -- | ------------- |
| `@kbn/data-quality-plugin` |
`x-pack/solutions/observability/plugins/data_quality` |
| `@kbn/dataset-quality-plugin` |
`x-pack/solutions/observability/plugins/dataset_quality` |
| `@kbn/fields-metadata-plugin` |
`x-pack/platform/plugins/shared/fields_metadata` |
| `@kbn/infra-plugin` | `x-pack/solutions/observability/plugins/infra` |
| `@kbn/logs-explorer-plugin` |
`x-pack/solutions/observability/plugins/logs_explorer` |
| `@kbn/observability-logs-explorer-plugin` |
`x-pack/solutions/observability/plugins/observability_logs_explorer` |
| `@kbn/observability-onboarding-plugin` |
`x-pack/solutions/observability/plugins/observability_onboarding` |




#### 9 packages(s) are going to be relocated:

| Id | Target folder |
| -- | ------------- |
| `@kbn/custom-icons` | `src/platform/packages/shared/kbn-custom-icons`
|
| `@kbn/custom-integrations` |
`x-pack/solutions/observability/packages/kbn-custom-integrations` |
| `@kbn/discover-contextual-components` |
`src/platform/packages/shared/kbn-discover-contextual-components` |
| `@kbn/elastic-agent-utils` |
`src/platform/packages/shared/kbn-elastic-agent-utils` |
| `@kbn/observability-logs-overview` |
`x-pack/solutions/observability/packages/logs_overview` |
| `@kbn/react-hooks` | `src/platform/packages/shared/kbn-react-hooks` |
| `@kbn/router-utils` | `src/platform/packages/shared/kbn-router-utils`
|
| `@kbn/timerange` | `src/platform/packages/shared/kbn-timerange` |
| `@kbn/xstate-utils` |
`x-pack/solutions/observability/packages/kbn-xstate-utils` |


<details >
<summary>Updated references</summary>

```
./.buildkite/ftr_oblt_stateful_configs.yml
./.buildkite/scripts/steps/functional/observability_onboarding_cypress.sh
./.eslintrc.js
./.i18nrc.json
./docs/developer/plugin-list.asciidoc
./oas_docs/overlays/alerting.overlays.yaml
./package.json
./packages/kbn-ebt-tools/BUILD.bazel
./packages/kbn-repo-packages/package-map.json
./packages/kbn-text-based-editor/tsconfig.type_check.json
./packages/kbn-ts-projects/config-paths.json
./src/dev/storybook/aliases.ts
./src/platform/packages/shared/kbn-custom-icons/jest.config.js
./src/platform/packages/shared/kbn-discover-contextual-components/jest.config.js
./src/platform/packages/shared/kbn-elastic-agent-utils/jest.config.js
./src/platform/packages/shared/kbn-field-utils/tsconfig.type_check.json
./src/platform/packages/shared/kbn-react-hooks/jest.config.js
./src/platform/packages/shared/kbn-router-utils/jest.config.js
./src/platform/packages/shared/kbn-timerange/jest.config.js
./src/platform/packages/shared/kbn-unified-field-list/tsconfig.type_check.json
./src/platform/plugins/shared/discover/tsconfig.type_check.json
./src/platform/plugins/shared/esql/tsconfig.type_check.json
./src/platform/plugins/shared/unified_doc_viewer/tsconfig.type_check.json
./src/plugins/vis_types/timeseries/server/plugin.ts
./tsconfig.base.json
./tsconfig.base.type_check.json
./tsconfig.refs.json
./x-pack/.i18nrc.json
./x-pack/platform/plugins/shared/fields_metadata/jest.config.js
./x-pack/plugins/observability_solution/apm/tsconfig.type_check.json
./x-pack/plugins/observability_solution/infra/tsconfig.type_check.json
./x-pack/plugins/observability_solution/logs_shared/tsconfig.type_check.json
./x-pack/plugins/observability_solution/metrics_data_access/tsconfig.type_check.json
./x-pack/plugins/observability_solution/observability_logs_explorer/README.md
./x-pack/plugins/observability_solution/observability_onboarding/tsconfig.type_check.json
./x-pack/solutions/observability/packages/kbn-custom-integrations/jest.config.js
./x-pack/solutions/observability/packages/kbn-xstate-utils/jest.config.js
./x-pack/solutions/observability/packages/logs_overview/jest.config.js
./x-pack/solutions/observability/plugins/data_quality/jest.config.js
./x-pack/solutions/observability/plugins/dataset_quality/README.md
./x-pack/solutions/observability/plugins/dataset_quality/jest.config.js
./x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json
./x-pack/solutions/observability/plugins/infra/common/http_api/log_alerts/v1/chart_preview_data.ts
./x-pack/solutions/observability/plugins/infra/docs/telemetry/README.md
./x-pack/solutions/observability/plugins/infra/jest.config.js
./x-pack/solutions/observability/plugins/infra/public/plugin.ts
./x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json
./x-pack/solutions/observability/plugins/logs_explorer/jest.config.js
./x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json
./x-pack/solutions/observability/plugins/observability/public/utils/datemath.ts
./x-pack/solutions/observability/plugins/observability_logs_explorer/README.md
./x-pack/solutions/observability/plugins/observability_logs_explorer/jest.config.js
./x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json
./x-pack/solutions/observability/plugins/observability_onboarding/e2e/README.md
./x-pack/solutions/observability/plugins/observability_onboarding/jest.config.js
./x-pack/test/tsconfig.type_check.json
./x-pack/test_serverless/tsconfig.type_check.json
./yarn.lock
.github/CODEOWNERS
```

</details><details >
<summary>Updated relative paths</summary>

```
src/platform/packages/shared/kbn-custom-icons/jest.config.js:12
src/platform/packages/shared/kbn-custom-icons/tsconfig.json:2
src/platform/packages/shared/kbn-custom-icons/tsconfig.type_check.json:2
src/platform/packages/shared/kbn-custom-icons/tsconfig.type_check.json:26
src/platform/packages/shared/kbn-discover-contextual-components/jest.config.js:12
src/platform/packages/shared/kbn-discover-contextual-components/tsconfig.json:2
src/platform/packages/shared/kbn-elastic-agent-utils/jest.config.js:12
src/platform/packages/shared/kbn-elastic-agent-utils/tsconfig.json:2
src/platform/packages/shared/kbn-elastic-agent-utils/tsconfig.type_check.json:2
src/platform/packages/shared/kbn-react-hooks/jest.config.js:12
src/platform/packages/shared/kbn-react-hooks/tsconfig.json:2
src/platform/packages/shared/kbn-react-hooks/tsconfig.type_check.json:2
src/platform/packages/shared/kbn-router-utils/jest.config.js:12
src/platform/packages/shared/kbn-router-utils/tsconfig.json:2
src/platform/packages/shared/kbn-router-utils/tsconfig.type_check.json:2
src/platform/packages/shared/kbn-timerange/jest.config.js:12
src/platform/packages/shared/kbn-timerange/tsconfig.json:2
src/platform/packages/shared/kbn-timerange/tsconfig.type_check.json:2
x-pack/platform/plugins/shared/fields_metadata/jest.config.js:10
x-pack/platform/plugins/shared/fields_metadata/tsconfig.json:2
x-pack/platform/plugins/shared/fields_metadata/tsconfig.json:7
x-pack/platform/plugins/shared/fields_metadata/tsconfig.type_check.json:2
x-pack/platform/plugins/shared/fields_metadata/tsconfig.type_check.json:20
x-pack/platform/plugins/shared/fields_metadata/tsconfig.type_check.json:23
x-pack/platform/plugins/shared/fields_metadata/tsconfig.type_check.json:26
x-pack/platform/plugins/shared/fields_metadata/tsconfig.type_check.json:29
x-pack/platform/plugins/shared/fields_metadata/tsconfig.type_check.json:32
x-pack/platform/plugins/shared/fields_metadata/tsconfig.type_check.json:35
x-pack/platform/plugins/shared/fields_metadata/tsconfig.type_check.json:9
x-pack/solutions/observability/packages/kbn-custom-integrations/jest.config.js:12
x-pack/solutions/observability/packages/kbn-custom-integrations/tsconfig.json:2
x-pack/solutions/observability/packages/kbn-custom-integrations/tsconfig.type_check.json:2
x-pack/solutions/observability/packages/kbn-custom-integrations/tsconfig.type_check.json:27
x-pack/solutions/observability/packages/kbn-custom-integrations/tsconfig.type_check.json:30
x-pack/solutions/observability/packages/kbn-xstate-utils/jest.config.js:12
x-pack/solutions/observability/packages/kbn-xstate-utils/tsconfig.json:2
x-pack/solutions/observability/packages/kbn-xstate-utils/tsconfig.type_check.json:2
x-pack/solutions/observability/packages/logs_overview/jest.config.js:10
x-pack/solutions/observability/packages/logs_overview/tsconfig.json:2
x-pack/solutions/observability/plugins/data_quality/jest.config.js:10
x-pack/solutions/observability/plugins/data_quality/tsconfig.json:11
x-pack/solutions/observability/plugins/data_quality/tsconfig.json:2
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:13
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:2
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:20
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:26
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:29
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:32
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:35
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:38
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:41
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:44
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:47
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:50
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:53
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:59
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:62
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:65
x-pack/solutions/observability/plugins/data_quality/tsconfig.type_check.json:68
x-pack/solutions/observability/plugins/dataset_quality/jest.config.js:10
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.json:10
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.json:2
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:100
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:103
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:106
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:109
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:112
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:115
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:118
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:12
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:121
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:124
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:130
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:133
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:136
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:139
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:142
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:145
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:148
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:151
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:154
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:157
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:19
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:2
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:22
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:25
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:28
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:31
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:34
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:37
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:40
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:43
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:46
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:49
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:52
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:55
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:61
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:64
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:67
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:70
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:73
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:76
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:79
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:85
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:88
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:91
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:94
x-pack/solutions/observability/plugins/dataset_quality/tsconfig.type_check.json:97
x-pack/solutions/observability/plugins/infra/README.md:121
x-pack/solutions/observability/plugins/infra/README.md:29
x-pack/solutions/observability/plugins/infra/docs/telemetry/define_custom_events.md:18
x-pack/solutions/observability/plugins/infra/jest.config.js:10
x-pack/solutions/observability/plugins/infra/tsconfig.json:2
x-pack/solutions/observability/plugins/infra/tsconfig.json:7
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:101
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:104
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:107
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:110
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:113
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:116
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:119
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:122
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:125
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:128
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:131
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:134
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:137
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:140
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:143
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:146
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:149
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:152
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:155
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:158
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:161
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:164
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:167
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:170
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:173
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:182
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:185
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:188
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:191
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:194
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:2
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:20
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:200
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:203
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:209
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:212
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:215
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:218
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:221
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:227
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:23
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:230
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:236
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:239
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:242
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:245
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:248
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:251
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:254
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:257
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:26
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:260
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:263
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:266
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:269
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:272
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:275
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:278
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:281
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:284
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:287
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:29
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:290
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:293
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:296
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:299
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:305
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:308
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:311
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:314
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:32
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:35
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:38
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:41
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:44
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:47
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:50
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:53
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:56
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:62
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:65
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:68
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:71
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:74
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:77
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:80
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:83
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:86
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:89
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:9
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:92
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:95
x-pack/solutions/observability/plugins/infra/tsconfig.type_check.json:98
x-pack/solutions/observability/plugins/logs_explorer/jest.config.js:10
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.json:2
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.json:7
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:101
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:104
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:107
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:110
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:113
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:116
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:119
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:122
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:125
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:2
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:20
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:23
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:26
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:29
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:32
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:35
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:38
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:41
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:44
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:47
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:50
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:53
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:56
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:59
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:62
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:65
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:68
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:71
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:74
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:77
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:80
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:83
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:86
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:89
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:9
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:92
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:95
x-pack/solutions/observability/plugins/logs_explorer/tsconfig.type_check.json:98
x-pack/solutions/observability/plugins/observability_logs_explorer/jest.config.js:10
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.json:2
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.json:7
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:104
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:107
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:110
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:113
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:116
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:119
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:125
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:128
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:131
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:2
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:20
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:23
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:26
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:29
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:32
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:35
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:38
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:41
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:44
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:47
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:50
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:53
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:56
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:68
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:71
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:74
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:77
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:80
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:83
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:86
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:89
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:9
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:92
x-pack/solutions/observability/plugins/observability_logs_explorer/tsconfig.type_check.json:98
x-pack/solutions/observability/plugins/observability_onboarding/e2e/README.md:3
x-pack/solutions/observability/plugins/observability_onboarding/e2e/tsconfig.json:11
x-pack/solutions/observability/plugins/observability_onboarding/e2e/tsconfig.json:2
x-pack/solutions/observability/plugins/observability_onboarding/e2e/tsconfig.type_check.json:2
x-pack/solutions/observability/plugins/observability_onboarding/e2e/tsconfig.type_check.json:23
x-pack/solutions/observability/plugins/observability_onboarding/e2e/tsconfig.type_check.json:26
x-pack/solutions/observability/plugins/observability_onboarding/e2e/tsconfig.type_check.json:29
x-pack/solutions/observability/plugins/observability_onboarding/jest.config.js:12
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.json:2
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.json:9
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:102
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:105
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:108
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:111
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:114
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:2
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:21
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:24
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:27
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:33
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:36
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:39
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:42
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:45
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:48
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:51
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:54
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:60
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:63
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:66
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:69
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:72
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:75
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:78
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:81
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:84
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:87
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:9
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:90
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:93
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:96
x-pack/solutions/observability/plugins/observability_onboarding/tsconfig.type_check.json:99
```

</details>

---------

Co-authored-by: Giorgos Bamparopoulos <georgios.bamparopoulos@elastic.co>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2024-12-19 16:20:53 -06:00
..
examples [DOCS] Remove inference connector docs (#198633) 2024-11-12 11:56:37 -06:00
linters [OpenAPI] Add redocly lint configuration (#199360) 2024-11-08 14:07:55 -06:00
output [Discover] Rename Saved Search to Discover Session (#202217) 2024-12-18 13:45:32 +01:00
overlays Sustainable Kibana Architecture: Move modules owned by @elastic/obs-ux-logs-team (#202831) 2024-12-19 16:20:53 -06:00
scripts Sustainable Kibana Architecture: Move modules owned by @elastic/security-detection-engine (#202844) 2024-12-17 22:34:46 +01:00
bundle.json [Discover] Rename Saved Search to Discover Session (#202217) 2024-12-18 13:45:32 +01:00
bundle.serverless.json [OAS] Remove Elastic-Api-Version (#202923) 2024-12-05 17:05:42 +01:00
kibana.info.serverless.yaml [DOCS] Remove technical preview from serverless APIs (#201054) 2024-11-21 09:45:10 +01:00
kibana.info.yaml [OpenAPI] Fix Serverless API base URL (#202373) 2024-12-02 12:09:03 -08:00
makefile [OAS] Publish OAS bundles to bump.sh (#197482) 2024-11-14 09:15:47 +01:00
package-lock.json Update dependency @redocly/cli to ^1.26.0 (main) (#204435) 2024-12-16 22:41:31 -06:00
package.json Update dependency @redocly/cli to ^1.26.0 (main) (#204435) 2024-12-16 22:41:31 -06:00
README.md [OAS] Publish OAS bundles to bump.sh (#197482) 2024-11-14 09:15:47 +01:00

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.js script produces production an output bundle for ESS

  • merge_serverless_oas.js script produces production an output bundle for Serverless

Output Kibana OpenAPI bundles

The oas_docs/output folder contains the final resulting Kibana OpenAPI bundles

  • kibana.yaml production ready ESS OpenAPI bundle
  • kibana.serverless.yaml production 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.