Skip to content

Commit 74ae9ea

Browse files
kibanamachinekibanamachine
committed
[CI] Auto-commit changed files from 'yarn openapi:bundle'
1 parent c842f14 commit 74ae9ea

2 files changed

Lines changed: 128 additions & 36 deletions

File tree

‎packages/kbn-securitysolution-exceptions-common/docs/openapi/ess/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml‎

Lines changed: 64 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ servers:
1616
paths:
1717
'/api/detection_engine/rules/{id}/exceptions':
1818
post:
19+
description: Create exception items that apply to a single detection rule.
1920
operationId: CreateRuleExceptionListItems
2021
parameters:
2122
- description: Detection rule's identifier
@@ -73,11 +74,12 @@ paths:
7374
schema:
7475
$ref: '#/components/schemas/SiemErrorResponse'
7576
description: Internal server error response
76-
summary: Creates rule exception list items
77+
summary: Create rule exception list items
7778
tags:
7879
- Security Solution Exceptions API
7980
/api/exception_lists:
8081
delete:
82+
description: Delete an exception list using the `id` or `list_id` field.
8183
operationId: DeleteExceptionList
8284
parameters:
8385
- description: Either `id` or `list_id` must be specified
@@ -137,10 +139,11 @@ paths:
137139
schema:
138140
$ref: '#/components/schemas/SiemErrorResponse'
139141
description: Internal server error response
140-
summary: Deletes an exception list
142+
summary: Delete an exception list
141143
tags:
142144
- Security Solution Exceptions API
143145
get:
146+
description: Get the details of an exception list using the `id` or `list_id` field.
144147
operationId: ReadExceptionList
145148
parameters:
146149
- description: Either `id` or `list_id` must be specified
@@ -200,10 +203,23 @@ paths:
200203
schema:
201204
$ref: '#/components/schemas/SiemErrorResponse'
202205
description: Internal server error response
203-
summary: Retrieves an exception list using its `id` or `list_id` field
206+
summary: Get exception list details
204207
tags:
205208
- Security Solution Exceptions API
206209
post:
210+
description: >
211+
An exception list groups exception items and can be associated with
212+
detection rules. You can assign detection rules with multiple exception
213+
lists.
214+
215+
> info
216+
217+
> All exception items added to the same list are evaluated using `OR`
218+
logic. That is, if any of the items in a list evaluate to `true`, the
219+
exception prevents the rule from generating an alert. Likewise, `OR`
220+
logic is used for evaluating exceptions when more than one exception
221+
list is assigned to a rule. To use the `AND` operator, you can define
222+
multiple clauses (`entries`) in a single exception item.
207223
operationId: CreateExceptionList
208224
requestBody:
209225
content:
@@ -277,10 +293,11 @@ paths:
277293
schema:
278294
$ref: '#/components/schemas/SiemErrorResponse'
279295
description: Internal server error response
280-
summary: Creates an exception list
296+
summary: Create an exception list
281297
tags:
282298
- Security Solution Exceptions API
283299
put:
300+
description: Update an exception list using the `id` or `list_id` field.
284301
operationId: UpdateExceptionList
285302
requestBody:
286303
content:
@@ -357,11 +374,12 @@ paths:
357374
schema:
358375
$ref: '#/components/schemas/SiemErrorResponse'
359376
description: Internal server error response
360-
summary: Updates an exception list
377+
summary: Update an exception list
361378
tags:
362379
- Security Solution Exceptions API
363380
/api/exception_lists/_duplicate:
364381
post:
382+
description: Duplicate an existing exception list.
365383
operationId: DuplicateExceptionList
366384
parameters:
367385
- description: Exception list's human identifier
@@ -426,12 +444,12 @@ paths:
426444
schema:
427445
$ref: '#/components/schemas/SiemErrorResponse'
428446
description: Internal server error response
429-
summary: Duplicates an exception list
447+
summary: Duplicate an exception list
430448
tags:
431449
- Security Solution Exceptions API
432450
/api/exception_lists/_export:
433451
post:
434-
description: Exports an exception list and its associated items to an .ndjson file
452+
description: Export an exception list and its associated items to an NDJSON file.
435453
operationId: ExportExceptionList
436454
parameters:
437455
- description: Exception list's identifier
@@ -506,11 +524,12 @@ paths:
506524
schema:
507525
$ref: '#/components/schemas/SiemErrorResponse'
508526
description: Internal server error response
509-
summary: Exports an exception list
527+
summary: Export an exception list
510528
tags:
511529
- Security Solution Exceptions API
512530
/api/exception_lists/_find:
513531
get:
532+
description: Get a list of all exception lists.
514533
operationId: FindExceptionLists
515534
parameters:
516535
- description: >
@@ -626,12 +645,12 @@ paths:
626645
schema:
627646
$ref: '#/components/schemas/SiemErrorResponse'
628647
description: Internal server error response
629-
summary: Finds exception lists
648+
summary: Get exception lists
630649
tags:
631650
- Security Solution Exceptions API
632651
/api/exception_lists/_import:
633652
post:
634-
description: Imports an exception list and associated items
653+
description: Import an exception list and its associated items from an NDJSON file.
635654
operationId: ImportExceptionList
636655
parameters:
637656
- description: >
@@ -742,11 +761,12 @@ paths:
742761
schema:
743762
$ref: '#/components/schemas/SiemErrorResponse'
744763
description: Internal server error response
745-
summary: Imports an exception list
764+
summary: Import an exception list
746765
tags:
747766
- Security Solution Exceptions API
748767
/api/exception_lists/items:
749768
delete:
769+
description: Delete an exception list item using the `id` or `item_id` field.
750770
operationId: DeleteExceptionListItem
751771
parameters:
752772
- description: Either `id` or `item_id` must be specified
@@ -806,10 +826,13 @@ paths:
806826
schema:
807827
$ref: '#/components/schemas/SiemErrorResponse'
808828
description: Internal server error response
809-
summary: Deletes an exception list item
829+
summary: Delete an exception list item
810830
tags:
811831
- Security Solution Exceptions API
812832
get:
833+
description: >-
834+
Get the details of an exception list item using the `id` or `item_id`
835+
field.
813836
operationId: ReadExceptionListItem
814837
parameters:
815838
- description: Either `id` or `item_id` must be specified
@@ -869,10 +892,17 @@ paths:
869892
schema:
870893
$ref: '#/components/schemas/SiemErrorResponse'
871894
description: Internal server error response
872-
summary: Gets an exception list item
895+
summary: Get an exception list item
873896
tags:
874897
- Security Solution Exceptions API
875898
post:
899+
description: >
900+
Create an exception item and associate it with the specified exception
901+
list.
902+
903+
> info
904+
905+
> Before creating exception items, you must create an exception list.
876906
operationId: CreateExceptionListItem
877907
requestBody:
878908
content:
@@ -956,10 +986,11 @@ paths:
956986
schema:
957987
$ref: '#/components/schemas/SiemErrorResponse'
958988
description: Internal server error response
959-
summary: Creates an exception list item
989+
summary: Create an exception list item
960990
tags:
961991
- Security Solution Exceptions API
962992
put:
993+
description: Update an exception list item using the `id` or `item_id` field.
963994
operationId: UpdateExceptionListItem
964995
requestBody:
965996
content:
@@ -1047,11 +1078,12 @@ paths:
10471078
schema:
10481079
$ref: '#/components/schemas/SiemErrorResponse'
10491080
description: Internal server error response
1050-
summary: Updates an exception list item
1081+
summary: Update an exception list item
10511082
tags:
10521083
- Security Solution Exceptions API
10531084
/api/exception_lists/items/_find:
10541085
get:
1086+
description: Get a list of all exception list items in the specified list.
10551087
operationId: FindExceptionListItems
10561088
parameters:
10571089
- description: List's id
@@ -1183,11 +1215,12 @@ paths:
11831215
schema:
11841216
$ref: '#/components/schemas/SiemErrorResponse'
11851217
description: Internal server error response
1186-
summary: Finds exception list items
1218+
summary: Get exception list items
11871219
tags:
11881220
- Security Solution Exceptions API
11891221
/api/exception_lists/summary:
11901222
get:
1223+
description: Get a summary of the specified exception list.
11911224
operationId: ReadExceptionListSummary
11921225
parameters:
11931226
- description: Exception list's identifier generated upon creation
@@ -1266,11 +1299,24 @@ paths:
12661299
schema:
12671300
$ref: '#/components/schemas/SiemErrorResponse'
12681301
description: Internal server error response
1269-
summary: Retrieves an exception list summary
1302+
summary: Get an exception list summary
12701303
tags:
12711304
- Security Solution Exceptions API
12721305
/api/exceptions/shared:
12731306
post:
1307+
description: >
1308+
An exception list groups exception items and can be associated with
1309+
detection rules. A shared exception list can apply to multiple detection
1310+
rules.
1311+
1312+
> info
1313+
1314+
> All exception items added to the same list are evaluated using `OR`
1315+
logic. That is, if any of the items in a list evaluate to `true`, the
1316+
exception prevents the rule from generating an alert. Likewise, `OR`
1317+
logic is used for evaluating exceptions when more than one exception
1318+
list is assigned to a rule. To use the `AND` operator, you can define
1319+
multiple clauses (`entries`) in a single exception item.
12741320
operationId: CreateSharedExceptionList
12751321
requestBody:
12761322
content:
@@ -1325,7 +1371,7 @@ paths:
13251371
schema:
13261372
$ref: '#/components/schemas/SiemErrorResponse'
13271373
description: Internal server error response
1328-
summary: Creates a shared exception list
1374+
summary: Create a shared exception list
13291375
tags:
13301376
- Security Solution Exceptions API
13311377
components:

0 commit comments

Comments
 (0)