AnimeThemes/animethemes-api-docs
1
0
Fork 0
mirror of https://github.com/AnimeThemes/animethemes-api-docs.git synced 2026-07-11 01:34:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(graphql): pagination arguments (#111)

Browse Source 
(cherry picked from commit bf69d27a98)
This commit is contained in:
Kyrch
2025-07-24 21:11:33 -03:00
committed by Maniload
parent d70bd55ace
commit f12b15c440
2 changed files with 75 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/guide/graphql/filtering/index.md
+28 -41
View File
@@ -6,16 +6,19 @@ title: Filtering
---
Most queries provide filtering arguments using the AND operator. Filtering arguments are built using `{fields}_{filter}`.
Most queries provide filtering arguments using the AND operator. Filtering arguments are built using the `{fields}_{filter}` pattern.
## All Filters
* Eq: `name` (without the filter argument)
* Like: `name_like`
* In: `id_in`
* Not in: `id_not_in`
* Greater: `id_greater`
* Lesser: `id_lesser`
| Name | Fields | Example | Description |
| :-----: | :--------------------------------------------: | :--------: | ------------------------------------- |
| Eq | String, Int, Float, Boolean, enums, DateTimeTz | name | Add an `equal` conditional to the query |
| Like | String | name_like | Add a `like` conditional to the query |
| In | Int, Float, enums | id_in | Add an `in` conditional to the query |
| Not in | Int, Float, enums | id_not_in | Add a `not in` conditional to the query |
| Greater | Int, Float, DateTimeTz | id_greater | Add a `gt` conditional to the query |
| Lesser | Int, Float, DateTimeTz | id_lesser | Add a `lt` conditional to the query |
Query example:
```graphql
@@ -28,45 +31,29 @@ query {
}
```
## Available Filters for the fields
## Trashed Filter
### String Fields
The queries that return a type that implements soft-deletes have a `trashed` filter.
* Eq
* Like
The argument is: `trashed: Trashed`, which allows to filter if trashed elements should be fetched.
### Int Fields
`Trashed` is an enum with the following values:
* Eq
* In
* Not in
* Greater
* Lesser
### Float Fields
* Eq
* In
* Not in
* Lesser
* Greater
### Boolean Fields
* Eq
### Enum Fields
* Eq
* In
* Not in
### DateTimeTz Fields
* Eq
* Greater
* Lesser
| Value | Description |
| :----------: | :------------------------------------------- |
| ONLY | Only return trashed results. |
| WITH | Return both trashed and non-trashed results. |
| WITHOUT | Only return non-trashed results. |
```graphql
query {
animes(trashed: ONLY) {
data {
name
}
}
}
```
## Nested Filtering
docs/guide/graphql/pagination/index.md
+47 -10
View File
@@ -8,23 +8,60 @@ title: Pagination
The AnimeThemes API query that uses pagination shall contain a `paginatorInfo` object for pagination strategies and a `data` collection with the resources.
## Arguments
There are two arguments available for every query that uses pagination.
| Name | Type | Default | Max | Description |
| :-------: | :------: | :------: | :------: | ----------------------------------------- |
| first | Int! | 15 | 100 | Limits number of fetched items |
| page | Int | 1 | lastPage | The offset from which items are returned |
## Query
The following query
```graphql
query {
animes(first: 15, page: 1) {
paginatorInfo {
count
currentPage
firstItem
hasMorePages
lastItem
lastPage
perPage
total
}
data {
name
}
}
}
```
will return a JSON like:
```json
// The animes query contains a paginatorInfo object
{
"data": {
"animes": {
"paginatorInfo": {
"count": count,
"currentPage": currentPage,
"firstItem": firstItem,
"hasMorePages": hasMorePages,
"lastItem": lastItem,
"lastPage": lastPage,
"perPage": perPage,
"total": total
"count": 2,
"currentPage": 1,
"firstItem": 1,
"hasMorePages": true,
"lastItem": 2,
"lastPage": 2317,
"perPage": 2,
"total": 4633
},
"data": [
...
{
"name": ".hack//Liminality"
},
{
"name": ".hack//roots"
}
]
}
}