docs(oas): add sort_flags to OpenAPI schema #646

jaredhendrickson13 · Feb 7, 2025 · a596b90 · a596b90
1 parent 8045dcf
commit a596b90
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Schemas/OpenAPISchema.inc b/pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Schemas/OpenAPISchema.inc
@@ -336,13 +336,30 @@ class OpenAPISchema extends Schema {
                         [
                             'in' => 'query',
                             'name' => 'sort_order',
-                            'description' => 'Sort the response data in descending order.',
+                            'description' => 'The order to sort response data by.',
                             'schema' => [
                                 'type' => 'string',
                                 'enum' => ['SORT_ASC', 'SORT_DESC'],
                                 'nullable' => true,
                             ],
                         ],
+                        [
+                            'in' => 'query',
+                            'name' => 'sort_flags',
+                            'description' => 'The sort flag to use to customize the behavior of the sort.',
+                            'schema' => [
+                                'type' => 'string',
+                                'nullable' => true,
+                                'enum' => [
+                                    'SORT_REGULAR',
+                                    'SORT_NUMERIC',
+                                    'SORT_STRING',
+                                    'SORT_LOCALE_STRING',
+                                    'SORT_NATURAL',
+                                    'SORT_FLAG_CASE'
+                                ]
+                            ],
+                        ],
                         [
                             'in' => 'query',
                             'name' => 'query',