Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Edits from docs team #92

Merged
merged 2 commits into from
Nov 18, 2021
Merged

Edits from docs team #92

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a669dde
Update apiary.apib
madeline-brennan Nov 18, 2021
5147b19
Update apiary.apib
madeline-brennan Nov 18, 2021
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
20 changes: 10 additions & 10 deletions apiary.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1322,24 +1322,24 @@ This request retrieves a list of all users in the order that they were added.
**Sorting**

If you use the `sort` query parameter, you can only sort the list of users by 1 field.
You can add a `+` or `-` to display the list in ascending or descending order respectively.
To display the list in ascending or descending order respectively, you can add a `+` or `-`.

**Note:**

- You can only sort by 1 field.
- Query parameter can be of any length and can include order direction prefixes "+" and "-".
- Query parameter can't be empty or filled with blank spaces.
- Query parameter can accept a mix of all characters.
- A query parameter can be any length and can include the order direction prefixes "+" and "-".
- A query parameter can't be empty or include blank spaces.
- A query parameter can accept a mix of characters.
- By default, the list appears in ascending order.
- Query parameter `licenseType` sorts by two fields: `licenseType` and `licenseStatus`.
- To sort by custom field, sort value must have `customFields` followed by `.` then the `{key}`, which is the name of the custom field
- 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.

So that the behavior of sorting custom fields is consistent, the following special characters can safely be sorted: `` !@$^*()_+-=,./;'[]<>?:|~` ``
Other special characters may cause unexpected behavior when sorting.
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.

So that the `+` character encoded to `%2B` stays valid, make sure that the query parameters are encoded in accordance
So that the `+` character encoded to `%2B` stays valid, the query parameters need to be encoded in accordance
madeline-brennan marked this conversation as resolved.
Show resolved Hide resolved
with [encodeURIComponent](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent).
Alternatively, you can always leave out the `+` character as it will default to ascending order.
You can always leave out the `+` character, because the user list appears in ascending order by default.

**Pagination**

Expand Down