Skip to content

[OAS] Improve spec descriptions, summaries, examples#265153

Merged
yctercero merged 26 commits intoelastic:mainfrom
yctercero:specs
Apr 24, 2026
Merged

[OAS] Improve spec descriptions, summaries, examples#265153
yctercero merged 26 commits intoelastic:mainfrom
yctercero:specs

Conversation

@yctercero
Copy link
Copy Markdown
Contributor

@yctercero yctercero commented Apr 22, 2026 •
edited by kibanamachine
Loading

Addresses #259871

Summary

This PR updates OpenAPI (OAS) documentation for HTTP APIs (api/detection_engine, api/lists, api/exception_lists): clearer descriptions, summaries, examples (request/response/params), and deprecation notes where routes are legacy or migration-related.

Scope: spec / documentation only. It does not change request or response validation schemas, route handlers, or runtime behavior—only how those routes are described in the OAS layer.

@yctercero yctercero marked this pull request as ready for review April 22, 2026 21:52
@yctercero yctercero requested review from a team as code owners April 22, 2026 21:52
@elastic elastic deleted a comment from infra-vault-gh-plugin-prod Bot Apr 22, 2026
@yctercero yctercero added release_note:skip Skip the PR/issue when compiling release notes v9.4.0 v9.5.0 backport:version Backport to applied version labels Team:Detection Engine Security Solution Detection Engine Area labels Apr 22, 2026
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Apr 22, 2026

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

@yctercero yctercero changed the title Specs [OAS] Improve spec descriptions, summaries, examples Apr 22, 2026
@elastic-vault-github-plugin-prod elastic-vault-github-plugin-prod Bot requested a review from a team as a code owner April 22, 2026 22:54
@elastic-vault-github-plugin-prod elastic-vault-github-plugin-prod Bot requested a review from a team as a code owner April 22, 2026 23:31
vitaliidm
vitaliidm approved these changes Apr 24, 2026
View reviewed changes
Comment thread ...y/packages/kbn-securitysolution-lists-common/api/patch_list_item/patch_list_item.schema.yaml
Comment thread ...ckages/kbn-securitysolution-lists-common/api/import_list_items/import_list_items.schema.yaml Outdated
@yctercero yctercero enabled auto-merge (squash) April 24, 2026 13:29
@yctercero yctercero merged commit 03d15cd into elastic:main Apr 24, 2026
17 checks passed
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Apr 24, 2026

Starting backport for target branches: 9.4

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

This was referenced Apr 24, 2026
Closed
Closed
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Apr 24, 2026

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #191 / discover/tabs7 tab data view editing ad-hoc data view can create runtime fields for the same data view in both tabs
  • [job] [logs] FTR Configs #167 / serverless observability UI - onboarding Onboarding Onboarding Firehose Quickstart Flow shows an AWS service when data is detected

Metrics [docs]

✅ unchanged

History

This was referenced Apr 24, 2026
Closed
Closed
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Apr 24, 2026

💔 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 265153

Questions ?

Please refer to the Backport tool documentation

@TinaHeiligers TinaHeiligers mentioned this pull request Apr 25, 2026
Closed
rbrtj pushed a commit to walterra/kibana that referenced this pull request Apr 27, 2026
@yctercero @kibanamachine @rbrtj
[OAS] Improve spec descriptions, summaries, examples (elastic#265153)
9a89db3 
Addresses elastic#259871

### Summary

This PR updates OpenAPI (OAS) documentation for HTTP APIs
(api/detection_engine, api/lists, api/exception_lists): clearer
descriptions, summaries, examples (request/response/params), and
deprecation notes where routes are legacy or migration-related.

Scope: spec / documentation only. It does not change request or response
validation schemas, route handlers, or runtime behavior—only how those
routes are described in the OAS layer.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
SoniaSanzV pushed a commit to SoniaSanzV/kibana that referenced this pull request Apr 27, 2026
@yctercero @kibanamachine @SoniaSanzV
[OAS] Improve spec descriptions, summaries, examples (elastic#265153)
42a1592 
Addresses elastic#259871

### Summary

This PR updates OpenAPI (OAS) documentation for HTTP APIs
(api/detection_engine, api/lists, api/exception_lists): clearer
descriptions, summaries, examples (request/response/params), and
deprecation notes where routes are legacy or migration-related.

Scope: spec / documentation only. It does not change request or response
validation schemas, route handlers, or runtime behavior—only how those
routes are described in the OAS layer.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine kibanamachine mentioned this pull request Apr 28, 2026
Merged
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Apr 28, 2026
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Apr 28, 2026

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 265153 locally
cc: @yctercero

1 similar comment
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Apr 29, 2026

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 265153 locally
cc: @yctercero

@kibanamachine kibanamachine mentioned this pull request Apr 30, 2026
Merged
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Apr 30, 2026

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 265153 locally
cc: @yctercero

@kibanamachine kibanamachine mentioned this pull request May 1, 2026
Merged
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented May 1, 2026

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 265153 locally
cc: @yctercero

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@theletterf theletterf theletterf approved these changes

@maximpn maximpn maximpn approved these changes

@TinaHeiligers TinaHeiligers TinaHeiligers approved these changes

@vitaliidm vitaliidm vitaliidm approved these changes

@alainnahalliday alainnahalliday Awaiting requested review from alainnahalliday alainnahalliday is a code owner automatically assigned from elastic/security-detection-rule-management

Assignees

No one assigned

Labels

backport missing Added to PRs automatically when the are determined to be missing a backport. backport:version Backport to applied version labels release_note:skip Skip the PR/issue when compiling release notes Team:Detection Engine Security Solution Detection Engine Area v9.4.0 v9.5.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@yctercero @elasticmachine @kibanamachine @theletterf @maximpn @TinaHeiligers @vitaliidm