Files
ziti/specs/source/client/current-identity-edge-routers.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

49 lines
1.5 KiB
YAML

---
paths:
current-identity-edge-routers:
get:
summary: Return this list of Edge Routers the identity has access to
description: |
Lists the Edge Routers that the current identity has access to via policies. The data returned
includes their address and online status
security:
- ztSession: [ ]
tags:
- Current Identity
- Edge Router
operationId: getCurrentIdentityEdgeRouters
responses:
'200':
$ref: '#/responses/listCurrentIdentityEdgeRouters'
'401':
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
responses:
listCurrentIdentityEdgeRouters:
description: A list of edge routers
schema:
$ref: '#/definitions/listCurrentIdentityEdgeRoutersEnvelope'
definitions:
listCurrentIdentityEdgeRoutersEnvelope:
type: object
required:
- meta
- data
properties:
meta:
$ref: '../shared/standard-responses.yml#/definitions/meta'
data:
$ref: '#/definitions/currentIdentityEdgeRouterList'
currentIdentityEdgeRouterList:
description: A list of edge router resources
type: array
items:
$ref: '#/definitions/currentIdentityEdgeRouterDetail'
currentIdentityEdgeRouterDetail:
description: A detail edge router resource
type: object
allOf:
- $ref: '../shared/base-entity.yml#/definitions/baseEntity'
- $ref: '../shared/edge-routers.yml#/definitions/commonEdgeRouterProperties'