102 lines
2.7 KiB
YAML
102 lines
2.7 KiB
YAML
tags:
|
|
- Ambiente
|
|
summary: Lista todos os ambientes 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
|
|
- in: query
|
|
name: per_page
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
default: 10
|
|
description: Número de ambientes por página
|
|
responses:
|
|
200:
|
|
description: Lista de ambientes com informações de paginação
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
description: Número total de ambientes.
|
|
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 do 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 service_role associado
|
|
examples:
|
|
application/json:
|
|
total: 2
|
|
pages: 1
|
|
current_page: 1
|
|
per_page: 10
|
|
ambiente:
|
|
- id: 1
|
|
name: "Entrada"
|
|
description: "hall de entrada."
|
|
service_id: 4
|
|
service_role_id: 4
|
|
- id: 2
|
|
name: "Estoque"
|
|
description: "Estoque."
|
|
service_id: 4
|
|
service_role_id: 4
|
|
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: Nenhum ambiente encontrado
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
error:
|
|
type: string
|
|
examples:
|
|
application/json:
|
|
error: "Nenhum ambiente encontrado"
|