Files
ziti/specs/source/shared/sessions.yml
T
Andrew Martinez b562fb5c07 splits API specs into composible modules
- 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)
2021-05-04 11:30:32 -04:00

81 lines
1.9 KiB
YAML

---
responses:
listSessions:
description: A list of sessions
schema:
$ref: '#/definitions/listSessionsEnvelope'
detailSession:
description: A single session
schema:
$ref: '#/definitions/detailSessionEnvelope'
definitions:
listSessionsEnvelope:
type: object
required:
- meta
- data
properties:
meta:
$ref: 'standard-responses.yml#/definitions/meta'
data:
$ref: '#/definitions/sessionList'
detailSessionEnvelope:
type: object
required:
- meta
- data
properties:
meta:
$ref: 'standard-responses.yml#/definitions/meta'
data:
$ref: '#/definitions/sessionDetail'
sessionList:
type: array
items:
$ref: '#/definitions/sessionDetail'
sessionDetail:
type: object
allOf:
- $ref: 'base-entity.yml#/definitions/baseEntity'
- type: object
required:
- type
- apiSessionId
- apiSession
- serviceId
- service
- token
- edgeRouters
properties:
type:
$ref: 'base-entity.yml#/definitions/dialBind'
token:
type: string
apiSessionId:
type: string
apiSession:
$ref: 'base-entity.yml#/definitions/entityRef'
serviceId:
type: string
service:
$ref: 'base-entity.yml#/definitions/entityRef'
edgeRouters:
type: array
items:
$ref: '#/definitions/sessionEdgeRouter'
sessionEdgeRouter:
allOf:
- $ref: "edge-routers.yml#/definitions/commonEdgeRouterProperties"
- type: object
required:
- urls
properties:
# deprecated property, see supportedProtocols in commonEdgeRouterProperties
urls:
type: object
additionalProperties:
type: string