Skip to content

Commit 4bfd36b

Browse files
LucJosinLucJosin
authored
Update v1.3.0 (#17)
Features - Add `spring-requirements` script - Add `Advanced filtering` to examples - Add new rate limits - Add example to API's - Add `data_count` to overview - Add name and status to SDK's table Changes - Update examples - Remove docs about cache invalidation *Bump version to 1.3.0* *Upgrade to yarn 4.X*
1 parent 75677f2 commit 4bfd36b

20 files changed

+374
-40
lines changed

‎.gitattributes

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/.yarn/** linguist-vendored
2+
/.yarn/releases/* binary
3+
/.yarn/plugins/**/* binary
4+
/.pnp.* binary linguist-generated

‎.gitignore

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Yarn
2-
node_modules/
2+
.pnp.*
3+
.yarn/*
4+
!.yarn/patches
5+
!.yarn/plugins
6+
!.yarn/releases
7+
!.yarn/sdks
8+
!.yarn/versions
39

410
# Build files
511

‎API/Actors.md

+48
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,51 @@ Returns a json with the following stucture:
5555
| gender | `?gender=0` | EQUALS |
5656
| nationality | `?nationality=American` | EQUALS |
5757
| character | `?character=*<uuid>` | LIKE |
58+
59+
## Example
60+
61+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors/random
62+
63+
```json
64+
{
65+
"uuid": "ffa1c1a1-7242-4967-a295-ace92d2bd32f",
66+
"href": "/api/v1/actors/ffa1c1a1-7242-4967-a295-ace92d2bd32f",
67+
"sources": [
68+
"https://www.netflix.com/tudum/stranger-things/cast",
69+
"https://en.wikipedia.org/wiki/David_Harbour"
70+
],
71+
"thumbnail": "https://s6.imgcdn.dev/xeo5T.png",
72+
"gender": 1,
73+
"nationality": "American",
74+
"seasons": [
75+
"/api/v1/seasons/3b980ad3-aef8-4663-a7a9-64cb4979500a",
76+
"/api/v1/seasons/1ff70278-fe7c-4619-9e37-91820eaa37b9",
77+
"/api/v1/seasons/b956e444-8489-4bf9-9dd0-fb6b7683638a",
78+
"/api/v1/seasons/4bae1f7c-04ff-40d7-a161-83d8608fbe1c"
79+
],
80+
"character": "/api/v1/characters/48bde91d-aa72-465d-ba6d-f8625009561d",
81+
"socials": [
82+
{
83+
"social": "Instagram",
84+
"handle": "@dkharbour",
85+
"url": "https://www.instagram.com/dkharbour/"
86+
},
87+
{
88+
"social": "Twitter",
89+
"handle": "@DavidKHarbour",
90+
"url": "https://www.twitter.com/DavidKHarbour"
91+
}
92+
],
93+
"images": [
94+
"https://cdn.britannica.com/53/244253-050-579D9771/Actor-David-Harbour-2022.jpg",
95+
"https://m.media-amazon.com/images/M/MV5BZTc5ODUzMDAtZGFhZS00NmExLTlhYWYtZDY0NGI2MGMwYTIzXkEyXkFqcGdeQXVyODY0MzQyODc@._V1_.jpg",
96+
"https://static.wikia.nocookie.net/marvelcinematicuniverse/images/7/7b/David_Harbour.jpg",
97+
"https://media.gq-magazine.co.uk/photos/62c2aac01e96714691fd64ed/master/w_1600%2Cc_limit/July%252004%2520-%2520David%2520Harbour_Online5.jpg"
98+
],
99+
"created_at": "2023-07-27T11:48:58.78",
100+
"updated_at": "2023-07-27T11:48:58.78",
101+
"first_name": "David",
102+
"last_name": "Harbour",
103+
"birth_date": "1975-04-10"
104+
}
105+
```

‎API/Characters.md

+26
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,29 @@ See [Filters](../Guides/Filters.md)
5252
| death_date | `?death_date=2000-12-01` | EQUALS |
5353
| gender | `?gender=0` | EQUALS |
5454
| actor | `?actor=*<uuid>` | LIKE |
55+
56+
## Example
57+
58+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/characters/random
59+
60+
```json
61+
{
62+
"uuid": "ef69d278-76be-478e-a087-c81071cb83c3",
63+
"href": "/api/v1/characters/ef69d278-76be-478e-a087-c81071cb83c3",
64+
"sources": ["https://strangerthings.fandom.com/wiki/Mike_Wheeler"],
65+
"thumbnail": "https://s6.imgcdn.dev/xm7Sq.jpg",
66+
"gender": 1,
67+
"actor": "/api/v1/actorss/52b8e340-aa3b-4899-af56-4bd727512cbd",
68+
"images": [
69+
"https://static.wikia.nocookie.net/strangerthings8338/images/1/19/Mike_S02E09.jpg",
70+
"https://upload.wikimedia.org/wikipedia/pt/e/e7/Mike-Wheeler-S3.jpg",
71+
"https://rollingstone.uol.com.br/media/uploads/2023/02/stranger-things-mike-morre-5-temporada-foto-reproducao-netflix.jpg",
72+
"https://hips.hearstapps.com/hmg-prod/images/stranger-things-finn-wolfhard-1654185204.jpg"
73+
],
74+
"created_at": "2023-08-11T19:27:25.287548",
75+
"updated_at": "2023-08-11T19:27:25.287548",
76+
"first_name": "Mike",
77+
"last_name": "Wheeler",
78+
"birth_date": "1971-04-07"
79+
}
80+
```

‎API/Episodes.md

+23
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,26 @@ See [Filters](../Guides/Filters.md)
5454
| next_episode | `?next_episode=*<uuid>` | LIKE |
5555
| prev_epsisode | `?prev_epsisode=*<uuid>` | LIKE |
5656
| season | `?season=*<uuid>` | LIKE |
57+
58+
## Example
59+
60+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/episodes/random
61+
62+
```json
63+
{
64+
"uuid": "a07af8a9-0873-4f6c-9cfa-8eafc8705fb2",
65+
"href": "/api/v1/episodes/a07af8a9-0873-4f6c-9cfa-8eafc8705fb2",
66+
"sources": ["https://www.netflix.com/title/80057281"],
67+
"thumbnail": "https://s6.imgcdn.dev/xWXri.jpg",
68+
"title": "The Bite",
69+
"description": "With time running out -- and an assassin close behind -- Hopper's crew races back to Hawkins, where El and the kids are preparing for war.",
70+
"language": "en-US",
71+
"duration": 3360000,
72+
"season": "/api/v1/seasons/b956e444-8489-4bf9-9dd0-fb6b7683638a",
73+
"created_at": "2023-07-24T12:33:55.767",
74+
"updated_at": "2023-07-24T12:33:55.767",
75+
"episode_num": 7,
76+
"next_episode": "/api/v1/episodes/a4ed46c8-47b7-40fc-b1d9-cacc629e93da",
77+
"prev_episode": "/api/v1/episodes/a07af8a9-0873-4f6c-9cfa-8eafc8705fb2"
78+
}
79+
```

‎API/Games.md

+50
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,53 @@ See [Filters](../Guides/Filters.md)
6464
| release_date | `?release_date=2001-01-01` | EQUALS |
6565
| playtime | `?playtime=>18000000` | GREATER_THAN |
6666
| age_rating | `?age_rating=16+` | EQUALS |
67+
68+
## Example
69+
70+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/games/random
71+
72+
```json
73+
{
74+
"uuid": "00c0d5d4-4ba6-4f63-9062-8c1c4cb37f88",
75+
"href": "/api/v1/games/00c0d5d4-4ba6-4f63-9062-8c1c4cb37f88",
76+
"sources": [
77+
"https://www.igdb.com/games/stranger-things-the-game",
78+
"https://rawg.io/games/stranger-things-the-game"
79+
],
80+
"thumbnail": "https://s6.imgcdn.dev/x3vyN.jpg",
81+
"name": "Stranger Things: The Game",
82+
"description": "Join Hopper and the kids for bruising missions around Hawkins - and the Upside Down - in this stylized retro adventure filled with collectibles. It's 1984 all over again. Experience an action adventure game just like the ones our heroes would have played back in the day. Explore Hawkins and its surroundings. See your favorite locations like Mirkwood Forest and Hawkins Lab. Uncover exciting areas you've never seen before! Solve puzzles with the unique abilities of each character. Lucas can nail anything with his Wrist Rocket. Nancy has an entire collection of bats to swing this time. Collect all the Eggos and gnomes you can lay your hands on. You never know what they might unlock.",
83+
"language": "en-US",
84+
"platforms": ["Android", "iOS"],
85+
"stores": [
86+
"https://play.google.com/store/apps/details?id=com.netflix.NGP.StrangerThings",
87+
"https://apps.apple.com/us/app/stranger-things-1984/id1574739824"
88+
],
89+
"modes": ["Single Player"],
90+
"genres": ["Adventure", "Role-Playing (RPG)"],
91+
"publishers": ["BonusXP", "Netflix"],
92+
"developers": ["BonusXP"],
93+
"website": "https://bonusxp.com/games/stranger-things-the-game/",
94+
"tags": [
95+
"Pixel Graphics",
96+
"Retro",
97+
"Dungeons",
98+
"RPG-Adventure",
99+
"Sci-Fi",
100+
"Side-Quests"
101+
],
102+
"trailer": "https://www.youtube.com/watch?v=OthEKbkPftk",
103+
"images": [
104+
"https://cdn.mobilesyrup.com/wp-content/uploads/2017/10/stranger-things-the-game-3.jpg",
105+
"https://cdn.mobilesyrup.com/wp-content/uploads/2017/10/stranger-things-the-game-2.jpg",
106+
"https://cdn.mobilesyrup.com/wp-content/uploads/2017/10/stranger-things-the-game-1.jpg",
107+
"https://assets1.ignimgs.com/2019/03/20/stranger-things-3-game---button-fin-1553102079523.jpg",
108+
"https://oceanofgamer.com/wp-content/uploads/2019/07/Stranger-Things-3-The-Game-Free-Download-1.jpg",
109+
"https://oceanofgamer.com/wp-content/uploads/2019/07/Stranger-Things-3-The-Game-Free-Download-2.jpg"
110+
],
111+
"created_at": "2023-07-25T20:34:31.68",
112+
"updated_at": "2023-07-25T20:34:31.68",
113+
"age_rating": "16+",
114+
"release_date": "2017-10-04"
115+
}
116+
```

‎API/Locations.md

+25
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,28 @@ See [Filters](../Guides/Filters.md)
4444
| :---------- | :------------------- | :----------: |
4545
| name | `?name=Lorem` | EQUALS |
4646
| description | `?description=Lorem` | EQUALS |
47+
48+
## Example
49+
50+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/locations/random
51+
52+
```json
53+
{
54+
"uuid": "f374c7fd-4468-458d-a219-cf71c7a1254a",
55+
"href": "/api/v1/locations/f374c7fd-4468-458d-a219-cf71c7a1254a",
56+
"sources": [
57+
"https://strangerthings.fandom.com/wiki/Mayfield_trailer",
58+
"https://strangerthings.fandom.com/wiki/Category:Locations"
59+
],
60+
"thumbnail": "https://s6.imgcdn.dev/xb20L.jpg",
61+
"name": "Mayfield trailer",
62+
"description": "The Mayfield trailer is a trailer home that Max Mayfield and her mother lived in after Max's stepfather.",
63+
"language": "en-US",
64+
"images": [
65+
"https://oddstops.com/i/2022/07/15/20220715084940-max-trailer.webp",
66+
"https://oddstops.com/i/2022/07/15/p-202207150836-trailer-park-stranger-thing.webp"
67+
],
68+
"created_at": "2023-07-26T22:26:11.324",
69+
"updated_at": "2023-07-26T22:26:11.324"
70+
}
71+
```

‎API/Overview.md

+55-13
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,58 @@ You can use the [Try it (Overview)]({{url}}/try-it/#/overview) section to test e
2121

2222
Returns a json with the following stucture:
2323

24-
| Field | Data Type |
25-
| :---------- | :------------- |
26-
| uuid | UUID |
27-
| href | String |
28-
| title | String |
29-
| description | String |
30-
| language | String |
31-
| languages | List\<String\> |
32-
| creators | List\<String\> |
33-
| thumbnail | String |
34-
| sources | List\<String\> |
35-
| created_at | Date |
36-
| updated_at | Date |
24+
| Field | Data Type |
25+
| :---------- | :---------------------- |
26+
| uuid | UUID |
27+
| href | String |
28+
| title | String |
29+
| description | String |
30+
| language | String |
31+
| languages | List\<String\> |
32+
| creators | List\<String\> |
33+
| thumbnail | String |
34+
| sources | List\<String\> |
35+
| data_count | [DataCount](#datacount) |
36+
| created_at | Date |
37+
| updated_at | Date |
38+
39+
### DataCount
40+
41+
| Field | Data Type |
42+
| :---------- | :-------- |
43+
| actors | Int |
44+
| characters | Int |
45+
| episodes | Int |
46+
| games | Int |
47+
| locations | Int |
48+
| seasons | Int |
49+
| soundtracks | Int |
50+
51+
## Example
52+
53+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/overview
54+
55+
```json
56+
{
57+
"uuid": "90edba4c-4399-4582-847c-833c597b03c1",
58+
"href": "/api/v1/overview/90edba4c-4399-4582-847c-833c597b03c1",
59+
"sources": ["https://www.netflix.com/title/80057281"],
60+
"thumbnail": "https://s6.imgcdn.dev/2rdwu.jpg",
61+
"title": "Stranger Things",
62+
"description": "When a young boy vanishes, a small town uncovers a mystery involving secret experiments, terrifying supernatural forces and one strange little girl.",
63+
"language": "en-US",
64+
"languages": ["en-US", "pt-BR"],
65+
"creators": ["Matt Duffer", "Ross Duffer"],
66+
"data_count": {
67+
"actors": "13",
68+
"characters": "13",
69+
"episodes": "34",
70+
"games": "3",
71+
"locations": "32",
72+
"seasons": "4",
73+
"soundtracks": "0"
74+
},
75+
"created_at": "2023-08-07T15:46:09.091",
76+
"updated_at": "2023-08-07T15:46:09.091"
77+
}
78+
```

‎API/Seasons.md

+44
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,47 @@ See [Filters](../Guides/Filters.md)
6161
| next_episode | `?next_episode=*<uuid>` | LIKE |
6262
| prev_epsisode | `?prev_epsisode=*<uuid>` | LIKE |
6363
| budget | `?budget=48000000` | EQUALS |
64+
65+
## Example
66+
67+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/seasons/random
68+
69+
```json
70+
{
71+
"uuid": "4bae1f7c-04ff-40d7-a161-83d8608fbe1c",
72+
"href": "/api/v1/seasons/4bae1f7c-04ff-40d7-a161-83d8608fbe1c",
73+
"sources": [
74+
"https://www.netflix.com/title/80057281",
75+
"https://www.rottentomatoes.com/tv/stranger_things",
76+
"https://in.ign.com/stranger-things/171687/news/season-4-of-stranger-things-reportedly-costed-30-million-per-episode"
77+
],
78+
"thumbnail": "https://s6.imgcdn.dev/xdU0w.jpg",
79+
"title": "Stranger Things 4",
80+
"description": "Darkness returns to Hawkins just in time for spring break, igniting fresh terror, disturbing memories — and an ominous new threat.",
81+
"language": "en-US",
82+
"genres": ["Drama", "Sci fi", "Horror", "Mystery thriller"],
83+
"episodes": [
84+
"/api/v1/episodes/88cd5665-bfb6-4176-9040-9194573eeac8",
85+
"/api/v1/episodes/3fabbaa2-d763-4e0e-83b7-bea55b28adad",
86+
"/api/v1/episodes/c19ae791-02b4-4861-85a8-94fbba1f24ba",
87+
"/api/v1/episodes/7261b8fb-d478-4d71-8787-08767d44197e",
88+
"/api/v1/episodes/07a4fe52-d9cb-476e-b981-a1a05f5ef81c",
89+
"/api/v1/episodes/ffd88734-834a-4cb4-b620-4f9fe97aea31",
90+
"/api/v1/episodes/6adf4b0e-134e-466d-9c62-763b339da1a4",
91+
"/api/v1/episodes/922abde7-eff1-4cf5-b643-37ed1aad6be5",
92+
"/api/v1/episodes/04984f61-7c04-4cec-8fc7-bc0786df8d4c"
93+
],
94+
"trailers": [
95+
"https://www.youtube.com/watch?v=a3thyAnShck",
96+
"https://www.youtube.com/watch?v=mVsJXiI60a0",
97+
"https://www.youtube.com/watch?v=sBEvEcpnG7k"
98+
],
99+
"budget": 270000000,
100+
"created_at": "2023-07-24T20:51:42.57",
101+
"updated_at": "2023-07-24T20:51:42.571",
102+
"duration_total": 46920000,
103+
"season_num": 4,
104+
"release_date": "2022-05-27",
105+
"prev_season": "/api/v1/seasons/b956e444-8489-4bf9-9dd0-fb6b7683638a"
106+
}
107+
```

‎Examples/Actor-By-Character.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,12 @@ How to request actor from specific character
1111

1212
### Equals
1313

14-
> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?character=/api/v1/characters/ef69d278-76be-478e-a087-c81071cb83c3
14+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?**character=/api/v1/characters/ef69d278-76be-478e-a087-c81071cb83c3**
1515
1616
### Like
1717

18-
> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?character=\*ef69d278-76be-478e-a087-c81071cb83c3
18+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/actors?**character=\*ef69d278-76be-478e-a087-c81071cb83c3**
19+
20+
See also:
21+
22+
[!ref icon="filter"](../Guides/Filters.md)

‎Examples/Advanced-Filtering.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
label: Advanced filtering
3+
icon: square
4+
order: 1
5+
---
6+
7+
# Advanced filtering
8+
9+
How to request all characters with **last name `like` Wheeler**, **gender `equals to` 1** and **birth date `greater or equals to` 1967-01-01**
10+
11+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/characters?**last_name=\*Wheeler&gender=1&birth_date=>=1967-01-01**
12+
13+
See also:
14+
15+
[!ref icon="filter"](../Guides/Filters.md)

‎Examples/Episodes-By-Season.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,12 @@ How to request all episodes from specific season
1111

1212
### Equals
1313

14-
[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?season=/api/v1/seasons/3b980ad3-aef8-4663-a7a9-64cb4979500a
14+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?**season=/api/v1/seasons/3b980ad3-aef8-4663-a7a9-64cb4979500a**
1515
1616
### Like
1717

18-
[!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?season=\*3b980ad3-aef8-4663-a7a9-64cb4979500a
18+
> [!badge variant="primary" text="GET"] /api/{{api_version}}/episodes?**season=\*3b980ad3-aef8-4663-a7a9-64cb4979500a**
19+
20+
See also:
21+
22+
[!ref icon="filter"](../Guides/Filters.md)

‎Guides/Caching.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
icon: database
33
---
44

5-
By default we cache the results of each request you make for **1 hour**. If you make the same request again, for example, we'll serve the cached result.
5+
<!-- By default we cache the results of each request you make for **1 hour**. If you make the same request again, for example, we'll serve the cached result. -->
66

77
The cache is shared across all users. If two users run a query with the same requests—even with different auth tokens—the cached results are still returned.
88

99
- **Example¹**: If you request such as `/api/v1/episodes?duration=>3000000` and a second request with `/api/v1/episodes?duration=>3000000`, the API will define as **equals** and will _return the cached data_.
1010
- **Example²**: If you request such as `/api/v1/episodes?episode_num=1` and a second request with `/api/v1/episodes?episode_num=2`, the API will define as **different** and will _create a cache for each one_.
1111

12-
!!!Note
12+
<!-- !!!Note
1313
The cache will be invalidated after **1 hour of inactivity**
14-
!!!
14+
!!! -->
1515

1616
You can identify if a result has been cached by checking the `ETag` header on the API response.
1717

0 commit comments

Comments
 (0)