Documentando os paths da API (Parte 2)

Já foi visto como documentar para parâmetros que estejam no path, mas agora será visto como documentar parâmetros que venham na url através da query.

Documentando a remoção de usuários

No nosso arquivo já foi documentado o GET de usuários, agora será visto como documentar o DELETE. Então, com o auxílio da extensão instalada no vscode e acompanhando a aula, implemente no arquivo 'api.yaml' a documentação de delete.

Abaixo, é possível encontrar a parte implementada na aula de hoje:

delete:
      tags:
        - Usuários
      description: Remove um usuário de determinado ID
      operationId: deleteUserByID
      summary: Remove um usuário
      parameters:
        - in: query
          name: id
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  msg:
                    type: string
                    example: "Usuário deletado com sucesso!"
        '400':
          description: 400 Bad Request
          content:
            application/json:
              schema:
                $ref:  "#/components/schemas/Erro"