67 lines
1.9 KiB
YAML
67 lines
1.9 KiB
YAML
tags:
|
|
- Service Instance
|
|
summary: "Lista todas as Empresas."
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema:
|
|
type: integer
|
|
default: 1
|
|
description: "Número da página. Default: 1."
|
|
- in: query
|
|
name: per_page
|
|
schema:
|
|
type: integer
|
|
default: 10
|
|
description: "Quantidade de itens por página. Default: 10."
|
|
- in: query
|
|
name: permission_id
|
|
schema:
|
|
type: integer
|
|
description: "ID da permissão para filtrar no retorno."
|
|
responses:
|
|
200:
|
|
description: "Lista as empresas e services_instances associados."
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: "id do service_instance"
|
|
example: 1
|
|
name:
|
|
type: string
|
|
description: "Nome da empresa."
|
|
example: "Permissão de Admin"
|
|
description:
|
|
type: string
|
|
description: "Descrição da permissão."
|
|
example: "Permissão completa para gerenciar o sistema."
|
|
404:
|
|
description: "Nenhuma permissão encontrada."
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: string
|
|
example: "Nenhuma permissão encontrada."
|
|
401:
|
|
description: "Token de autenticação inválido ou ausente."
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: string
|
|
example: "Token de autenticação inválido ou ausente."
|