Skip to content

Commit

Permalink
DEV-27658 Replace null custom field value with empty string (#93)
Browse files Browse the repository at this point in the history
* docs: add description when custom field has empty values

Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com>
  • Loading branch information
mrnyax and Patrick Nyakoria committed Nov 23, 2021
1 parent 8d758a7 commit d42e303
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -1334,6 +1334,9 @@ To display the list in ascending or descending order respectively, you can add a
- The query parameter `licenseType` sorts by two fields: `licenseType` and `licenseStatus`.
- To sort by a custom field, the sort value needs to include `customFields`, `.`, and the `{key}`. The key is the name of the custom field.

When you sort by `customFields` in ascending order, empty `customFields` values will appear at the beginning of the list. If you sort
in descending order, empty values will appear at the end of the list.

To make sure that the sorting behavior for custom fields is consistent, the following special characters can be sorted: `` !@$^*()_+-=,./;'[]<>?:|~` ``
If you use any additional special characters, the sorting behavior may be inconsistent.

Expand Down

0 comments on commit d42e303

Please sign in to comment.