mirror of
https://github.com/openziti/ziti.git
synced 2026-10-12 15:28:05 +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)
99 lines
2.0 KiB
YAML
99 lines
2.0 KiB
YAML
---
|
|
definitions:
|
|
baseEntity:
|
|
description: Fields shared by all Edge API entities
|
|
type: object
|
|
required:
|
|
- id
|
|
- createdAt
|
|
- updatedAt
|
|
- _links
|
|
- tags
|
|
properties:
|
|
id:
|
|
type: string
|
|
createdAt:
|
|
type: string
|
|
format: date-time
|
|
updatedAt:
|
|
type: string
|
|
format: date-time
|
|
_links:
|
|
$ref: '#/definitions/links'
|
|
tags:
|
|
$ref: '#/definitions/tags'
|
|
link:
|
|
description: A link to another resource
|
|
type: object
|
|
required:
|
|
- href
|
|
properties:
|
|
href:
|
|
type: string
|
|
format: uri
|
|
method:
|
|
type: string
|
|
comment:
|
|
type: string
|
|
links:
|
|
description: A map of named links
|
|
type: object
|
|
x-omitempty: false
|
|
additionalProperties:
|
|
$ref: '#/definitions/link'
|
|
entityRef:
|
|
description: A reference to another resource and links to interact with it
|
|
type: object
|
|
properties:
|
|
entity:
|
|
type: string
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
_links:
|
|
$ref: '#/definitions/links'
|
|
tags:
|
|
description: 'A map of user defined fields and values. The values are limited to the following types/values: null, string, boolean'
|
|
type: object
|
|
x-omitempty: false
|
|
additionalProperties: {
|
|
type: object
|
|
}
|
|
attributes:
|
|
description: A set of strings used to loosly couple this resource to policies
|
|
type: array
|
|
x-omitempty: false
|
|
items:
|
|
type: string
|
|
roles:
|
|
type: array
|
|
x-omitempty: false
|
|
items:
|
|
type: string
|
|
namedRole:
|
|
type: object
|
|
properties:
|
|
role:
|
|
type: string
|
|
name:
|
|
type: string
|
|
namedRoles:
|
|
type: array
|
|
x-omitempty: false
|
|
items:
|
|
$ref: '#/definitions/namedRole'
|
|
semantic:
|
|
type: string
|
|
enum:
|
|
- AllOf
|
|
- AnyOf
|
|
dialBind:
|
|
type: string
|
|
enum:
|
|
- Dial
|
|
- Bind
|
|
dialBindArray:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/dialBind' |