[DOCS] Fix OpenAPI linting error in detection_engine by lcawl · Pull Request #248570 · elastic/kibana

lcawl · 2026-01-10T02:18:54Z

Summary

This PR is an attempt to fix the following linting error that is returned when you run make api-docs-lint or npx @redocly/cli lint output/kibana.yaml --config ./linters/redocly.yaml from the oas_docs directory:

validating output/kibana.yaml...
Something went wrong when processing output/kibana.yaml:

  - examples is not iterable

Swagger editor also identified Security_Detections_API_SetAlertAssigneesBody as an object that includes not allowed fields. Per https://swagger.io/docs/specification/v3_0/adding-examples/#object-and-property-examples "Note that schemas and properties support single example but not multiple examples". Therefore, I've defined the examples separately and called them at a higher level. The same changes were also required in SetAlertTagsBody.

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
Unit or functional tests were updated or added to match the most common scenarios
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
Flaky Test Runner was used on any tests changed
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines
Review the backport guidelines and apply applicable backport:* labels.

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

See some risk examples
...

elasticmachine · 2026-01-12T16:16:14Z

Pinging @elastic/security-detection-engine (Team:Detection Engine)

lcawl · 2026-01-14T19:32:41Z

I did pick up an incorrectly migrated example under SetAlertAssigneesBodyRemove, which appears to be the same as SetAlertAssigneesBodyAdd in the changes you proposed. Looks like a minor thing that got overlooked but would be great if you can look into that while I try and figure out the other problem with the generator throwing those weird errors.

Good catch! I've fixed that cut and paste error. Thanks for tackling the pipeline issue!

maximpn · 2026-01-21T18:19:37Z

@lcawl @sdesalas

I've pushed a could of commits fixing OAS code generation in kbn-openapi-generator and related OAS linting rules. The build should pass now.

FYI, kbn-openapi-bundler used for OAS -> API documentation supports different examples paths.

elasticmachine · 2026-01-21T19:44:17Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: ca698a7

Failed CI Steps

Test Failures

[job] [logs] Serverless Investigations - Security Solution Cypress Tests #4 / Dashboard Migrations - Translated Dashboards Page should be able to reprocess a failed Dashboard should be able to reprocess a failed Dashboard

Metrics [docs]

✅ unchanged

History

sdesalas · 2026-01-22T09:52:00Z

+        if (options.skipKeys?.includes(key)) {
+          return;
+        }
+


Nice work @maximpn 👌 . Even made this extensible in case there are other future schema paths we need to ignore.

sdesalas

Hi @lcawl. All looking good on my part, happy to approve.

CI pipeline is passing (thanks @maximpn)
Visual inspection of openapi YAML structure does not flag anything strange
Testing YAML before and after in the swagger editor generate same output

I think we're good to merge. 🚀

Thank you again 🙏 for reviewing these linting issues.

kibanamachine · 2026-01-23T10:04:49Z

Starting backport for target branches: 8.19, 9.3

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

kibanamachine · 2026-01-23T10:13:30Z

💔 All backports failed

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 248570

Questions ?

Please refer to the Backport tool documentation

Co-authored-by: Maxim Palenov <maxim.palenov@elastic.co> (cherry picked from commit da6bf3e)

lcawl · 2026-01-23T19:57:38Z

💚 All backports created successfully

Status	Branch	Result
✅	9.3
✅	8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

Co-authored-by: Maxim Palenov <maxim.palenov@elastic.co> (cherry picked from commit da6bf3e)

kibanamachine · 2026-01-27T10:48:47Z

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: @lcawl

kibanamachine · 2026-01-28T11:48:49Z

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: @lcawl

…250276) # Backport This will backport the following commits from `main` to `9.3`: - [[DOCS] Fix OpenAPI linting error in detection_engine (#248570)](#248570)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Maxim Palenov <maxim.palenov@elastic.co>

…#250278) # Backport This will backport the following commits from `main` to `8.19`: - [[DOCS] Fix OpenAPI linting error in detection_engine (#248570)](#248570)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  --------- Co-authored-by: Maxim Palenov <maxim.palenov@elastic.co>

Fix OpenAPI linting error in detection_engine

f75df22

Merge branch 'main' into iterable

15d4765

lcawl marked this pull request as ready for review January 12, 2026 16:16

lcawl requested a review from a team as a code owner January 12, 2026 16:16

Changes from yarn openapi:bundle

4497d52

elastic-vault-github-plugin-prod Bot requested a review from a team as a code owner January 12, 2026 16:35

elastic-vault-github-plugin-prod Bot requested a review from sdesalas January 12, 2026 16:35

Generate bundles

a8d15ec

lcawl requested a review from a team as a code owner January 12, 2026 16:39

lcawl marked this pull request as draft January 12, 2026 16:42

Fix more example embeddings

d820fd6

lcawl force-pushed the iterable branch from 3230bde to d820fd6 Compare January 12, 2026 17:12

lcawl marked this pull request as ready for review January 12, 2026 20:02

lcawl requested review from a team as code owners January 12, 2026 20:03

lcawl requested a review from nkhristinin January 12, 2026 20:03

lcawl and others added 2 commits January 12, 2026 12:03

Merge branch 'main' into iterable

0b6659b

Changes from capture_oas_snapshot.sh

9550bdb

elastic-vault-github-plugin-prod Bot requested a review from a team as a code owner January 12, 2026 20:18

Merge branch 'main' into iterable

3600ced

Merge branch 'main' into iterable

3254527

Changes from capture_oas_snapshot.sh

35e235e

nkhristinin approved these changes Jan 21, 2026

View reviewed changes

florent-leborgne approved these changes Jan 21, 2026

View reviewed changes

maximpn added 3 commits January 21, 2026 19:15

skip example references in code generation

726a564

fix OAS linting rules

7fd5d18

Merge branch 'main' into iterable

ca698a7

Merge branch 'main' into iterable

1d398c4

lcawl enabled auto-merge (squash) January 22, 2026 00:39

Merge branch 'main' into iterable

13a5bdb

sdesalas reviewed Jan 22, 2026

View reviewed changes

sdesalas approved these changes Jan 23, 2026

View reviewed changes

lcawl merged commit da6bf3e into elastic:main Jan 23, 2026
16 checks passed

lcawl mentioned this pull request Jan 23, 2026

[9.3] [DOCS] Fix OpenAPI linting error in detection_engine (#248570) #250276

Merged

lcawl added a commit to lcawl/kibana that referenced this pull request Jan 23, 2026

[DOCS] Fix OpenAPI linting error in detection_engine (elastic#248570)

6afdb94

Co-authored-by: Maxim Palenov <maxim.palenov@elastic.co> (cherry picked from commit da6bf3e)

lcawl mentioned this pull request Jan 23, 2026

[8.19] [DOCS] Fix OpenAPI linting error in detection_engine (#248570) #250278

Merged

lcawl added a commit to lcawl/kibana that referenced this pull request Jan 23, 2026

[DOCS] Fix OpenAPI linting error in detection_engine (elastic#248570)

5c7bbd5

Co-authored-by: Maxim Palenov <maxim.palenov@elastic.co> (cherry picked from commit da6bf3e)

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

kibanamachine added v8.19.11 and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Jan 28, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Fix OpenAPI linting error in detection_engine#248570

[DOCS] Fix OpenAPI linting error in detection_engine#248570
lcawl merged 17 commits intoelastic:mainfrom
lcawl:iterable

lcawl commented Jan 10, 2026 •

edited by kibanamachine

Loading

Uh oh!

elasticmachine commented Jan 12, 2026

Uh oh!

lcawl commented Jan 14, 2026

Uh oh!

maximpn commented Jan 21, 2026

Uh oh!

elasticmachine commented Jan 21, 2026 •

edited

Loading

Uh oh!

sdesalas Jan 22, 2026 •

edited

Loading

Uh oh!

sdesalas left a comment

Uh oh!

Uh oh!

kibanamachine commented Jan 23, 2026

Uh oh!

kibanamachine commented Jan 23, 2026

Uh oh!

lcawl commented Jan 23, 2026

Uh oh!

kibanamachine commented Jan 27, 2026

Uh oh!

kibanamachine commented Jan 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Conversation

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

Uh oh!

Summary

Checklist

Identify risks

Uh oh!

elasticmachine commented Jan 12, 2026

Uh oh!

lcawl commented Jan 14, 2026

Uh oh!

maximpn commented Jan 21, 2026

Uh oh!

elasticmachine commented Jan 21, 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!

sdesalas Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sdesalas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kibanamachine commented Jan 23, 2026

Uh oh!

kibanamachine commented Jan 23, 2026

💔 All backports failed

Manual backport

Questions ?

Uh oh!

lcawl commented Jan 23, 2026

💚 All backports created successfully

Questions ?

Uh oh!

kibanamachine commented Jan 27, 2026

Uh oh!

kibanamachine commented Jan 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

lcawl commented Jan 10, 2026 •

edited by kibanamachine

Loading

elasticmachine commented Jan 21, 2026 •

edited

Loading

sdesalas Jan 22, 2026 •

edited

Loading