Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
e2bd4af
style: run prettier on changed files
jaredhendrickson13 Jan 11, 2025
21188aa
docs: add info about unavailability during updates #633
jaredhendrickson13 Jan 11, 2025
c181ed6
fix: give friendlier error messages during updates #633
jaredhendrickson13 Jan 11, 2025
eac2c03
fix: correctly set http response code for 503s during updates
jaredhendrickson13 Jan 11, 2025
abf5d1a
Merge branch 'master' into next_patch
jaredhendrickson13 Jan 19, 2025
112b8a7
chore: resolved merge conflict in composer.lock
jaredhendrickson13 Feb 7, 2025
1f12c1f
chore: increase OpenVPN local_network's maximum items to 10000 #644
jaredhendrickson13 Feb 7, 2025
cf114b7
fix: correct whitespace in IntegerField error
jaredhendrickson13 Feb 7, 2025
b7c69cb
feat: allow endpoints, models and clients to specify sort flags #646
jaredhendrickson13 Feb 7, 2025
8045dcf
docs: add docs for sort_flags #646
jaredhendrickson13 Feb 7, 2025
a596b90
docs(oas): add sort_flags to OpenAPI schema #646
jaredhendrickson13 Feb 7, 2025
621e70c
fix(endpoint): default to empty array if request body is empty
jaredhendrickson13 Feb 10, 2025
89bd428
fix(alias): correct error message for invalid network alias address
jaredhendrickson13 Feb 10, 2025
9c37bf2
fix: don't serialize routes before they exist #654
jaredhendrickson13 Feb 10, 2025
97323ed
tests: ensure we can update non-applied static routes #654
jaredhendrickson13 Feb 10, 2025
1e35c1b
style: run prettier on changed files
jaredhendrickson13 Feb 11, 2025
d8e68bc
fix: adjust what criteria is required for sorting
jaredhendrickson13 Feb 11, 2025
8f716fc
fix(graphql): ensure correct object types are set in schema #623
jaredhendrickson13 Feb 11, 2025
4d2079c
style: run prettier on changed files
jaredhendrickson13 Feb 11, 2025
05267ac
ci: sync ntp before running tests
jaredhendrickson13 Feb 11, 2025
98368a5
fix: adjust sorting defaults
jaredhendrickson13 Feb 12, 2025
4c58c82
fix: fixed sorting by multiple fields
jaredhendrickson13 Feb 12, 2025
5e282ec
style: run prettier on changed files
jaredhendrickson13 Feb 12, 2025
34cf82d
tests: add tests for sort flags #646
jaredhendrickson13 Feb 13, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,8 @@ jobs:
run: |
pfsense-vshell --host ${{ matrix.PFSENSE_VERSION }}.jaredhendrickson.com -u admin -p pfsense -c 'pfSsh.php playback enablesshd' -k
pfsense-vshell --host ${{ matrix.PFSENSE_VERSION }}.jaredhendrickson.com -u admin -p pfsense -c "mkdir /root/.ssh/ && echo $(cat ~/.ssh/id_rsa.pub) > /root/.ssh/authorized_keys" -k
pfsense-vshell --host ${{ matrix.PFSENSE_VERSION }}.jaredhendrickson.com -u admin -p pfsense -c "pkill ntpd" -k
pfsense-vshell --host ${{ matrix.PFSENSE_VERSION }}.jaredhendrickson.com -u admin -p pfsense -c "ntpdate pool.ntp.org" -k
scp -o StrictHostKeyChecking=no pfSense-pkg-RESTAPI-${{ env.BUILD_VERSION }}-${{ matrix.FREEBSD_ID }}.pkg/pfSense-pkg-RESTAPI-${{ env.BUILD_VERSION }}-${{ matrix.FREEBSD_ID }}.pkg admin@${{ matrix.PFSENSE_VERSION }}.jaredhendrickson.com:/tmp/

- name: Install pfSense-pkg-RESTAPI on pfSense
Expand Down
290 changes: 140 additions & 150 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions docs/COMMON_CONTROL_PARAMETERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,21 @@ parameters you can use:
behavior of this parameter varies based on the request method and endpoint type. Refer to the
[Sorting](QUERIES_FILTERS_AND_SORTING.md#sorting) section for more information.

## sort_flags

- Type: String
- Default: `SORT_REGULAR`
- Choices:
- `SORT_REGULAR`
- `SORT_NUMERIC`
- `SORT_STRING`
- `SORT_NATURAL`
- `SORT_FLAG_CASE`
- `SORT_FLAG_LOCALE_STRING`
- Description: This parameter allows you to control the sorting behavior of the objects related to the endpoint. The
behavior of this parameter varies based on the request method and endpoint type. Refer to the
[Sorting](QUERIES_FILTERS_AND_SORTING.md#sorting) section for more information.

## sort_order

- Type: String
Expand Down
4 changes: 2 additions & 2 deletions docs/QUERIES_FILTERS_AND_SORTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ For advanced users, the REST API's framework allows for custom query filter clas
## Sorting

Sorting can be used to order the data that is returned from the API based on specific criteria, as well as sorting the
objects written to the pfSense configuration. Sorting is controlled by two common control parameters:
[`sort_by`](COMMON_CONTROL_PARAMETERS.md#sort_by) and [`sort_order`](COMMON_CONTROL_PARAMETERS.md#sort_order).
objects written to the pfSense configuration. Sorting is controlled by three common control parameters:
[`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).

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