mirror of
https://github.com/openziti/ziti.git
synced 2026-09-21 01:53:22 +00:00
Andrew Martinez
b562fb5c07
- splits Open API 2.0 (swagger) into client/management APIs - uses go-swaggers flatten capabilities - uses newer version of go-swagger (v0.27.0) - introduces /edge/client/v1, /edge/management/v1 - non-prefixed URLs default to /edge/client/v1 - splits some shared management/client API handlers - renames some REST models to "client" instead of "limited" - passes all apitests, fails dataflow upd test (main fails this as well) - updates generate rest script for powershell - todo: test generate rest script for bash - todo: use xweb (different branch)
77 lines
2.0 KiB
YAML
77 lines
2.0 KiB
YAML
---
|
|
|
|
responses:
|
|
listServices:
|
|
description: A list of services
|
|
schema:
|
|
$ref: '#/definitions/listServicesEnvelope'
|
|
detailService:
|
|
description: A single service
|
|
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
|
|
- terminatorStrategy
|
|
- roleAttributes
|
|
- permissions
|
|
- configs
|
|
- config
|
|
- encryptionRequired
|
|
- postureQueries
|
|
properties:
|
|
name:
|
|
type: string
|
|
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:
|
|
type: boolean
|
|
postureQueries:
|
|
type: array
|
|
items:
|
|
$ref: '../shared/posture-queries.yml#/definitions/postureQueries' |