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

110 lines
2.9 KiB
YAML

tags:
- Holiday
summary: Cria um feriado
description:
Essa rota permite criar um feriado.
parameters:
- in: body
name: body
description: Dados para a criação de um novo feriado.
required: true
schema:
type: object
properties:
name:
type: string
description: Nome do feriado
example: "Entrada"
type:
type: string
description: tipo do feriado
example: "mercado"
date:
type: date
description: data do feriado.
example: "01/05/2025"
estado:
type: string
description: estado associado ao feriado
example: "Rio de Janeiro"
municipio:
type: string
description: municipio associado ao feriado
example: "Rio de Janeiro"
service_instande_id:
type: integer
description: Relacao entre nome da empresa com o feriado
example: 1
parent_id:
type: integer
description: Relacao admin e criação do feriado
example: 4
responses:
201:
description: Feriado cadastrado com sucesso
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: ID do novo feriado
name:
type: string
description: Nome do feriado
type:
type: string
description: tipo do feriado
date:
type: date
description: data do feriado.
estado:
type: string
description: estado associado ao feriado
municipio:
type: string
description: municipio associado ao feriado
service_instande_id:
type: integer
description: Relacao entre nome da empresa com o feriado
parent_id:
type: integer
description: Relacao admin e criação do feriado
examples:
application/json:
id: 1
name: "Mercadao"
tipo: "mercado"
date: "01/05/2025"
estado: "RJ"
municipio: "RJ"
service_instance_id: 1
parent_id: 1
400:
description: Requisição inválida (dados incorretos ou ausentes)
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Os campos 'name' e 'service_id' são obrigatórios."
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"