Skip to content

Commit a596b90

Browse files
docs(oas): add sort_flags to OpenAPI schema #646
1 parent 8045dcf commit a596b90

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Schemas/OpenAPISchema.inc

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,13 +336,30 @@ class OpenAPISchema extends Schema {
336336
[
337337
'in' => 'query',
338338
'name' => 'sort_order',
339-
'description' => 'Sort the response data in descending order.',
339+
'description' => 'The order to sort response data by.',
340340
'schema' => [
341341
'type' => 'string',
342342
'enum' => ['SORT_ASC', 'SORT_DESC'],
343343
'nullable' => true,
344344
],
345345
],
346+
[
347+
'in' => 'query',
348+
'name' => 'sort_flags',
349+
'description' => 'The sort flag to use to customize the behavior of the sort.',
350+
'schema' => [
351+
'type' => 'string',
352+
'nullable' => true,
353+
'enum' => [
354+
'SORT_REGULAR',
355+
'SORT_NUMERIC',
356+
'SORT_STRING',
357+
'SORT_LOCALE_STRING',
358+
'SORT_NATURAL',
359+
'SORT_FLAG_CASE'
360+
]
361+
],
362+
],
346363
[
347364
'in' => 'query',
348365
'name' => 'query',

0 commit comments

Comments
 (0)