front_ponto_eletronico/docs/holiday/list.yml
2025-04-16 19:48:09 -03:00

112 lines
3.0 KiB
YAML

tags:
- Holiday
summary: Lista todos os Holidays com paginação.
security:
- bearerAuth: []
parameters:
- in: query
name: page
required: false
schema:
type: integer
default: 1
description: Número da página a ser retornada
- in: query
name: per_page
required: false
schema:
type: integer
default: 10
description: Número de Holidays por página
responses:
200:
description: Lista de Holidays com informações de paginação
content:
application/json:
schema:
type: object
properties:
total:
type: integer
description: Número total de Holidays.
pages:
type: integer
description: Número total de páginas
current_page:
type: integer
description: Página atual
per_page:
type: integer
description: Número de itens por página
roles:
type: array
items:
type: object
properties:
id:
type: integer
description: ID do Holiday
name:
type: string
description: Nome do Holiday
date:
type: string
description: 01/05/2025
estado:
type: string
description: rj
municipio:
type: string
description: rj
service_id:
type: integer
description: ID do serviço associado
service_role_id:
type: "integer"
description: ID do service_role associado
examples:
application/json:
total: 2
pages: 1
current_page: 1
per_page: 10
Holiday:
- id: 1
name: "Entrada"
date: "01/05/2025"
municipio: 'RJ'
estado: "rj"
service_id: 1
service_role_id: 1
- id: 2
name: "Entrada"
date: "01/05/2025"
municipio: 'SP'
estado: "SP"
service_id: 1
service_role_id: 1
401:
description: Token inválido ou ausente
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Token inválido ou ausente"
404:
description: Nenhum Holiday encontrado
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Nenhum Holiday encontrado"