kibana/x-pack/platform/packages/shared/kbn-entities-schema/scripts/generate.js
Gerard Soldevila 609f61d1d5
[8.x] Sustainable Kibana Architecture: Move modules owned by @elastic/obs-entities (#202713) (#203402)
# Backport

This will backport the following commits from `main` to `8.x`:
- [Sustainable Kibana Architecture: Move modules owned by
`@elastic/obs-entities`
(#202713)](https://github.com/elastic/kibana/pull/202713)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Gerard
Soldevila","email":"gerard.soldevila@elastic.co"},"sourceCommit":{"committedDate":"2024-12-06T18:59:17Z","message":"Sustainable
Kibana Architecture: Move modules owned by `@elastic/obs-entities`
(#202713)\n\n## Summary\r\n\r\nThis PR aims at relocating some of the
Kibana modules (plugins and\r\npackages) into a new folder structure,
according to the _Sustainable\r\nKibana Architecture_
initiative.\r\n\r\n> [!IMPORTANT]\r\n> * We kindly ask you to:\r\n> *
Manually fix the errors in the error section below (if there
are\r\nany).\r\n> * Search for the `packages[\\/\\\\]` and
`plugins[\\/\\\\]` patterns in the\r\nsource code (Babel and Eslint
config files), and update them\r\nappropriately.\r\n> * Manually
review\r\n`.buildkite/scripts/pipelines/pull_request/pipeline.ts` to
ensure that\r\nany CI pipeline customizations continue to be correctly
applied after\r\nthe changed path names\r\n> * Review all of the updated
files, specially the `.ts` and `.js` files\r\nlisted in the sections
below, as some of them contain relative paths\r\nthat have been
updated.\r\n> * Think of potential impact of the move, including tooling
and\r\nconfiguration files that can be pointing to the relocated
modules. E.g.:\r\n> * customised eslint rules\r\n> * docs pointing to
source code\r\n\r\n> [!NOTE]\r\n> This PR has been auto-generated.\r\n>
Do not attempt to push any changes unless you know what you are
doing.\r\n> Please
use\r\n[#sustainable_kibana_architecture](https://elastic.slack.com/archives/C07TCKTA22E)\r\nSlack
channel for feedback.\r\n\r\n\r\n\r\n\r\n#### 3 plugin(s) are going to
be relocated:\r\n\r\n| Id | Target folder |\r\n| -- | -------------
|\r\n| `@kbn/entities-data-access-plugin`
|\r\n`x-pack/solutions/observability/plugins/observability_solution/entities_data_access`\r\n|\r\n|
`@kbn/entityManager-app-plugin`
|\r\n`x-pack/solutions/observability/plugins/observability_solution/entity_manager_app`\r\n|\r\n|
`@kbn/entityManager-plugin`
|\r\n`x-pack/platform/plugins/shared/entity_manager` |\r\n\r\n\r\n#### 1
package(s) are going to be relocated:\r\n\r\n | Id | Target folder |\r\n
| -- | ------------- |\r\n| `@kbn/entities-schema`
|\r\n`x-pack/platform/packages/shared/kbn-entities-schema`
|\r\n\r\n\r\n<details>\r\n<summary>Updated
references</summary>\r\n\r\n```\r\n./docs/developer/plugin-list.asciidoc\r\n./package.json\r\n./packages/kbn-repo-packages/package-map.json\r\n./packages/kbn-ts-projects/config-paths.json\r\n./tsconfig.base.json\r\n./x-pack/platform/packages/shared/kbn-entities-schema/jest.config.js\r\n./x-pack/platform/plugins/shared/entity_manager/jest.config.js\r\n./x-pack/plugins/entity_manager/docs/entity_definitions.md\r\n./x-pack/solutions/observability/plugins/observability_solution/entities_data_access/jest.config.js\r\n./x-pack/solutions/observability/plugins/observability_solution/entity_manager_app/jest.config.js\r\n./yarn.lock\r\n```\r\n</details>\r\n<details>\r\n<summary>Updated
relative
paths</summary>\r\n\r\n```\r\nx-pack/platform/packages/shared/kbn-entities-schema/jest.config.js:10\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/generate.js:8\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/generate_oas.js:65\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/generate_oas.js:8\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/serve_oas_ui.js:8\r\nx-pack/platform/packages/shared/kbn-entities-schema/tsconfig.json:2\r\nx-pack/platform/plugins/shared/entity_manager/jest.config.js:10\r\nx-pack/platform/plugins/shared/entity_manager/tsconfig.json:2\r\nx-pack/platform/plugins/shared/entity_manager/tsconfig.json:7\r\nx-pack/solutions/observability/plugins/observability_solution/entities_data_access/jest.config.js:12\r\nx-pack/solutions/observability/plugins/observability_solution/entities_data_access/tsconfig.json:2\r\nx-pack/solutions/observability/plugins/observability_solution/entity_manager_app/jest.config.js:12\r\nx-pack/solutions/observability/plugins/observability_solution/entity_manager_app/tsconfig.json:2\r\nx-pack/solutions/observability/plugins/observability_solution/entity_manager_app/tsconfig.json:7\r\n```\r\n</details>\r\n<details>\r\n<summary>Script
errors</summary>\r\n\r\n```\r\n\r\n```\r\n</details>\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Rudolf Meijering
<skaapgif@gmail.com>","sha":"df3b18214f893ef587a59a64ffe5c3dc533abc8b","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","release_note:skip","v9.0.0","backport:prev-minor","ci:project-deploy-observability","Team:obs-entities"],"number":202713,"url":"https://github.com/elastic/kibana/pull/202713","mergeCommit":{"message":"Sustainable
Kibana Architecture: Move modules owned by `@elastic/obs-entities`
(#202713)\n\n## Summary\r\n\r\nThis PR aims at relocating some of the
Kibana modules (plugins and\r\npackages) into a new folder structure,
according to the _Sustainable\r\nKibana Architecture_
initiative.\r\n\r\n> [!IMPORTANT]\r\n> * We kindly ask you to:\r\n> *
Manually fix the errors in the error section below (if there
are\r\nany).\r\n> * Search for the `packages[\\/\\\\]` and
`plugins[\\/\\\\]` patterns in the\r\nsource code (Babel and Eslint
config files), and update them\r\nappropriately.\r\n> * Manually
review\r\n`.buildkite/scripts/pipelines/pull_request/pipeline.ts` to
ensure that\r\nany CI pipeline customizations continue to be correctly
applied after\r\nthe changed path names\r\n> * Review all of the updated
files, specially the `.ts` and `.js` files\r\nlisted in the sections
below, as some of them contain relative paths\r\nthat have been
updated.\r\n> * Think of potential impact of the move, including tooling
and\r\nconfiguration files that can be pointing to the relocated
modules. E.g.:\r\n> * customised eslint rules\r\n> * docs pointing to
source code\r\n\r\n> [!NOTE]\r\n> This PR has been auto-generated.\r\n>
Do not attempt to push any changes unless you know what you are
doing.\r\n> Please
use\r\n[#sustainable_kibana_architecture](https://elastic.slack.com/archives/C07TCKTA22E)\r\nSlack
channel for feedback.\r\n\r\n\r\n\r\n\r\n#### 3 plugin(s) are going to
be relocated:\r\n\r\n| Id | Target folder |\r\n| -- | -------------
|\r\n| `@kbn/entities-data-access-plugin`
|\r\n`x-pack/solutions/observability/plugins/observability_solution/entities_data_access`\r\n|\r\n|
`@kbn/entityManager-app-plugin`
|\r\n`x-pack/solutions/observability/plugins/observability_solution/entity_manager_app`\r\n|\r\n|
`@kbn/entityManager-plugin`
|\r\n`x-pack/platform/plugins/shared/entity_manager` |\r\n\r\n\r\n#### 1
package(s) are going to be relocated:\r\n\r\n | Id | Target folder |\r\n
| -- | ------------- |\r\n| `@kbn/entities-schema`
|\r\n`x-pack/platform/packages/shared/kbn-entities-schema`
|\r\n\r\n\r\n<details>\r\n<summary>Updated
references</summary>\r\n\r\n```\r\n./docs/developer/plugin-list.asciidoc\r\n./package.json\r\n./packages/kbn-repo-packages/package-map.json\r\n./packages/kbn-ts-projects/config-paths.json\r\n./tsconfig.base.json\r\n./x-pack/platform/packages/shared/kbn-entities-schema/jest.config.js\r\n./x-pack/platform/plugins/shared/entity_manager/jest.config.js\r\n./x-pack/plugins/entity_manager/docs/entity_definitions.md\r\n./x-pack/solutions/observability/plugins/observability_solution/entities_data_access/jest.config.js\r\n./x-pack/solutions/observability/plugins/observability_solution/entity_manager_app/jest.config.js\r\n./yarn.lock\r\n```\r\n</details>\r\n<details>\r\n<summary>Updated
relative
paths</summary>\r\n\r\n```\r\nx-pack/platform/packages/shared/kbn-entities-schema/jest.config.js:10\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/generate.js:8\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/generate_oas.js:65\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/generate_oas.js:8\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/serve_oas_ui.js:8\r\nx-pack/platform/packages/shared/kbn-entities-schema/tsconfig.json:2\r\nx-pack/platform/plugins/shared/entity_manager/jest.config.js:10\r\nx-pack/platform/plugins/shared/entity_manager/tsconfig.json:2\r\nx-pack/platform/plugins/shared/entity_manager/tsconfig.json:7\r\nx-pack/solutions/observability/plugins/observability_solution/entities_data_access/jest.config.js:12\r\nx-pack/solutions/observability/plugins/observability_solution/entities_data_access/tsconfig.json:2\r\nx-pack/solutions/observability/plugins/observability_solution/entity_manager_app/jest.config.js:12\r\nx-pack/solutions/observability/plugins/observability_solution/entity_manager_app/tsconfig.json:2\r\nx-pack/solutions/observability/plugins/observability_solution/entity_manager_app/tsconfig.json:7\r\n```\r\n</details>\r\n<details>\r\n<summary>Script
errors</summary>\r\n\r\n```\r\n\r\n```\r\n</details>\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Rudolf Meijering
<skaapgif@gmail.com>","sha":"df3b18214f893ef587a59a64ffe5c3dc533abc8b"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/202713","number":202713,"mergeCommit":{"message":"Sustainable
Kibana Architecture: Move modules owned by `@elastic/obs-entities`
(#202713)\n\n## Summary\r\n\r\nThis PR aims at relocating some of the
Kibana modules (plugins and\r\npackages) into a new folder structure,
according to the _Sustainable\r\nKibana Architecture_
initiative.\r\n\r\n> [!IMPORTANT]\r\n> * We kindly ask you to:\r\n> *
Manually fix the errors in the error section below (if there
are\r\nany).\r\n> * Search for the `packages[\\/\\\\]` and
`plugins[\\/\\\\]` patterns in the\r\nsource code (Babel and Eslint
config files), and update them\r\nappropriately.\r\n> * Manually
review\r\n`.buildkite/scripts/pipelines/pull_request/pipeline.ts` to
ensure that\r\nany CI pipeline customizations continue to be correctly
applied after\r\nthe changed path names\r\n> * Review all of the updated
files, specially the `.ts` and `.js` files\r\nlisted in the sections
below, as some of them contain relative paths\r\nthat have been
updated.\r\n> * Think of potential impact of the move, including tooling
and\r\nconfiguration files that can be pointing to the relocated
modules. E.g.:\r\n> * customised eslint rules\r\n> * docs pointing to
source code\r\n\r\n> [!NOTE]\r\n> This PR has been auto-generated.\r\n>
Do not attempt to push any changes unless you know what you are
doing.\r\n> Please
use\r\n[#sustainable_kibana_architecture](https://elastic.slack.com/archives/C07TCKTA22E)\r\nSlack
channel for feedback.\r\n\r\n\r\n\r\n\r\n#### 3 plugin(s) are going to
be relocated:\r\n\r\n| Id | Target folder |\r\n| -- | -------------
|\r\n| `@kbn/entities-data-access-plugin`
|\r\n`x-pack/solutions/observability/plugins/observability_solution/entities_data_access`\r\n|\r\n|
`@kbn/entityManager-app-plugin`
|\r\n`x-pack/solutions/observability/plugins/observability_solution/entity_manager_app`\r\n|\r\n|
`@kbn/entityManager-plugin`
|\r\n`x-pack/platform/plugins/shared/entity_manager` |\r\n\r\n\r\n#### 1
package(s) are going to be relocated:\r\n\r\n | Id | Target folder |\r\n
| -- | ------------- |\r\n| `@kbn/entities-schema`
|\r\n`x-pack/platform/packages/shared/kbn-entities-schema`
|\r\n\r\n\r\n<details>\r\n<summary>Updated
references</summary>\r\n\r\n```\r\n./docs/developer/plugin-list.asciidoc\r\n./package.json\r\n./packages/kbn-repo-packages/package-map.json\r\n./packages/kbn-ts-projects/config-paths.json\r\n./tsconfig.base.json\r\n./x-pack/platform/packages/shared/kbn-entities-schema/jest.config.js\r\n./x-pack/platform/plugins/shared/entity_manager/jest.config.js\r\n./x-pack/plugins/entity_manager/docs/entity_definitions.md\r\n./x-pack/solutions/observability/plugins/observability_solution/entities_data_access/jest.config.js\r\n./x-pack/solutions/observability/plugins/observability_solution/entity_manager_app/jest.config.js\r\n./yarn.lock\r\n```\r\n</details>\r\n<details>\r\n<summary>Updated
relative
paths</summary>\r\n\r\n```\r\nx-pack/platform/packages/shared/kbn-entities-schema/jest.config.js:10\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/generate.js:8\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/generate_oas.js:65\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/generate_oas.js:8\r\nx-pack/platform/packages/shared/kbn-entities-schema/scripts/serve_oas_ui.js:8\r\nx-pack/platform/packages/shared/kbn-entities-schema/tsconfig.json:2\r\nx-pack/platform/plugins/shared/entity_manager/jest.config.js:10\r\nx-pack/platform/plugins/shared/entity_manager/tsconfig.json:2\r\nx-pack/platform/plugins/shared/entity_manager/tsconfig.json:7\r\nx-pack/solutions/observability/plugins/observability_solution/entities_data_access/jest.config.js:12\r\nx-pack/solutions/observability/plugins/observability_solution/entities_data_access/tsconfig.json:2\r\nx-pack/solutions/observability/plugins/observability_solution/entity_manager_app/jest.config.js:12\r\nx-pack/solutions/observability/plugins/observability_solution/entity_manager_app/tsconfig.json:2\r\nx-pack/solutions/observability/plugins/observability_solution/entity_manager_app/tsconfig.json:7\r\n```\r\n</details>\r\n<details>\r\n<summary>Script
errors</summary>\r\n\r\n```\r\n\r\n```\r\n</details>\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by:
Rudolf Meijering
<skaapgif@gmail.com>","sha":"df3b18214f893ef587a59a64ffe5c3dc533abc8b"}}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2024-12-09 12:25:21 -06:00

14 lines
477 B
JavaScript

/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
require('../../../../../../src/setup_node_env');
const { generateOAS } = require('./generate_oas');
const { writeFileSync } = require('fs');
const spec = generateOAS({ format: '.yaml' });
writeFileSync('oas.yaml', spec);