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
93 lines
2.6 KiB
YAML
93 lines
2.6 KiB
YAML
---
|
|
|
|
responses:
|
|
listServices:
|
|
description: A list of services
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/listServicesEnvelope'
|
|
detailService:
|
|
description: A single service
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/detailServiceEnvelope'
|
|
|
|
definitions:
|
|
listServicesEnvelope:
|
|
type: object
|
|
required:
|
|
- meta
|
|
- data
|
|
properties:
|
|
meta:
|
|
$ref: '../shared/standard-responses.yml#/definitions/meta'
|
|
data:
|
|
$ref: '#/definitions/serviceList'
|
|
detailServiceEnvelope:
|
|
type: object
|
|
required:
|
|
- meta
|
|
- data
|
|
properties:
|
|
meta:
|
|
$ref: '../shared/standard-responses.yml#/definitions/meta'
|
|
data:
|
|
$ref: '#/definitions/serviceDetail'
|
|
serviceList:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/serviceDetail'
|
|
serviceDetail:
|
|
type: object
|
|
allOf:
|
|
- $ref: '../shared/base-entity.yml#/definitions/baseEntity'
|
|
- type: object
|
|
required:
|
|
- name
|
|
- maxIdleTimeMillis
|
|
- terminatorStrategy
|
|
- roleAttributes
|
|
- permissions
|
|
- configs
|
|
- config
|
|
- encryptionRequired
|
|
- postureQueries
|
|
properties:
|
|
name:
|
|
type: string
|
|
maxIdleTimeMillis:
|
|
type: integer
|
|
terminatorStrategy:
|
|
type: string
|
|
roleAttributes:
|
|
$ref: '../shared/base-entity.yml#/definitions/attributes'
|
|
permissions:
|
|
$ref: '../shared/base-entity.yml#/definitions/dialBindArray'
|
|
configs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
config:
|
|
type: object
|
|
additionalProperties:
|
|
type: object
|
|
additionalProperties:
|
|
type: object
|
|
description: map of config data for this service keyed by the config type name. Only configs of the types requested will be returned.
|
|
encryptionRequired:
|
|
description: Describes whether connections must support end-to-end encryption on both sides of the connection. Read-only property, set at create.
|
|
type: boolean
|
|
postureQueries:
|
|
type: array
|
|
items:
|
|
$ref: '../shared/posture-queries.yml#/definitions/postureQueries' |