70 lines
1.9 KiB
YAML
70 lines
1.9 KiB
YAML
tags:
|
|
- Service
|
|
summary: "Lista todos os serviços com paginação"
|
|
description: >
|
|
Endpoint para listar todos os serviços cadastrados.
|
|
Este endpoint suporta paginação para facilitar a navegação pelos serviços.
|
|
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
description: "Número da página a ser retornada. Padrão é 1."
|
|
required: false
|
|
example: 1
|
|
- in: query
|
|
name: per_page
|
|
type: integer
|
|
description: "Quantidade de registros por página. Padrão é 10."
|
|
required: false
|
|
example: 10
|
|
|
|
responses:
|
|
200:
|
|
description: "Lista de serviços paginada"
|
|
schema:
|
|
type: object
|
|
properties:
|
|
services:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
example: 1
|
|
name:
|
|
type: string
|
|
example: "Serviço de Backup"
|
|
description:
|
|
type: string
|
|
example: "Serviço de armazenamento em nuvem para backup de dados"
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
example: "2024-12-06T12:00:00Z"
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
example: "2024-12-06T14:00:00Z"
|
|
total:
|
|
type: integer
|
|
example: 100
|
|
description: "Número total de serviços disponíveis"
|
|
page:
|
|
type: integer
|
|
example: 1
|
|
description: "Número da página retornada"
|
|
per_page:
|
|
type: integer
|
|
example: 10
|
|
description: "Quantidade de registros por página retornada"
|
|
400:
|
|
description: "Erro na solicitação"
|
|
schema:
|
|
type: object
|
|
properties:
|
|
message:
|
|
type: string
|
|
example: "Parâmetros de paginação inválidos"
|