Skip to content

Commit 8045dcf

Browse files
docs: add docs for sort_flags #646
1 parent b7c69cb commit 8045dcf

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

docs/COMMON_CONTROL_PARAMETERS.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,21 @@ parameters you can use:
102102
behavior of this parameter varies based on the request method and endpoint type. Refer to the
103103
[Sorting](QUERIES_FILTERS_AND_SORTING.md#sorting) section for more information.
104104

105+
## sort_flags
106+
107+
- Type: String
108+
- Default: `SORT_REGULAR`
109+
- Choices:
110+
- `SORT_REGULAR`
111+
- `SORT_NUMERIC`
112+
- `SORT_STRING`
113+
- `SORT_NATURAL`
114+
- `SORT_FLAG_CASE`
115+
- `SORT_FLAG_LOCALE_STRING`
116+
- Description: This parameter allows you to control the sorting behavior of the objects related to the endpoint. The
117+
behavior of this parameter varies based on the request method and endpoint type. Refer to the
118+
[Sorting](QUERIES_FILTERS_AND_SORTING.md#sorting) section for more information.
119+
105120
## sort_order
106121

107122
- Type: String

docs/QUERIES_FILTERS_AND_SORTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ For advanced users, the REST API's framework allows for custom query filter clas
122122
## Sorting
123123

124124
Sorting can be used to order the data that is returned from the API based on specific criteria, as well as sorting the
125-
objects written to the pfSense configuration. Sorting is controlled by two common control parameters:
126-
[`sort_by`](COMMON_CONTROL_PARAMETERS.md#sort_by) and [`sort_order`](COMMON_CONTROL_PARAMETERS.md#sort_order).
125+
objects written to the pfSense configuration. Sorting is controlled by three common control parameters:
126+
[`sort_by`](COMMON_CONTROL_PARAMETERS.md#sort_by), [`sort_flags`](COMMON_CONTROL_PARAMETERS.md#sort_flags), and [`sort_order`](COMMON_CONTROL_PARAMETERS.md#sort_order).
127127

128128
!!! Note
129129
- Sorting is only available for model objects that allow many instances, meaning multiple objects of its type can

0 commit comments

Comments
 (0)