-
Notifications
You must be signed in to change notification settings - Fork 5
/
disney-api.yaml
188 lines (188 loc) · 6.37 KB
/
disney-api.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
openapi: 3.0.0
info:
version: 1.0.0
title: "Disney Characters API"
description: "An API to get information on Disney characters. The original docs can be accessed on https://disneyapi.dev/docs and additional specs are on https://github.com/ManuCastrillonM/disney-api"
contact:
url: "https://github.com/manuCastrillonM"
servers:
- url: https://api.disneyapi.dev
description: "Main server"
paths:
/character:
get:
tags:
- "Characters"
description: Searches for a character based on query parameters
operationId: GetCharacterByQueryParameters
parameters:
- name: name
in: query
schema:
type: string
- name: films
in: query
schema:
type: string
- name: allies
in: query
schema:
type: string
- name: enemies
in: query
schema:
type: string
- name: tvShows
in: query
schema:
type: string
- name: parkAttractions
in: query
schema:
type: string
- name: videoGames
in: query
schema:
type: string
- name: pageSize
in: query
description: Number of characters to fetch, used for pagination
schema:
type: integer
- name: page
description: numbering starts at 1. used for pagination
in: query
schema:
type: integer
responses:
"200":
description: Successfully returned a list of characters
content:
application/json:
schema:
type: object
properties:
count:
type: integer
data:
type: array
items:
type: object
properties:
_id:
type: integer
description: Character's ID.
films:
type: array
description: The films in which the character participates.
items:
type: string
shortFilms:
type: array
description: Short films in which the character participates.
items:
type: string
tvShows:
type: array
description: TV shows in which the character participates.
items:
type: string
videoGames:
type: array
description: Video games in which the character participates.
items:
type: string
parkAttractions:
type: array
description: Park attractions where the character is featured.
items:
type: string
allies:
type: array
description: Character's allies.
items:
type: string
enemies:
type: array
description: Character's enemies.
items:
type: string
name:
type: string
description: Character's name.
imageUrl:
type: string
description: URL with the character's image.
url:
type: string
description: API URL for the character's detail.
/characters/{id}:
get:
tags:
- "Characters"
description: Retrieves information about a single character based on its id.\
operationId: GetChracterById
parameters:
- name: id
in: path
required: true
description: The character's id
schema:
type: integer
responses:
"200":
description: Successfully returned a character
content:
application/json:
schema:
type: object
properties:
_id:
type: integer
description: Character's ID.
films:
type: array
description: The films in which the character participates.
items:
type: string
shortFilms:
type: array
description: Short films in which the character participates.
items:
type: string
tvShows:
type: array
description: TV shows in which the character participates.
items:
type: string
videoGames:
type: array
description: Video games in which the character participates.
items:
type: string
parkAttractions:
type: array
description: Park attractions where the character is featured.
items:
type: string
allies:
type: array
description: Character's allies.
items:
type: string
enemies:
type: array
description: Character's enemies.
items:
type: string
name:
type: string
description: Character's name.
imageUrl:
type: string
description: URL with the character's image.
url:
type: string
description: API URL for the character's detail.
tags:
- name: Characters