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
139 lines
3.1 KiB
YAML
139 lines
3.1 KiB
YAML
---
|
|
paths:
|
|
root:
|
|
get:
|
|
summary: Returns version information
|
|
security: [ ]
|
|
tags:
|
|
- Informational
|
|
operationId: listRoot
|
|
responses:
|
|
'200':
|
|
$ref: '#/responses/listVersion'
|
|
version:
|
|
get:
|
|
summary: Returns version information
|
|
security: [ ]
|
|
tags:
|
|
- Informational
|
|
operationId: listVersion
|
|
responses:
|
|
'200':
|
|
$ref: '#/responses/listVersion'
|
|
enumerated-capabilities:
|
|
get:
|
|
summary: Returns all capabilities this version of the controller is aware of, enabled or not.
|
|
security: [ ]
|
|
tags:
|
|
- Informational
|
|
operationId: listEnumeratedCapabilities
|
|
responses:
|
|
'200':
|
|
$ref: '#/responses/listEnumeratedCapabilities'
|
|
responses:
|
|
listVersion:
|
|
description: Version information for the controller
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/listVersionEnvelope'
|
|
listEnumeratedCapabilities:
|
|
description: A typed and enumerated list of capabilities
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/listEnumeratedCapabilitiesEnvelope'
|
|
|
|
definitions:
|
|
listEnumeratedCapabilitiesEnvelope:
|
|
type: object
|
|
required:
|
|
- meta
|
|
- data
|
|
properties:
|
|
meta:
|
|
$ref: 'standard-responses.yml#/definitions/meta'
|
|
data:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/capabilities'
|
|
listVersionEnvelope:
|
|
type: object
|
|
required:
|
|
- meta
|
|
- data
|
|
properties:
|
|
meta:
|
|
$ref: 'standard-responses.yml#/definitions/meta'
|
|
data:
|
|
$ref: '#/definitions/version'
|
|
version:
|
|
type: object
|
|
properties:
|
|
buildDate:
|
|
type: string
|
|
example: '2020-02-11 16:09:08'
|
|
revision:
|
|
type: string
|
|
example: 'ea556fc18740'
|
|
runtimeVersion:
|
|
type: string
|
|
example: 'go1.13.5'
|
|
version:
|
|
type: string
|
|
example: 'v0.9.0'
|
|
apiVersions:
|
|
type: object
|
|
additionalProperties:
|
|
type: object
|
|
additionalProperties:
|
|
$ref: '#/definitions/apiVersion'
|
|
capabilities:
|
|
type: array
|
|
items:
|
|
type: string
|
|
capabilities:
|
|
type: string
|
|
enum:
|
|
- OIDC_AUTH
|
|
- HA_CONTROLLER
|
|
apiVersion:
|
|
type: object
|
|
required:
|
|
- path
|
|
properties:
|
|
version:
|
|
type: string
|
|
path:
|
|
type: string
|
|
apiBaseUrls:
|
|
type: array
|
|
items:
|
|
type: string
|
|
versionInfo:
|
|
type: object
|
|
required:
|
|
- os
|
|
- version
|
|
- arch
|
|
- buildDate
|
|
- revision
|
|
properties:
|
|
os:
|
|
type: string
|
|
version:
|
|
type: string
|
|
arch:
|
|
type: string
|
|
buildDate:
|
|
type: string
|
|
revision:
|
|
type: string |