front_ponto_eletronico/docs/service_roles/create.yml
2025-03-17 15:00:51 -03:00

76 lines
2.0 KiB
YAML

tags:
- Service Roles
summary: Cria uma nova função de serviço
security:
- bearerAuth: []
parameters:
- in: body
name: body
description: Dados para a criação de uma nova função de serviço
required: true
schema:
type: object
properties:
name:
type: string
description: Nome da função de serviço
example: "Admin"
description:
type: string
description: Descrição da função de serviço
example: "Função administrativa."
service_id:
type: integer
description: ID do serviço associado
example: 1
responses:
201:
description: Função de serviço criada com sucesso
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: ID da nova função de serviço
name:
type: string
description: Nome da função de serviço
description:
type: string
description: Descrição da função de serviço
service_id:
type: integer
description: ID do serviço associado
examples:
application/json:
id: 1
name: "Admin"
description: "Função administrativa."
service_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"