-
Notifications
You must be signed in to change notification settings - Fork 62
/
ProgrammingQuotesApi.xml
166 lines (160 loc) Β· 6.18 KB
/
ProgrammingQuotesApi.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>ProgrammingQuotesApi</name>
</assembly>
<members>
<member name="M:ProgrammingQuotesApi.Controllers.AuthorsController.GetAuthors">
<summary>
Returns a list of authors
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.AuthorsController.GetCount">
<summary>
Returns total number of authors
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.AuthorsController.GetAuthorDetails(System.String)">
<summary>
Returns author details
</summary>
<param name="authorName">The name of the author from Wikipedia. For example: Edsger W. Dijkstra</param>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.QuotesController.GetAll(System.Int32)">
<summary>
Returns a list of quotes
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Get(System.String)">
<summary>
Returns a quote for a given id
</summary>
<remarks>
For example: 5a6ce86e2af929789500e7e4
</remarks>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.QuotesController.GetRandom">
<summary>
Returns a random quote
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.QuotesController.GetCount">
<summary>
Returns total number of quotes
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Create(ProgrammingQuotesApi.Models.QuoteCreate)">
<remarks>
Don't send quote id, it will be auto-generated.
</remarks>
<summary>
Create new quote
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.QuotesController.GetQuotesByAuthor(System.String)">
<summary>
Returns all quotes for a given author
</summary>
<param name="authorName">The name of the author from Wikipedia. For example: Edsger W. Dijkstra</param>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Update(ProgrammingQuotesApi.Models.Quote)">
<summary>
Replace an existing quote with a new one
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Patch(System.String,Microsoft.AspNetCore.JsonPatch.JsonPatchDocument{ProgrammingQuotesApi.Models.Quote})">
<remarks>
Sample request:
[
{
"path": "/author",
"op": "replace",
"value": "Anonymous"
}
]
You could use Id: 5a6ce86e2af929789500e7e4
</remarks>
<summary>
Update certain properties of an existing quote
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Delete(System.String)">
<summary>
Delete a quote by id
</summary>
<remarks>
For example: 5a6ce86e2af929789500e7e4
</remarks>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.Create(ProgrammingQuotesApi.Models.UserRegister)">
<summary>
Create a new user
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.Authenticate(ProgrammingQuotesApi.Models.UserAuthRequest)">
<summary>
Authenticates an existing user
</summary>
<remarks>
Sample request:
{
"username": "admin",
"password": "admin"
}
</remarks>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.GetAll">
<summary>
Returns all users
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.GetByUsername(System.String)">
<summary>
Returns a user data for a given username
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.Dashboard">
<summary>
Admin dashboard π
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.GetMyUser">
<summary>
Returns my user details π
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.Update(ProgrammingQuotesApi.Models.UserUpdate)">
<summary>
Replace my old user data with a new one π
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.Patch(Microsoft.AspNetCore.JsonPatch.JsonPatchDocument{ProgrammingQuotesApi.Models.User})">
<remarks>
Sample request:
[
{
"path": "/firstName",
"op": "replace",
"value": "Master"
}
]
</remarks>
<summary>
Update certain properties of my user π
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.Delete(System.Int32)">
<summary>
Delete a user by id π
</summary>
</member>
<member name="M:ProgrammingQuotesApi.Controllers.UsersController.addFavorite(System.String)">
<summary>
Add favorite quote π
</summary>
<remarks>
For example: "5a6ce86e2af929789500e7e4"
</remarks>
</member>
</members>
</doc>