97 lines
2.6 KiB
YAML
97 lines
2.6 KiB
YAML
tags:
|
|
- Service Roles
|
|
summary: Lista todas as funções de serviço 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 funções de serviço por página
|
|
responses:
|
|
200:
|
|
description: Lista de funções de serviço 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 função de serviço
|
|
name:
|
|
type: string
|
|
description: Nome da função de serviço
|
|
description:
|
|
type: string
|
|
description: Descrição da função de serviço
|
|
service_id:
|
|
type: integer
|
|
description: ID do serviço associado
|
|
examples:
|
|
application/json:
|
|
total: 2
|
|
pages: 1
|
|
current_page: 1
|
|
per_page: 10
|
|
roles:
|
|
- id: 1
|
|
name: "Admin"
|
|
description: "Função administrativa."
|
|
service_id: 1
|
|
- id: 2
|
|
name: "User"
|
|
description: "Função padrão de usuário."
|
|
service_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 função de serviço encontrada
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
error:
|
|
type: string
|
|
examples:
|
|
application/json:
|
|
error: "Nenhuma função de serviço encontrada"
|