... | @@ -17,6 +17,66 @@ Envios para o back podem ser de três tipos, não se limitando a usar somente um |
... | @@ -17,6 +17,66 @@ Envios para o back podem ser de três tipos, não se limitando a usar somente um |
|
|
|
|
|
3. Dados do Corpo (**Payload**): dados enviados no corpo (body) da requisição
|
|
3. Dados do Corpo (**Payload**): dados enviados no corpo (body) da requisição
|
|
|
|
|
|
|
|
---
|
|
|
|
### POST /login/
|
|
|
|
|
|
|
|
#### Params:
|
|
|
|
Nenhum parâmetro esperado
|
|
|
|
|
|
|
|
#### Query string:
|
|
|
|
Nenhuma query string esperada
|
|
|
|
|
|
|
|
#### Payload:
|
|
|
|
```
|
|
|
|
{
|
|
|
|
email: "str",
|
|
|
|
password: "str",
|
|
|
|
isTeacher: 1
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
#### Responses:
|
|
|
|
- 204: NO_CONTENT
|
|
|
|
|
|
|
|
- 400:
|
|
|
|
```
|
|
|
|
{
|
|
|
|
status: 400,
|
|
|
|
msg: "Bad request",
|
|
|
|
errors: [
|
|
|
|
{
|
|
|
|
value: "joao.severo",
|
|
|
|
msg: "Invalid value for \"email\""
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
- 401:
|
|
|
|
```
|
|
|
|
{
|
|
|
|
status: 401,
|
|
|
|
msg: "Bad request",
|
|
|
|
errors: [
|
|
|
|
{
|
|
|
|
value: "email/password",
|
|
|
|
msg: "Invalid email or password"
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
- 500
|
|
|
|
```
|
|
|
|
{
|
|
|
|
status: 500,
|
|
|
|
msg: "Internal error occurred",
|
|
|
|
errors: [
|
|
|
|
{
|
|
|
|
value: Any,
|
|
|
|
msg: "str"
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
---
|
|
---
|
|
### GET /students/
|
|
### GET /students/
|
|
|
|
|
... | @@ -241,10 +301,10 @@ Nenhuma query string esperada |
... | @@ -241,10 +301,10 @@ Nenhuma query string esperada |
|
```
|
|
```
|
|
---
|
|
---
|
|
|
|
|
|
### PUT /students/{id}/
|
|
### PATCH /students/{id}/
|
|
|
|
|
|
#### Params:
|
|
#### Params:
|
|
- id: int = id do aluno a atualizar dados
|
|
- id: int = id do aluno a alterar pacialmente informações
|
|
|
|
|
|
#### Query string:
|
|
#### Query string:
|
|
Nenhuma query string esperada
|
|
Nenhuma query string esperada
|
... | @@ -258,78 +318,11 @@ Nenhuma query string esperada |
... | @@ -258,78 +318,11 @@ Nenhuma query string esperada |
|
semester: 5,
|
|
semester: 5,
|
|
course: "Engenharia de Software",
|
|
course: "Engenharia de Software",
|
|
gender: "Masculino",
|
|
gender: "Masculino",
|
|
institution: "PUCRS"
|
|
institution: "PUCRS",
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|
|
- 204: NO_CONTENT
|
|
|
|
|
|
|
|
- 400:
|
|
|
|
```
|
|
|
|
{
|
|
|
|
status: 400,
|
|
|
|
msg: "Bad request",
|
|
|
|
errors: [
|
|
|
|
{
|
|
|
|
value: "joao.severo",
|
|
|
|
msg: "Invalid value for \"email\""
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
- 500
|
|
|
|
```
|
|
|
|
{
|
|
|
|
status: 500,
|
|
|
|
msg: "Internal error occurred",
|
|
|
|
errors: [
|
|
|
|
{
|
|
|
|
value: Any,
|
|
|
|
msg: "str"
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
### PATCH /students/{id}/
|
|
|
|
|
|
|
|
#### Params:
|
|
|
|
- id: int = id do aluno a complementar informações
|
|
|
|
|
|
|
|
#### Query string:
|
|
|
|
Nenhuma query string esperada
|
|
|
|
|
|
|
|
#### Payload:
|
|
|
|
```
|
|
|
|
{
|
|
|
|
description: "str",
|
|
description: "str",
|
|
experienceId: 1
|
|
experienceId: 1
|
|
}
|
|
}
|
|
```
|
|
```
|
|
---
|
|
|
|
|
|
|
|
### POST /login/
|
|
|
|
|
|
|
|
#### Params:
|
|
|
|
Nenhum parâmetro esperado
|
|
|
|
|
|
|
|
#### Query string:
|
|
|
|
Nenhuma query string esperada
|
|
|
|
|
|
|
|
#### Payload:
|
|
|
|
```
|
|
|
|
{
|
|
|
|
email: "str",
|
|
|
|
password: "str",
|
|
|
|
isTeacher: 1
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
#### Responses:
|
|
#### Responses:
|
|
- 204: NO_CONTENT
|
|
- 204: NO_CONTENT
|
|
|
|
|
... | @@ -346,15 +339,15 @@ Nenhuma query string esperada |
... | @@ -346,15 +339,15 @@ Nenhuma query string esperada |
|
]
|
|
]
|
|
}
|
|
}
|
|
```
|
|
```
|
|
- 401:
|
|
- 404
|
|
```
|
|
```
|
|
{
|
|
{
|
|
status: 401,
|
|
status: 404,
|
|
msg: "Bad request",
|
|
msg: "Bad request",
|
|
errors: [
|
|
errors: [
|
|
{
|
|
{
|
|
value: "email/password",
|
|
value: 10,
|
|
msg: "Invalid email or password"
|
|
msg: "Student not found with id=10"
|
|
}
|
|
}
|
|
]
|
|
]
|
|
}
|
|
}
|
... | | ... | |