Fix OAS validation errors in entity analytics privilege monitoring APIs && Risk Score APIs by CAWilson94 · Pull Request #265470 · elastic/kibana

CAWilson94 · 2026-04-24T08:24:52Z

Summary

Adds missing examples and description fields to the privilege monitoring OpenAPI schemas to resolve 7 OAS validation errors (down to 0 for api/entity_analytics on both traditional and serverless).

Changes

engine/init — added example for 500 response
engine/schedule_now — added example for 409 conflict response
monitoring/privileges — fixed example: → examples: (wrong key) on 200 response
users/_csv — added examples for multipart/form-data request body and 200 response
users/{id} delete + update — added description to the id path parameter

Also regenerates the bundled ESS and serverless schemas and updates oas_docs/output/kibana.yaml / kibana.serverless.yaml.

Testing and Validation:

I used the node script initially, and followed up with the 'validate-oas' skill in cursor, which then gave me some extra steps to share:

OAS (entity analytics + privileged user monitoring) Client Commands

Node: Use v22.22.0 (Kibana scripts reject other versions), e.g. nvm use 22 if you use nvm.
(Optional but CI-like) If your branch changes routes or the generated spec might be stale:
- yarn kbn bootstrap
- Regenerate captured snapshots and rebuild docs (match Buildkite’s --include-path list in .codex/skills/validate-oas/SKILL.md, and add --include-path /api/entity_analytics if you need that area in the snap):
  - node scripts/capture_oas_snapshot … (see the skill for the full list)
  - cd oas_docs && make api-docs

Scoped validate (fast pass/fail for your APIs):

node ./scripts/validate_oas_docs.js --only traditional --skip-printing-issues \
  --path /api/entity_analytics \
  --path /api/entity_analytics/privileged_user_monitoring

Using the `validate-oas` skill:

The 'Cursor/Claude, do this for me' option! But I think its good to do both 👍

- Added detailed examples for error responses in the monitoring engine initialization and scheduling endpoints, including `InitMonitoringEngineError` and `ScheduleMonitoringEngineConflict`. - Updated privilege response examples to use the `examples` field instead of `example` for consistency across the API documentation. - Included CSV upload request and response examples for bulk user operations, improving clarity on expected input and output formats. - Enhanced parameter descriptions for user deletion and update operations to specify the document ID context.

elasticmachine · 2026-04-24T08:25:27Z

Pinging @elastic/security-entity-analytics (Team:Entity Analytics)

…ponse examples - Added examples for Task Manager unavailability and error responses in `engine_cleanup_route`, `engine_configure_saved_object_route`, and `engine_schedule_now_route` schemas. - Enhanced documentation for better clarity on expected responses, including specific error messages and status codes. - Updated bundled OpenAPI schema files to reflect these changes for both ESS and serverless environments.

elasticmachine · 2026-04-24T19:26:41Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: ce75ad2

Failed CI Steps

Cloud Security Posture Cypress Tests on Serverless #1

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`securitySolution`	12.0MB	12.0MB	+41.0B

History

💚 Build #433436 succeeded aaa4b2c

cc @CAWilson94

hammad-nasir-elastic

Core changes LGTM

spong

Single Security Solution change in quickstart_client.gen.ts LGTM 👍

kibanamachine · 2026-04-24T21:21:25Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 39a77d3

Failed CI Steps

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`securitySolution`	12.0MB	12.0MB	+41.0B

cc @CAWilson94

kibanamachine · 2026-04-24T21:22:13Z

Starting backport for target branches: 9.4

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

kibanamachine · 2026-04-24T21:31:18Z

💔 All backports failed

Status	Branch	Result
❌	9.4	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 265470

Questions ?

Please refer to the Backport tool documentation

…Is && Risk Score APIs (elastic#265470)

kibanamachine · 2026-04-28T23:48:49Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 265470 locally
cc: @CAWilson94

kibanamachine · 2026-04-30T00:48:39Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 265470 locally
cc: @CAWilson94

kibanamachine · 2026-05-01T00:48:50Z

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 265470 locally
cc: @CAWilson94

CAWilson94 requested review from a team as code owners April 24, 2026 08:24

CAWilson94 requested a review from ymao1 April 24, 2026 08:24

CAWilson94 self-assigned this Apr 24, 2026

CAWilson94 added release_note:skip Skip the PR/issue when compiling release notes Team:Entity Analytics Security Entity Analytics Team backport:version Backport to applied version labels v9.4.0 labels Apr 24, 2026

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

View reviewed changes

tiansivive approved these changes Apr 24, 2026

View reviewed changes

kibanamachine added 3 commits April 24, 2026 08:54

Changes from yarn openapi:generate

a8d03ec

Changes from make api-docs

c295af4

Changes from capture_oas_snapshot.sh

aaa4b2c

elastic-vault-github-plugin-prod Bot requested a review from a team as a code owner April 24, 2026 09:49

CAWilson94 enabled auto-merge (squash) April 24, 2026 15:45

CAWilson94 and others added 3 commits April 24, 2026 16:55

Merge branch 'main' into oas-examples

7f0c3d2

Changes from capture_oas_snapshot.sh

eba8575

CAWilson94 changed the title ~~Fix OAS validation errors in entity analytics privilege monitoring APIs~~ Fix OAS validation errors in entity analytics privilege monitoring APIs && Risk Score APIs Apr 24, 2026

CAWilson94 and others added 3 commits April 24, 2026 17:42

Merge branch 'main' into oas-examples

b7bb5ee

Changes from make api-docs

fc25f9b

Changes from yarn openapi:generate

812647d

elastic-vault-github-plugin-prod Bot requested a review from a team as a code owner April 24, 2026 17:34

Changes from capture_oas_snapshot.sh

ce75ad2

CAWilson94 and others added 3 commits April 24, 2026 20:30

Merge branch 'main' into oas-examples

9a8fa46

Changes from capture_oas_snapshot.sh

b9b8aef

Merge branch 'main' into oas-examples

39a77d3

CAWilson94 removed the request for review from ymao1 April 24, 2026 20:39

hammad-nasir-elastic approved these changes Apr 24, 2026

View reviewed changes

spong approved these changes Apr 24, 2026

View reviewed changes

CAWilson94 merged commit 664b52b into elastic:main Apr 24, 2026
17 checks passed

kibanamachine added the v9.5.0 label Apr 24, 2026

rbrtj pushed a commit to walterra/kibana that referenced this pull request Apr 27, 2026

Fix OAS validation errors in entity analytics privilege monitoring AP…

3f970fb

…Is && Risk Score APIs (elastic#265470)

SoniaSanzV pushed a commit to SoniaSanzV/kibana that referenced this pull request Apr 27, 2026

Fix OAS validation errors in entity analytics privilege monitoring AP…

3e98760

…Is && Risk Score APIs (elastic#265470)

kibanamachine mentioned this pull request Apr 28, 2026

[Fleet] Fix Fleet OAS errors #265831

Merged

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

kibanamachine mentioned this pull request Apr 30, 2026

[OAS][Detection Engine] Clean up remaining errors #266228

Merged

kibanamachine mentioned this pull request May 1, 2026

[Fleet] Validate SSL certificate paths for whitespace #266365

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix OAS validation errors in entity analytics privilege monitoring APIs && Risk Score APIs #265470

Fix OAS validation errors in entity analytics privilege monitoring APIs && Risk Score APIs #265470
CAWilson94 merged 14 commits intoelastic:mainfrom
CAWilson94:oas-examples

CAWilson94 commented Apr 24, 2026 •

edited by kibanamachine

Loading

Uh oh!

elasticmachine commented Apr 24, 2026

Uh oh!

elasticmachine commented Apr 24, 2026

Uh oh!

hammad-nasir-elastic left a comment

Uh oh!

spong left a comment

Uh oh!

kibanamachine commented Apr 24, 2026

Uh oh!

Uh oh!

kibanamachine commented Apr 24, 2026

Uh oh!

kibanamachine commented Apr 24, 2026

Uh oh!

kibanamachine commented Apr 28, 2026

Uh oh!

kibanamachine commented Apr 30, 2026

Uh oh!

kibanamachine commented May 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

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

Uh oh!

Summary

Changes

Testing and Validation:

OAS (entity analytics + privileged user monitoring) Client Commands

Using the validate-oas skill:

Uh oh!

elasticmachine commented Apr 24, 2026

Uh oh!

elasticmachine commented Apr 24, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Async chunks

History

Uh oh!

hammad-nasir-elastic left a comment

Choose a reason for hiding this comment

Uh oh!

spong left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Apr 24, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Async chunks

Uh oh!

Uh oh!

kibanamachine commented Apr 24, 2026

Uh oh!

kibanamachine commented Apr 24, 2026

💔 All backports failed

Manual backport

Questions ?

Uh oh!

kibanamachine commented Apr 28, 2026

Uh oh!

kibanamachine commented Apr 30, 2026

Uh oh!

kibanamachine commented May 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

CAWilson94 commented Apr 24, 2026 •

edited by kibanamachine

Loading

Using the `validate-oas` skill: