Skip to content

Commit 27d0449

Browse files
LucJosinLucJosin
committed
feat: Add new filtering to docs
1 parent 3ace4fa commit 27d0449

File tree

8 files changed

+87
-74
lines changed

8 files changed

+87
-74
lines changed

‎API/Actors.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Returns a json with the following stucture:
3636
| nationality [[!badge variant="info" text="Filter"]](#filters) | String |
3737
| seasons | List\<String\> |
3838
| awards | List\<String\> |
39-
| character | String |
39+
| character [[!badge variant="info" text="Filter"]](#filters) | String |
4040
| thumbnail | String |
4141
| images | List\<String\> |
4242
| sources | List\<String\> |
@@ -45,12 +45,13 @@ Returns a json with the following stucture:
4545

4646
## Filters
4747

48-
| Field | Example |
49-
| :---------- | :----------------------- |
50-
| first_name | `?first_name=Lorem` |
51-
| last_name | `?last_name=Ipsum` |
52-
| nicknames | `?nicknames=ipsum,lorem` |
53-
| birth_date | `?birth_date=1888-01-01` |
54-
| death_date | `?death_date=2000-12-01` |
55-
| gender | `?gender=0` |
56-
| nationality | `?nationality=American` |
48+
| Field | Example | Modification |
49+
| :---------- | :----------------------- | :----------: |
50+
| first_name | `?first_name=Lorem` | EQUALS |
51+
| last_name | `?last_name=Ipsum` | EQUALS |
52+
| nicknames | `?nicknames=ipsum,lorem` | EQUALS |
53+
| birth_date | `?birth_date=1888-01-01` | EQUALS |
54+
| death_date | `?death_date=2000-12-01` | EQUALS |
55+
| gender | `?gender=0` | EQUALS |
56+
| nationality | `?nationality=American` | EQUALS |
57+
| character | `?character=*<uuid>` | LIKE |

‎API/Characters.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Returns a json with the following stucture:
3030
| death_date [[!badge variant="info" text="Filter"]](#filters) | Date |
3131
| gender [[!badge variant="info" text="Filter"]](#filters) | Byte ([Why?](../Guides/ISO-IEC-5218.md)) |
3232
| thumbnail | String |
33-
| actor | String |
33+
| actor [[!badge variant="info" text="Filter"]](#filters) | String |
3434
| images | List\<String\> |
3535
| sources | List\<String\> |
3636
| created_at | Date |
@@ -43,11 +43,12 @@ It's possible to use `sort` and `order` too. \
4343
See [Filters](../Guides/Filters.md)
4444
!!!
4545

46-
| Field | Example |
47-
| :--------- | :----------------------- |
48-
| first_name | `?first_name=Lorem` |
49-
| last_name | `?last_name=Ipsum` |
50-
| nicknames | `?nicknames=ipsum,lorem` |
51-
| birth_date | `?birth_date=1888-01-01` |
52-
| death_date | `?death_date=2000-12-01` |
53-
| gender | `?gender=0` |
46+
| Field | Example | Modification |
47+
| :--------- | :----------------------- | :----------: |
48+
| first_name | `?first_name=Lorem` | EQUALS |
49+
| last_name | `?last_name=Ipsum` | EQUALS |
50+
| nicknames | `?nicknames=ipsum,lorem` | EQUALS |
51+
| birth_date | `?birth_date=1888-01-01` | EQUALS |
52+
| death_date | `?death_date=2000-12-01` | EQUALS |
53+
| gender | `?gender=0` | EQUALS |
54+
| actor | `?actor=*<uuid>` | LIKE |

‎API/Episodes.md

+25-22
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,22 @@ Fetches a list of episodes.
2121

2222
Returns a json with the following stucture:
2323

24-
| Field | Data Type |
25-
| :------------------------------------------------------------ | :------------- |
26-
| uuid | UUID |
27-
| href | String |
28-
| title [[!badge variant="info" text="Filter"]](#filters) | String |
29-
| description [[!badge variant="info" text="Filter"]](#filters) | String |
30-
| duration [[!badge variant="info" text="Filter"]](#filters) | Int |
31-
| episode_num [[!badge variant="info" text="Filter"]](#filters) | Int |
32-
| next_episode | String |
33-
| prev_epsisode | String |
34-
| thumbnail | String |
35-
| season | String |
36-
| images | List\<String\> |
37-
| sources | List\<String\> |
38-
| created_at | Date |
39-
| updated_at | Date |
24+
| Field | Data Type |
25+
| :-------------------------------------------------------------- | :------------- |
26+
| uuid | UUID |
27+
| href | String |
28+
| title [[!badge variant="info" text="Filter"]](#filters) | String |
29+
| description [[!badge variant="info" text="Filter"]](#filters) | String |
30+
| duration [[!badge variant="info" text="Filter"]](#filters) | Int |
31+
| episode_num [[!badge variant="info" text="Filter"]](#filters) | Int |
32+
| next_episode [[!badge variant="info" text="Filter"]](#filters) | String |
33+
| prev_epsisode [[!badge variant="info" text="Filter"]](#filters) | String |
34+
| thumbnail | String |
35+
| season [[!badge variant="info" text="Filter"]](#filters) | String |
36+
| images | List\<String\> |
37+
| sources | List\<String\> |
38+
| created_at | Date |
39+
| updated_at | Date |
4040

4141
## Filters
4242

@@ -45,9 +45,12 @@ It's possible to use `sort` and `order` too. \
4545
See [Filters](../Guides/Filters.md)
4646
!!!
4747

48-
| Field | Example |
49-
| :---------- | :------------------- |
50-
| title | `?title=Lorem` |
51-
| description | `?description=Lorem` |
52-
| duration | `?duration=1894895` |
53-
| episode_num | `?episode_num=4}` |
48+
| Field | Example | Modification |
49+
| :------------ | :----------------------- | :----------: |
50+
| title | `?title=Lorem` | EQUALS |
51+
| description | `?description=Lorem` | EQUALS |
52+
| duration | `?duration=1894895` | EQUALS |
53+
| episode_num | `?episode_num=4` | EQUALS |
54+
| next_episode | `?next_episode=*<uuid>` | LIKE |
55+
| prev_epsisode | `?prev_epsisode=*<uuid>` | LIKE |
56+
| season | `?season=*<uuid>` | LIKE |

‎API/Games.md

+18-13
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@ Returns a json with the following stucture:
2525
| :------------------------------------------------------------- | :------------- |
2626
| uuid | UUID |
2727
| href | String |
28-
| stores | List\<String\> |
29-
| modes | List\<String\> |
30-
| tags | List\<String\> |
28+
| stores [[!badge variant="info" text="Filter"]](#filters) | List\<String\> |
29+
| modes [[!badge variant="info" text="Filter"]](#filters) | List\<String\> |
30+
| tags [[!badge variant="info" text="Filter"]](#filters) | List\<String\> |
3131
| name [[!badge variant="info" text="Filter"]](#filters) | String |
3232
| genres [[!badge variant="info" text="Filter"]](#filters) | List\<String\> |
3333
| platforms [[!badge variant="info" text="Filter"]](#filters) | List\<String\> |
3434
| publishers [[!badge variant="info" text="Filter"]](#filters) | List\<String\> |
3535
| developers [[!badge variant="info" text="Filter"]](#filters) | List\<String\> |
3636
| release_date [[!badge variant="info" text="Filter"]](#filters) | Date |
3737
| website | String |
38-
| playtime | Integer |
38+
| playtime [[!badge variant="info" text="Filter"]](#filters) | Integer |
3939
| trailer | String |
40-
| age_rating | String |
40+
| age_rating [[!badge variant="info" text="Filter"]](#filters) | String |
4141
| thumbnail | String |
4242
| images | List\<String\> |
4343
| sources | List\<String\> |
@@ -51,11 +51,16 @@ It's possible to use `sort` and `order` too. \
5151
See [Filters](../Guides/Filters.md)
5252
!!!
5353

54-
| Field | Example |
55-
| :----------- | :---------------------------------- |
56-
| name | `?name=Lorem` |
57-
| genres | `?genres=genre1,genre2` |
58-
| platforms | `?platforms=platform1,platform2` |
59-
| publishers | `?publishers=publisher1,publisher2` |
60-
| developers | `?developers=developer1,developer2` |
61-
| release_date | `?release_date=2001-01-01` |
54+
| Field | Example | Modification |
55+
| :----------- | :----------------------------------- | :----------: |
56+
| name | `?name=Lorem` | EQUALS |
57+
| genres | `?genres=:genre1,genre2` | IN |
58+
| stores | `?stores=:store1,store2` | IN |
59+
| modes | `?modes=:mode1,mode2` | IN |
60+
| tags | `?tags=:tag1,tag2` | IN |
61+
| platforms | `?platforms=:platform1,platform2` | IN |
62+
| publishers | `?publishers=:publisher1,publisher2` | IN |
63+
| developers | `?developers=:developer1,developer2` | IN |
64+
| release_date | `?release_date=2001-01-01` | EQUALS |
65+
| playtime | `?playtime=>18000000` | GREATER_THAN |
66+
| age_rating | `?age_rating=16+` | EQUALS |

‎API/Locations.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ It's possible to use `sort` and `order` too. \
4040
See [Filters](../Guides/Filters.md)
4141
!!!
4242

43-
| Field | Example |
44-
| :---------- | :------------------- |
45-
| name | `?name=Lorem` |
46-
| description | `?description=Lorem` |
43+
| Field | Example | Modification |
44+
| :---------- | :------------------- | :----------: |
45+
| name | `?name=Lorem` | EQUALS |
46+
| description | `?description=Lorem` | EQUALS |

‎API/Seasons.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,14 @@ It's possible to use `sort` and `order` too. \
5050
See [Filters](../Guides/Filters.md)
5151
!!!
5252

53-
| Field | Example |
54-
| :------------- | :------------------------- |
55-
| title | `?title=Lorem` |
56-
| description | `?description=Lorem` |
57-
| duration_total | `?duration_total=254789` |
58-
| genres | `?genres=genre1,genre2` |
59-
| season_num | `?season_num=1` |
60-
| release_date | `?release_date=2015-01-01` |
53+
| Field | Example | Modification |
54+
| :------------- | :------------------------- | :----------: |
55+
| title | `?title=Lorem` | EQUALS |
56+
| description | `?description=Lorem` | EQUALS |
57+
| duration_total | `?duration_total=254789` | EQUALS |
58+
| genres | `?genres=genre1,genre2` | EQUALS |
59+
| season_num | `?season_num=1` | EQUALS |
60+
| release_date | `?release_date=2015-01-01` | EQUALS |
61+
| next_episode | `?next_episode=*<uuid>` | LIKE |
62+
| prev_epsisode | `?prev_epsisode=*<uuid>` | LIKE |
63+
| budget | `?budget=48000000` | EQUALS |

‎API/Soundtracks.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ It's possible to use `sort` and `order` too. \
4141
See [Filters](../Guides/Filters.md)
4242
!!!
4343

44-
| Field | Example |
45-
| :----------- | :------------------------- |
46-
| name | `?name=Lorem` |
47-
| duration | `?duration=245712` |
48-
| artist | `?artist=Ipsum` |
49-
| album | `?album=Lorem Ipsum` |
50-
| release_date | `?release_date=2018-01-01` |
44+
| Field | Example | Modification |
45+
| :----------- | :------------------------- | :----------: |
46+
| name | `?name=Lorem` | EQUALS |
47+
| duration | `?duration=245712` | EQUALS |
48+
| artist | `?artist=Ipsum` | EQUALS |
49+
| album | `?album=Lorem Ipsum` | EQUALS |
50+
| release_date | `?release_date=2018-01-01` | EQUALS |

‎Guides/Filters.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The request can be modified/flexible using the modificaton symbols.
5252
| IN | \* | : |
5353
| GREATER_OR_EQUALS_TO | Number, Date | >= |
5454
| LESS_OR_EQUALS_TO | Number, Date | <= |
55-
| LESS_OR_EQUALS_TO | Number, Date | > |
55+
| GREATER_THAN | Number, Date | > |
5656
| LESS_THAN | Number, Date | < |
5757
| NOT_EQUALS | \* | ! |
5858
| EQUALS | \* | |

0 commit comments

Comments
 (0)