front_ponto_eletronico/docs/settings_calculo_horas/update.yml

102 lines
3.0 KiB
YAML

tags:
- Settings Cálculo Horas
summary: Atualiza uma configuração de cálculo de horas existente
description: >
Essa rota permite atualizar uma configuração de cálculo de horas especificada pelo ID.
parameters:
- in: path
name: settings_id
required: true
schema:
type: integer
description: ID da configuração que será atualizada.
- in: body
name: body
description: Dados para atualização da configuração.
required: true
schema:
type: object
properties:
jornada_diaria:
type: integer
description: Jornada de trabalho diária em minutos
example: 480
jornada_semanal:
type: integer
description: Jornada de trabalho semanal em minutos
example: 2400
inicio_periodo_noturno:
type: string
format: time
description: Hora de início do período noturno
example: "22:00:00"
fim_periodo_noturno:
type: string
format: time
description: Hora de fim do período noturno
example: "05:00:00"
desconto_atraso_automatico:
type: string
description: Habilita ou não o desconto automático por atraso
example: "True"
tolerancia_para_descontos:
type: integer
description: Tolerância em minutos para aplicação de descontos
example: 10
arredondamento_minutos:
type: integer
description: Minutos utilizados para arredondamento
example: 5
service_instance_id:
type: integer
description: ID da instância de serviço associada
example: 4
responses:
200:
description: Configuração atualizada com sucesso
content:
application/json:
schema:
type: object
properties:
message:
type: string
examples:
application/json:
message: "Configuração atualizada com sucesso"
400:
description: Requisição inválida (dados incorretos ou ausentes)
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Campos obrigatórios ausentes ou inválidos."
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: Configuração não encontrada
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Configuração não encontrada"