mirror of
https://github.com/AnimeThemes/animethemes-api-docs.git
synced 2026-07-11 01:34:06 +02:00
docs(graphql): sorting documentation (#115)
This commit is contained in:
@@ -6,6 +6,60 @@ title: Sorting
|
||||
|
||||
---
|
||||
|
||||
// TODO
|
||||
Most queries provide a unique `sort` argument to manage resource sorting.
|
||||
This argument accepts a list of `{type}SortableColumns` enum cases.
|
||||
|
||||
// Note: Waiting API refactor.
|
||||
To sort in ascending order, the field name is enough.
|
||||
|
||||
To sort in descending order, append `_DESC` to the field name.
|
||||
|
||||
## Query
|
||||
|
||||
```graphql
|
||||
{
|
||||
animes(sort: NAME) { # Sorting in ascending direction.
|
||||
data {
|
||||
name
|
||||
}
|
||||
}
|
||||
|
||||
animes(sort: NAME_DESC) { # Sorting in descending direction.
|
||||
data {
|
||||
name
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Nested Sorting
|
||||
|
||||
It is possible to sort the relationships of the parent type.
|
||||
|
||||
```graphql
|
||||
{
|
||||
animes {
|
||||
data {
|
||||
resources(sort: EXTERNAL_ID) {
|
||||
nodes {
|
||||
externalId
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Multiple Sorting
|
||||
|
||||
By providing a list of enum cases, the sort will be applied in the order of the values provided by the client.
|
||||
|
||||
```graphql
|
||||
{
|
||||
animes(sort: [YEAR_DESC, SEASON]) {
|
||||
data {
|
||||
year
|
||||
season
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user