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: update deprecations (#132)

Browse Source
This commit is contained in:
Kyrch
2026-04-17 12:18:01 -03:00
committed by GitHub
parent 8f834784fe
commit 05118aaa8a
6 changed files with 8 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/graphql/examples/filter-by-external-site/index.md
+2 -2
View File
@@ -16,7 +16,7 @@ An external resource may be linked to multiple anime.
query ($id: [Int!]) {
findAnimeByExternalSite(site: ANILIST, id: $id) {
name
mediaFormat
format
season
year
}
@@ -43,7 +43,7 @@ None
"findAnimeByExternalSite": [
{
"name": "Hibike! Euphonium 3",
"mediaFormat": "TV",
"format": "TV",
"season": "SPRING",
"year": 2024
}
docs/graphql/guide/filtering/index.md
-24
View File
@@ -31,30 +31,6 @@ query {
}
```
## Trashed Filter
Queries that return a type implementing soft deletes have a `trashed` filter.
The argument is `trashed: TrashedFilter`, which allows filtering to determine if trashed elements should be fetched.
`TrashedFilter` is an enum with the following values:
| Value | Description |
| :----------: | :------------------------------------------- |
| ONLY | Only return trashed results. |
| WITH | Return both trashed and non-trashed results. |
| WITHOUT | Only return non-trashed results. |
```graphql
query {
animePagination(trashed: ONLY) {
data {
name
}
}
}
```
## Relationship Filtering
Filtering in relationships is applied **ONLY** to the relationship and does not affect the previous root.
docs/graphql/guide/relationships/index.md
+3 -3
View File
@@ -16,9 +16,9 @@ A one-to-many relationship has a list of objects that reference the related type
And an inverse one-to-many relationship has a unique object that references the related type.
```graphql
query {
animethemePagination {
data {
query($slug: String!) {
anime(slug: $slug) {
animethemes {
sequence
animethemeentries(first: 1, version: 1) { # Inverse One-to-Many
version
docs/graphql/migrating/index.md
+3 -3
View File
@@ -18,12 +18,12 @@ Affected Fields:
* end_at -> endAt
* email_verified_at -> emailVerifiedAt
* two_factor_confirmed_at -> twoFactorConfirmedAt
* guard_name -> guardName
* media_format -> mediaFormat
* guard_name -> guardName (removed)
* media_format -> format
* external_id -> externalId
* created_at -> createdAt
* updated_at -> updatedAt
* deleted_at -> deletedAt
* deleted_at -> deletedAt (removed)
## Artists to Performances
docs/jsonapi/reference/auth/permission/index.md
-1
View File
@@ -14,6 +14,5 @@ A permission API resource represents an assignable label for users and roles tha
| :--------: | :-----: | :------: | :-----: | :------------------------------------------- |
| id | Integer | No | Yes | The primary key of the resource |
| name | String | No | Yes | The label of the resource |
| guard_name | String | No | Yes | The authentication guard of the resource |
| created_at | Date | No | No | The date that the resource was created |
| updated_at | Date | No | No | The date that the resource was last modified |
docs/jsonapi/reference/auth/role/index.md
-1
View File
@@ -14,7 +14,6 @@ A role API resource represents an assignable label for users that provides a con
| :--------: | :-----: | :------: | :-----: | :------------------------------------------------------------------------------------- |
| id | Integer | No | Yes | The primary key of the resource |
| name | String | No | Yes | The label of the resource |
| guard_name | String | No | Yes | The authentication guard of the resource |
| default | Boolean | No | Yes | Is the role assigned on account verification? |
| color | String | Yes | Yes | The hex representation of the color used to distinguish the resource |
| priority | Integer | Yes | Yes | The weight assigned to the resource, where higher values correspond to higher priority |