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): added nodes field explanation (#114)

Browse Source 
(cherry picked from commit 316aabdb2a)
This commit is contained in:
Kyrch
2025-07-26 17:35:49 -03:00
committed by Maniload
parent 522cfec744
commit 1c0fbd5233
6 changed files with 102 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/guide/examples/filter-by-external-site/index.md
+55
View File
@@ -0,0 +1,55 @@
---
title: Filter by External Site
---
# Filter by External Site
---
The AnimeThemes API provides an exclusive query for one of its most common use cases.
The `findAnimesByExternalSite` query accepts three arguments to filter animes by external resources.
An external resource may be linked to multiple animes.
## Query Example
```graphql
query ($id: Int!) {
{
findAnimesByExternalSite(site: ANILIST, id: $id) {
name
mediaFormat
season
year
}
}
}
```
## Authentication
None
## Parameters
| Name | Type | Description |
| :---: | :-----------: | :---------------------------------------------------------------- |
| site | ResourceSite! | The site enum used to filter |
| id | Int | The id of the anime in the external site |
| link | String | The URL of the external resource. Required if no `id` provided. |
## Response
```json
{
"data": {
"findAnimesByExternalSite": [
{
"name": "Hibike! Euphonium 3",
"mediaFormat": "TV",
"season": "SPRING",
"year": 2024
}
]
}
}
```
docs/guide/examples/search/index.md
+2
View File
@@ -4,6 +4,8 @@ title: Global Search
# Global Search Query
---
The global search query returns a listing of resources that match a given search term.
## Query Example
docs/guide/graphql/filtering/index.md
+9 -9
View File
@@ -12,12 +12,12 @@ Most queries provide filtering arguments using the AND operator. Filtering argum
| 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 |
| Eq | String, Int, Float, Boolean, enums, DateTimeTz | name | Add an `equal` conditim to the query |
| Like | String | name_like | Add a `like` condition to the query |
| In | Int, Float, enums | id_in | Add an `in` condition to the query |
| Not in | Int, Float, enums | id_not_in | Add a `not in` condition to the query |
| Greater | Int, Float, DateTimeTz | id_greater | Add a `greater than` condition to the query |
| Lesser | Int, Float, DateTimeTz | id_lesser | Add a `less than` condition to the query |
Query example:
@@ -33,9 +33,9 @@ query {
## Trashed Filter
The queries that return a type that implements soft-deletes have a `trashed` filter.
Queries that return a type implementing soft deletes have a `trashed` filter.
The argument is: `trashed: Trashed`, which allows to filter if trashed elements should be fetched.
The argument is `trashed: Trashed`, which allows filtering to determine if trashed elements should be fetched.
`Trashed` is an enum with the following values:
@@ -57,7 +57,7 @@ query {
## Nested Filtering
Filtering in relationships is applied **ONLY** on the relationship and it doesn't affect the previous root.
Filtering in relationships is applied **ONLY** to the relationship and does not affect the previous root.
```graphql
query {
docs/guide/graphql/pagination/index.md
+2 -2
View File
@@ -23,7 +23,7 @@ There are two arguments available for every query that uses pagination.
The following query
```graphql
query {
animes(first: 15, page: 1) {
animes(first: 2, page: 1) {
paginatorInfo {
count
currentPage
@@ -40,7 +40,7 @@ query {
}
}
```
will return a JSON like:
will return the JSON:
```json
{
"data": {
docs/guide/graphql/relationships/index.md
+32 -8
View File
@@ -6,13 +6,13 @@ title: Relationships
---
The AnimeThemes API implements relationships for most types, previously known as allowed included in the REST API.
The AnimeThemes API implements relationships for most types, previously known as "allowed includes" in the REST API.
The many-to-many, one-to-many and polymorphic one-to-many relationships apply pagination.
The many-to-many, one-to-many, and polymorphic one-to-many relationships apply pagination.
## Many-to-One (BelongsTo)
A many-to-one relationship has a object that references the foreign type.
A many-to-one relationship has an object that references the foreign type.
```graphql
query {
@@ -29,7 +29,7 @@ query {
## One-to-Many (HasMany)
An one-to-many relationship has a list of objects that reference the related type.
A one-to-many relationship has a list of objects that reference the related type.
```graphql
query {
@@ -48,9 +48,18 @@ query {
## Many-to-Many (BelongsToMany)
A many-to-many relationship has a `edges` list that contains edge objects.
Every many-to-many relationship applies connection pagination and has three top fields.
Read about it in the [graphql.org](https://graphql.org/learn/pagination/#pagination-and-edges)
and [relay.dev](https://relay.dev/graphql/connections.htm) documentations if you don't know what it is.
The edge object contains the pivot fields of the relationship and a `node` object that references the related type.
The `pageInfo` field provides pagination information.
The `nodes` field returns a list of objects that reference the related type.
Use this field if you don't care about the pivot fields of the relationship.
The `edges` field returns a list of `edge` objects.
The `edge` object always contains a `node` field that returns a singular object of the related type,
and the pivot fields of the relationship.
Both fields `createdAt` and `updatedAt` are available for every many-to-many relationship.
@@ -61,7 +70,13 @@ query {
data {
name
resources {
edges {
pageInfo { # Pagination
total
}
nodes { # Without pivot fields
link
}
edges { # With pivot fields
node {
link
}
@@ -83,6 +98,15 @@ will return the JSON:
{
"name": ".hack//Liminality",
"resources": {
"pageInfo": {
"total": 6
},
"nodes": [
{
"link": "https://myanimelist.net/anime/299"
},
...
],
"edges": [
{
"node": {
@@ -105,7 +129,7 @@ will return the JSON:
## Polymorphic Many-to-One (MorphTo)
An union type indicates that a field might have multiple object types.
A union type indicates that a field might have multiple object types.
```graphql
query {
docs/guide/graphql/ordering/index.md → docs/guide/graphql/sorting/index.md
+2 -2
View File
@@ -1,8 +1,8 @@
---
title: Ordering
title: Sorting
---
# Ordering
# Sorting
---