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

121 lines
3.4 KiB
YAML

tags:
- Camera
summary: Lista todas as cameras com paginação.
security:
- bearerAuth: []
parameters:
- in: query
name: page
required: false
schema:
type: integer
default: 1
description: Número da página a ser retornada
status: Status da camera
- in: query
name: per_page
required: false
schema:
type: integer
default: 10
description: Número de funções de serviço por página
responses:
200:
description: Lista de cameras com informações de paginação
content:
application/json:
schema:
type: object
properties:
total:
type: integer
description: Número total de funções de serviço
pages:
type: integer
description: Número total de páginas
current_page:
type: integer
description: Página atual
per_page:
type: integer
description: Número de itens por página
roles:
type: array
items:
type: object
properties:
id:
type: integer
description: ID da 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
ambiente_id:
type: "integer"
description: ID do ambiente associado
service_role_id:
type: "integer"
description: ID do service_role associado
examples:
application/json:
total: 2
pages: 1
current_page: 1
per_page: 10
roles:
- id: 1
name: "camera 1"
description: "camera hall de entrada."
status: "Ativa"
url: "http://exemplo.com"
service_id: 1
ambiente_id: 1
service_role_id: 1
service_instance_id: 1
- id: 2
name: "camera 1"
description: "camera estoque."
status: "Inativa"
url: "http://exemplo.com"
service_id: 1
ambiente_id: 1
service_role_id: 1
service_instance_id: 1
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: Nenhuma camera encontrada
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Nenhuma camera encontrada"