Skip to content

Commit 8bd42d0

Browse files
committed
Fix openAPI docs
1 parent 8124aa6 commit 8bd42d0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/scripts_library/list_scripts.schema.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,25 @@ paths:
1616
- name: page
1717
in: query
1818
required: false
19+
description: Page number of the results to return. Defaults to 1.
1920
schema:
2021
$ref: '../model/schema/common.schema.yaml#/components/schemas/Page'
2122
- name: pageSize
2223
in: query
2324
required: false
25+
description: Number of results to return per page. Defaults to 10. Max value is 1000.
2426
schema:
2527
$ref: '#/components/schemas/ApiPageSize'
2628
- name: sortField
2729
in: query
2830
required: false
31+
description: The field to sort the results by. Defaults to name.
2932
schema:
3033
$ref: '#/components/schemas/ApiSortField'
3134
- name: sortDirection
3235
in: query
3336
required: false
37+
description: The direction to sort the results by. Defaults to asc (ascending).
3438
schema:
3539
$ref: '../model/schema/common.schema.yaml#/components/schemas/SortDirection'
3640
- name: kuery
@@ -66,6 +70,16 @@ paths:
6670
type: array
6771
items:
6872
$ref: './common.yaml#/components/schemas/EndpointScript'
73+
examples:
74+
response:
75+
summary: List of scripts response example
76+
value:
77+
page: 1
78+
pageSize: 10
79+
total: 100
80+
sortField: name
81+
sortDirection: asc
82+
data: []
6983

7084

7185
components:

0 commit comments

Comments
 (0)