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

84 lines
2.2 KiB
YAML

tags:
- Ambiente
summary: Cria um novo ambiente
security:
- bearerAuth: []
parameters:
- in: body
name: body
description: Dados para a criação de um novo ambiente.
required: true
schema:
type: object
properties:
name:
type: string
description: Nome do ambiente
example: "Entrada"
description:
type: string
description: Descrição do ambiente
example: "Entrada da loja, esse ambiente possui 4 cameras."
service_id:
type: integer
description: ID do serviço associado
example: 4
service_role_id:
type: integer
description: ID do serviço role associado
example: 4
responses:
201:
description: Ambiente cadastrado com sucesso
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: ID do novo ambiente
name:
type: string
description: Nome do ambiente
description:
type: string
description: Descrição do ambiente
service_id:
type: integer
description: ID do serviço associado
service_role_id:
type: integer
description: ID do serviço role
examples:
application/json:
id: 1
name: "Entrada da loja"
description: "Esse ambiente possui 4 cameras."
service_id: 4
service_role_id: 4
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"