mirror of
https://github.com/hanzozt/edge-api.git
synced 2026-10-30 14:44:05 +00:00
Andrew MartinezandGitHub
2a12985526
* for openziti/ziti#3356 add www-authenticate headers - adds www-authenticate headers to all responses - moves to swagger 0.33.1 - updates readme - updates version checking in powershell and bash
101 lines
2.5 KiB
YAML
101 lines
2.5 KiB
YAML
---
|
|
paths:
|
|
controllers:
|
|
get:
|
|
summary: List controllers
|
|
description: Retrieves a list of controllers
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Controllers
|
|
operationId: listControllers
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/limit'
|
|
- $ref: '../shared/parameters.yml#/offset'
|
|
- $ref: '../shared/parameters.yml#/filter'
|
|
responses:
|
|
'200':
|
|
$ref: '#/responses/listControllers'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
'400':
|
|
$ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
|
|
'429':
|
|
$ref: '../shared/standard-responses.yml#/responses/rateLimitedResponse'
|
|
|
|
responses:
|
|
listControllers:
|
|
description: A list of controllers
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/listControllersEnvelope'
|
|
|
|
definitions:
|
|
listControllersEnvelope:
|
|
type: object
|
|
required:
|
|
- meta
|
|
- data
|
|
properties:
|
|
meta:
|
|
$ref: '../shared/standard-responses.yml#/definitions/meta'
|
|
data:
|
|
$ref: '#/definitions/controllersList'
|
|
controllersList:
|
|
description: An array of controller resources
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/controllerDetail'
|
|
|
|
apiAddress:
|
|
type: object
|
|
properties:
|
|
url:
|
|
type: string
|
|
version:
|
|
type: string
|
|
apiAddressArray:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/apiAddress'
|
|
|
|
apiAddressList:
|
|
type: object
|
|
additionalProperties:
|
|
$ref: '#/definitions/apiAddressArray'
|
|
|
|
controllerDetail:
|
|
description: A controller resource
|
|
type: object
|
|
allOf:
|
|
- $ref: '../shared/base-entity.yml#/definitions/baseEntity'
|
|
- type: object
|
|
required:
|
|
- name
|
|
- certPem
|
|
- fingerprint
|
|
- isOnline
|
|
- lastJoinedAt
|
|
properties:
|
|
name:
|
|
type: string
|
|
ctrlAddress:
|
|
type: string
|
|
x-nullable: true
|
|
apiAddresses:
|
|
$ref: '#/definitions/apiAddressList'
|
|
certPem:
|
|
type: string
|
|
fingerprint:
|
|
type: string
|
|
isOnline:
|
|
type: boolean
|
|
lastJoinedAt:
|
|
type: string
|
|
format: date-time |