front_ponto_eletronico/docs/camera/create.yml
2025-03-31 12:01:39 -03:00

116 lines
3.1 KiB
YAML

tags:
- Camera
summary: Cria uma nova camera
security:
- bearerAuth: []
parameters:
- in: body
name: body
description: Dados para a criação de uma nova camera
required: true
schema:
type: object
properties:
name:
type: string
description: Nome da camera
example: "camera entrada"
description:
type: string
description: Descrição da localização ou modelo da camera
example: "camera entrada modelo xxx."
url:
type: string
description: url para acessar a camera
example: "http://exemplo."
status:
type: string
description: Estado da camera
example: "Ativo."
service_id:
type: integer
description: ID do serviço associado
example: 1
service_instance_id:
type: integer
description: ID da empresa associada
example: 1
ambiente_id:
type: integer
description: ID do serviço associado
example: 1
service_role_id:
type: integer
description: ID do serviço associado
example: 14
responses:
201:
description: Camera cadastrada com sucesso
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: ID da nova camera
name:
type: string
description: Nome da camera
description:
type: string
description: Descrição da camera
status:
type: string
description: Status da camera
url:
type: string
description: url para acessar a camera
service_id:
type: integer
description: ID do serviço associado
service_instance_id:
type: integer
description: ID da empresa associada
ambiente_id:
type: integer
description: ID do ambiente_id
service_role_id:
type: integer
description: ID do serviço role
examples:
application/json:
id: 1
name: "camera entrada"
description: "camera sony entrada."
status: "Ativo"
url: "http://exemplo.com"
service_id: 3
ambiente_id: 1
service_role_id: 5
service_instance_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"