-
Notifications
You must be signed in to change notification settings - Fork 0
/
ApiCatalogoJogos.xml
86 lines (86 loc) · 4.54 KB
/
ApiCatalogoJogos.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
<?xml version="1.0"?>
<doc>
<assembly>
<name>ApiCatalogoJogos</name>
</assembly>
<members>
<member name="M:ApiCatalogoJogos.Controllers.V1.JogosController.Obter(System.Int32,System.Int32)">
<summary>
Buscar todos os jogos de forma paginada
</summary>
<remarks>
Não é possível retornar os jogos sem paginação
</remarks>
<param name="pagina">Indica qual página está sendo consultada. Mínimo 1</param>
<param name="quantidade">Indica a quantidade de reistros por página. Mínimo 1 e máximo 50</param>
<response code="200">Retorna a lista de jogos</response>
<response code="204">Caso não haja jogos</response>
</member>
<member name="M:ApiCatalogoJogos.Controllers.V1.JogosController.Obter(System.Guid)">
<summary>
Buscar um jogo pelo seu Id
</summary>
<param name="idJogo">Id do jogo buscado</param>
<response code="200">Retorna o jogo filtrado</response>
<response code="204">Caso não haja jogo com este id</response>
</member>
<member name="M:ApiCatalogoJogos.Controllers.V1.JogosController.InserirJogo(ApiCatalogoJogos.InputModel.JogoInputModel)">
<summary>
Inserir um jogo no catálogo
</summary>
<param name="jogoInputModel">Dados do jogo a ser inserido</param>
<response code="200">Cao o jogo seja inserido com sucesso</response>
<response code="422">Caso já exista um jogo com mesmo nome para a mesma ImageUrl</response>
</member>
<member name="M:ApiCatalogoJogos.Controllers.V1.JogosController.AtualizarJogo(System.Guid,ApiCatalogoJogos.InputModel.JogoInputModel)">
<summary>
Atualizar um jogo no catálogo
</summary>
/// <param name="idJogo">Id do jogo a ser atualizado</param>
<param name="jogoInputModel">Novos dados para atualizar o jogo indicado</param>
<response code="200">Cao o jogo seja atualizado com sucesso</response>
<response code="404">Caso não exista um jogo com este Id</response>
</member>
<member name="M:ApiCatalogoJogos.Controllers.V1.JogosController.AtualizarJogo(System.Guid,System.Double)">
<summary>
Atualizar o preço de um jogo
</summary>
/// <param name="idJogo">Id do jogo a ser atualizado</param>
<param name="preco">Novo preço do jogo</param>
<response code="200">Cao o preço seja atualizado com sucesso</response>
<response code="404">Caso não exista um jogo com este Id</response>
</member>
<member name="M:ApiCatalogoJogos.Controllers.V1.JogosController.ApagarJogo(System.Guid)">
<summary>
Excluir um jogo
</summary>
/// <param name="idJogo">Id do jogo a ser excluído</param>
<response code="200">Cao o preço seja atualizado com sucesso</response>
<response code="404">Caso não exista um jogo com este Id</response>
</member>
<member name="M:ApiCatalogoJogos.Controllers.V1.OrdersController.Obter(System.Guid)">
<summary>
Buscar um jogo pelo seu Id
</summary>
<param name="idOrder">Id do jogo buscado</param>
<response code="200">Retorna o jogo filtrado</response>
<response code="204">Caso não haja jogo com este id</response>
</member>
<member name="M:ApiCatalogoJogos.Controllers.V1.OrdersController.InserirOrder(ApiCatalogoJogos.InputModel.OrderInputModel)">
<summary>
Inserir um jogo no catálogo
</summary>
<param name="orderInputModel">Dados do jogo a ser inserido</param>
<response code="200">Cao o jogo seja inserido com sucesso</response>
<response code="422">Caso já exista um jogo com mesmo nome para a mesma ImageUrl</response>
</member>
<member name="M:ApiCatalogoJogos.Controllers.V1.OrdersController.ApagarOrder(System.Guid)">
<summary>
Excluir um jogo
</summary>
/// <param name="idOrder">Id do jogo a ser excluído</param>
<response code="200">Cao o preço seja atualizado com sucesso</response>
<response code="404">Caso não exista um jogo com este Id</response>
</member>
</members>
</doc>