[Entity Store v1] Update docs to comply with OpenAPI Specification (OAS) by kubasobon · Pull Request #262526 · elastic/kibana

kubasobon · 2026-04-10T12:32:58Z

Summary

Updates Entity Store v1 API to be compliant with Kibana's OpenAPI Specification.

Towards #258982

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Review the backport guidelines and apply applicable backport:* labels.

ymao1

LGTM

uri-weisman

LGTM.
This should be backported only for 9.3/8.19, right?

natasha-moore-elastic

LGTM, just one minor suggestion, thanks!

natasha-moore-elastic · 2026-04-15T13:08:38Z

          schema:
            $ref: '../common.schema.yaml#/components/schemas/EntityType'
-          description: The entity type of the engine (either 'user' or 'host').
+          description: The entity type of the engine (user, host, service, or generic).


Suggested change

description: The entity type of the engine (user, host, service, or generic).

description: The entity type of the engine.

The possible values are listed in an enum, so we can omit them from the description.

elasticmachine · 2026-04-17T14:18:11Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: da6d4f4

Failed CI Steps

Test Failures

[job] [logs] FTR Configs #139 / Serverless Observability - Deployment-agnostic Synthetics API integration tests SyntheticsAPITests PrivateLocationCreateMonitor handles auto upgrading policies
[job] [logs] FTR Configs #139 / Serverless Observability - Deployment-agnostic Synthetics API integration tests SyntheticsAPITests PrivateLocationCreateMonitor handles auto upgrading policies

Metrics [docs]

✅ unchanged

History

💛 Build #426958 was flaky f3461bd
💔 Build #426400 failed ec826eb
💔 Build #426220 failed 8c7fdc2
💔 Build #426031 failed df71850
💔 Build #425953 failed 3178619

cc @kubasobon

kibanamachine · 2026-04-17T14:55:40Z

Starting backport for target branches: 8.19, 9.3, 9.4

https://github.com/elastic/kibana/actions/runs/24571575403

kibanamachine · 2026-04-17T15:04:18Z

💔 All backports failed

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts
❌	9.3	Backport failed because of merge conflicts
❌	9.4	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 262526

Questions ?

Please refer to the Backport tool documentation

…AS) (#262526) Updates Entity Store v1 API to be compliant with Kibana's OpenAPI Specification. Towards <#258982> Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 8a918fc)

…ion (OAS) (#262526) Source schema changes only - generated files need regeneration. (cherry picked from commit 8a918fc)

…tion (OAS) (#262526) Source schema changes only - generated files need regeneration. Only includes changes for APIs that exist on 8.19. (cherry picked from commit 8a918fc)

…ion (OAS) (#262526) (#264348) # Backport This will backport the following commits from `main` to `9.4`: - [[Entity Store v1] Update docs to comply with OpenAPI Specification (OAS) (#262526)](#262526) ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2026-04-20T15:49:35Z

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.
cc: @kubasobon

…ion (OAS) (#262526) (#264349) # Backport This will backport the following commits from `main` to `9.3`: - [[Entity Store v1] Update docs to comply with OpenAPI Specification (OAS) (#262526)](#262526) Note: OAS output files (`oas_docs/`) and error baseline still need regeneration after bootstrap. ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

…tion (OAS) (#262526) (#264350) # Backport This will backport the following commits from `main` to `8.19`: - [[Entity Store v1] Update docs to comply with OpenAPI Specification (OAS) (#262526)](#262526) Note: Only includes changes for APIs that exist on 8.19 (excludes delete_entity, upsert_entity, upsert_entities_bulk, GenericEntity, and other schemas not present on this branch). Generated files (.gen.ts, bundled yamls, OAS output) still need regeneration after bootstrap. ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

kubasobon added 2 commits April 10, 2026 14:20

docs: update Entity Store v1 API descriptions & examples

a23cddb

docs: expand acronyms and add summaries

b32323f

kubasobon self-assigned this Apr 10, 2026

kubasobon added backport:all-open Backport to all branches that could still receive a release release_note:skip Skip the PR/issue when compiling release notes labels Apr 10, 2026

kubasobon requested a review from a team April 10, 2026 14:04

kubasobon linked an issue Apr 10, 2026 that may be closed by this pull request

[OAS] Entity Store — descriptions & examples (public API + plugin routes) #258982

Closed

4 tasks

kibanamachine and others added 5 commits April 10, 2026 14:42

Changes from make api-docs

3178619

Changes from capture_oas_snapshot.sh

df71850

Merge branch 'main' into document-entity-store-v1-api

8c7fdc2

Changes from capture_oas_snapshot.sh

7bf539e

Merge branch 'main' into document-entity-store-v1-api

ec826eb

kubasobon marked this pull request as ready for review April 13, 2026 09:58

kubasobon requested review from a team as code owners April 13, 2026 09:58

kubasobon requested review from sdesalas and ymao1 April 13, 2026 09:58

ymao1 approved these changes Apr 13, 2026

View reviewed changes

kubasobon and others added 4 commits April 13, 2026 21:11

Merge branch 'main' into document-entity-store-v1-api

010619e

re-generate schema

97838f9

Changes from make api-docs

c7b1a92

Changes from capture_oas_snapshot.sh

f3461bd

elastic-vault-github-plugin-prod Bot requested a review from a team as a code owner April 13, 2026 20:36

uri-weisman approved these changes Apr 14, 2026

View reviewed changes

natasha-moore-elastic approved these changes Apr 15, 2026

View reviewed changes

alainnahalliday approved these changes Apr 15, 2026

View reviewed changes

natasha-moore-elastic reviewed Apr 15, 2026

View reviewed changes

kubasobon added 2 commits April 17, 2026 12:31

docs: fix wording

0c83f04

Merge branch 'main' into document-entity-store-v1-api

16e9946

kubasobon removed the request for review from sdesalas April 17, 2026 10:44

kubasobon enabled auto-merge (squash) April 17, 2026 10:45

kibanamachine and others added 6 commits April 17, 2026 10:57

Changes from yarn openapi:generate

c181d5f

Changes from yarn openapi:bundle

62e04e9

Changes from make api-docs

baf145f

Changes from capture_oas_snapshot.sh

acc59a7

Merge branch 'main' into document-entity-store-v1-api

73febf8

Changes from capture_oas_snapshot.sh

da6d4f4

kubasobon merged commit 8a918fc into main Apr 17, 2026
19 checks passed

kubasobon deleted the document-entity-store-v1-api branch April 17, 2026 14:55

kibanamachine added the v9.5.0 label Apr 17, 2026

This was referenced Apr 17, 2026

Fix @elastic/eui/prefer-eui-icon-tip lint violations #263526

Merged

[scout] migrate FTR logstash api tests #262953

Merged

kubasobon added a commit that referenced this pull request Apr 20, 2026

[9.3] [Entity Store v1] Update docs to comply with OpenAPI Specificat…

7088ebb

…ion (OAS) (#262526) Source schema changes only - generated files need regeneration. (cherry picked from commit 8a918fc)

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Apr 20, 2026

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Apr 20, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Entity Store v1] Update docs to comply with OpenAPI Specification (OAS)#262526

[Entity Store v1] Update docs to comply with OpenAPI Specification (OAS)#262526
kubasobon merged 19 commits intomainfrom
document-entity-store-v1-api

kubasobon commented Apr 10, 2026 •

edited by kibanamachine

Loading

Uh oh!

ymao1 left a comment

Uh oh!

uri-weisman left a comment

Uh oh!

natasha-moore-elastic left a comment

Uh oh!

natasha-moore-elastic Apr 15, 2026

Uh oh!

elasticmachine commented Apr 17, 2026 •

edited

Loading

Uh oh!

Uh oh!

kibanamachine commented Apr 17, 2026

Uh oh!

kibanamachine commented Apr 17, 2026

Uh oh!

kibanamachine commented Apr 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

	description: The entity type of the engine (user, host, service, or generic).
	description: The entity type of the engine.

Conversation

kubasobon commented Apr 10, 2026 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

ymao1 left a comment

Choose a reason for hiding this comment

Uh oh!

uri-weisman left a comment

Choose a reason for hiding this comment

Uh oh!

natasha-moore-elastic left a comment

Choose a reason for hiding this comment

Uh oh!

natasha-moore-elastic Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

History

Uh oh!

Uh oh!

kibanamachine commented Apr 17, 2026

Uh oh!

kibanamachine commented Apr 17, 2026

💔 All backports failed

Manual backport

Questions ?

Uh oh!

kibanamachine commented Apr 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

kubasobon commented Apr 10, 2026 •

edited by kibanamachine

Loading

elasticmachine commented Apr 17, 2026 •

edited

Loading