This repository was archived by the owner on Dec 2, 2022. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 28
Expand file tree
/
Copy pathWebAPI.xml
More file actions
224 lines (224 loc) · 8.86 KB
/
WebAPI.xml
File metadata and controls
224 lines (224 loc) · 8.86 KB
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
<?xml version="1.0"?>
<doc>
<assembly>
<name>WebAPI</name>
</assembly>
<members>
<member name="T:WebAPI.Controllers.AnimeController">
<summary>
R Controller for Anime resource
</summary>
</member>
<member name="M:WebAPI.Controllers.AnimeController.GetOne(System.Int64)">
<summary>
Retrieves a specific Anime by id
</summary>
<param name="id">The Anime id</param>
</member>
<member name="M:WebAPI.Controllers.AnimeController.GetMore(Commons.Filters.AnimeFilter)">
<summary>
Retrieves a list of Anime
</summary>
<param name="filter">The Anime filter</param>
</member>
<member name="T:WebAPI.Controllers.AnimeSongController">
<summary>
R Controller for AnimeSong resource
</summary>
</member>
<member name="M:WebAPI.Controllers.AnimeSongController.GetOne(System.Int64)">
<summary>
Retrieves a specific AnimeSong by id
</summary>
<param name="id">The AnimeSong id</param>
</member>
<member name="M:WebAPI.Controllers.AnimeSongController.GetMore(Commons.Filters.AnimeSongFilter)">
<summary>
Retrieves a list of AnimeSong
</summary>
<param name="filter">The AnimeSong filter</param>
</member>
<member name="T:WebAPI.Controllers.AuthController">
<summary>
Controller for authentication requests
</summary>
</member>
<member name="M:WebAPI.Controllers.AuthController.Login(Commons.APICredentials)">
<summary>
Authenticate an User
</summary>
<param name="credentials">The User credentials</param>
</member>
<member name="M:WebAPI.Controllers.AuthController.VerifyEmail(System.Int64)">
<summary>
Verify an User email address
</summary>
<param name="id">The User id</param>
</member>
<member name="T:WebAPI.Controllers.EpisodeController">
<summary>
R Controller for Episode resource
</summary>
</member>
<member name="M:WebAPI.Controllers.EpisodeController.GetOne(System.Int64)">
<summary>
Retrieves a specific Episode by id
</summary>
<param name="id">The Episode id</param>
</member>
<member name="M:WebAPI.Controllers.EpisodeController.GetMore(Commons.Filters.EpisodeFilter)">
<summary>
Retrieves a list of Episode
</summary>
<param name="filter">The Episode filter</param>
</member>
<member name="T:WebAPI.Controllers.OAuthClientController">
<summary>
CRUD Controller for OAuthClient resource
</summary>
</member>
<member name="M:WebAPI.Controllers.OAuthClientController.GetOne(System.Int64)">
<summary>
Retrieves a specific OAuthClient by id
</summary>
<param name="id">The OAuthClient id</param>
</member>
<member name="M:WebAPI.Controllers.OAuthClientController.Create(Commons.OAuthClient)">
<summary>
Create a new OAuthClient
</summary>
<param name="model">The OAuthClient model</param>
</member>
<member name="M:WebAPI.Controllers.OAuthClientController.Update(Commons.OAuthClient)">
<summary>
Update an existing OAuthClient
</summary>
<param name="model">The OAuthClient model</param>
</member>
<member name="M:WebAPI.Controllers.OAuthClientController.Delete(System.Int64)">
<summary>
Delete an existing OAuthClient by id
</summary>
<param name="id">The OAuthClient id</param>
</member>
<member name="T:WebAPI.Controllers.OAuthController">
<summary>
Controller for OAuth requests
</summary>
</member>
<member name="M:WebAPI.Controllers.OAuthController.Token(System.String,System.String,System.String,System.String)">
<summary>
Exchange an OAuth code for an User token
</summary>
<param name="client_id">The OAauthClient client_id</param>
<param name="client_secret">The OAuthClient client_secret</param>
<param name="code">The generated code</param>
<param name="redirect_uri">The OAuthClient redirect_uri</param>
<returns></returns>
</member>
<member name="T:WebAPI.Controllers.RandomController">
<summary>
R Controller for random resources
</summary>
</member>
<member name="M:WebAPI.Controllers.RandomController.RandomAnime(System.Int32,System.Boolean,System.Nullable{Commons.Enums.AnimeFormatEnum})">
<summary>
Retrieves a list of random Anime
</summary>
</member>
<member name="M:WebAPI.Controllers.RandomController.RandomSong(System.Int32)">
<summary>
Retrieves a list of random Song
</summary>
</member>
<member name="T:WebAPI.Controllers.ResourcesController">
<summary>
Controller for internal resources
</summary>
</member>
<member name="M:WebAPI.Controllers.ResourcesController.GetVersion">
<summary>
Retrieves the resources version
</summary>
</member>
<member name="M:WebAPI.Controllers.ResourcesController.GetResource(Commons.Enums.ResourceTypeEnum,System.String)">
<summary>
Retrieves a resource version
</summary>
<param name="resource_type">The resource type</param>
<param name="resource_version">The resource version</param>
</member>
<member name="T:WebAPI.Controllers.UserController">
<summary>
CRUD Controller for User resource
</summary>
</member>
<member name="M:WebAPI.Controllers.UserController.GetOne(System.Int64)">
<summary>
Retrieves a specific User by user id
</summary>
<param name="id">The User id</param>
</member>
<member name="M:WebAPI.Controllers.UserController.GetMore(Commons.Filters.UserFilter)">
<summary>
Retrieves a list of User
</summary>
<param name="filter">The User filter</param>
</member>
<member name="M:WebAPI.Controllers.UserController.Create(System.String,Commons.User)">
<summary>
/// Create a new User
</summary>
<param name="g_recaptcha_response">The CAPTCHA status token</param>
<param name="model">The User model</param>
<returns></returns>
</member>
<member name="M:WebAPI.Controllers.UserController.Update(Commons.User)">
<summary>
Update an existing User
</summary>
<param name="model">The User model</param>
</member>
<member name="M:WebAPI.Controllers.UserController.Delete(System.Int64)">
<summary>
Delete an existing User by id
</summary>
<param name="id">The User id</param>
</member>
<member name="T:WebAPI.Controllers.UserStoryController">
<summary>
CRUD Controller for UserStory resources
</summary>
</member>
<member name="M:WebAPI.Controllers.UserStoryController.GetOne(System.Int64)">
<summary>
Retrieve a specific UserStory by id
</summary>
<param name="id">The UserStory id</param>
</member>
<member name="M:WebAPI.Controllers.UserStoryController.GetMore(Commons.Filters.UserStoryFilter)">
<summary>
Retrieves a list of UserStory
</summary>
<param name="filter">The UserStory filter</param>
</member>
<member name="M:WebAPI.Controllers.UserStoryController.Create(Commons.UserStory)">
<summary>
Create a new UserStory
</summary>
<param name="model">The UserStory model</param>
</member>
<member name="M:WebAPI.Controllers.UserStoryController.Update(Commons.UserStory)">
<summary>
Update an existing UserStory
</summary>
<param name="model">The UserStory model</param>
</member>
<member name="M:WebAPI.Controllers.UserStoryController.Delete(System.Int64)">
<summary>
Delete an existing UserStory by id
</summary>
<param name="id">The UserStory id</param>
</member>
</members>
</doc>