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
186 lines
6.1 KiB
YAML
186 lines
6.1 KiB
YAML
---
|
|
paths:
|
|
services:
|
|
get:
|
|
summary: List services
|
|
description: |
|
|
Retrieves a list of config resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Service
|
|
operationId: listServices
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/limit'
|
|
- $ref: '../shared/parameters.yml#/offset'
|
|
- $ref: '../shared/parameters.yml#/filter'
|
|
- $ref: '../shared/parameters.yml#/configTypes'
|
|
- $ref: '../shared/parameters.yml#/roleFilter'
|
|
- $ref: '../shared/parameters.yml#/roleSemantic'
|
|
responses:
|
|
'200':
|
|
$ref: '../shared/services.yml#/responses/listServices'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
'400':
|
|
$ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
|
|
'429':
|
|
$ref: '../shared/standard-responses.yml#/responses/rateLimitedResponse'
|
|
'503':
|
|
$ref: '../shared/standard-responses.yml#/responses/serverUnavailableResponse'
|
|
|
|
services-id:
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/id'
|
|
get:
|
|
summary: Retrieves a single service
|
|
description: Retrieves a single service by id. Requires admin access.
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Service
|
|
operationId: detailService
|
|
responses:
|
|
'200':
|
|
$ref: '../shared/services.yml#/responses/detailService'
|
|
'404':
|
|
$ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
'429':
|
|
$ref: '../shared/standard-responses.yml#/responses/rateLimitedResponse'
|
|
'503':
|
|
$ref: '../shared/standard-responses.yml#/responses/serverUnavailableResponse'
|
|
|
|
services-id-terminators:
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/id'
|
|
get:
|
|
summary: List of terminators assigned to a service
|
|
description: |
|
|
Retrieves a list of terminator resources that are assigned specific service; supports filtering, sorting, and pagination.
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Service
|
|
operationId: listServiceTerminators
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/limit'
|
|
- $ref: '../shared/parameters.yml#/offset'
|
|
- $ref: '../shared/parameters.yml#/filter'
|
|
responses:
|
|
'200':
|
|
$ref: '#/responses/listClientTerminators'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
'400':
|
|
$ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
|
|
'429':
|
|
$ref: '../shared/standard-responses.yml#/responses/rateLimitedResponse'
|
|
'503':
|
|
$ref: '../shared/standard-responses.yml#/responses/serverUnavailableResponse'
|
|
|
|
services-id-edge-routers:
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/id'
|
|
get:
|
|
summary: List of edge routers permitted to handle traffic for the specified service
|
|
description: |
|
|
Retrieves the list of edge routers permitted to handle traffic for the specified service
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Service
|
|
operationId: listServiceEdgeRouters
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/limit'
|
|
- $ref: '../shared/parameters.yml#/offset'
|
|
- $ref: '../shared/parameters.yml#/filter'
|
|
- name: session-token
|
|
description: an optional JWT token use to authenticate the request. If provided, the token must be valid else a not authorized response is returned.
|
|
type: string
|
|
in: header
|
|
responses:
|
|
'200':
|
|
$ref: '#/responses/listServiceEdgeRouters'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
'400':
|
|
$ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
|
|
'429':
|
|
$ref: '../shared/standard-responses.yml#/responses/rateLimitedResponse'
|
|
'404':
|
|
$ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
|
|
|
|
|
|
responses:
|
|
listClientTerminators:
|
|
description: A list of terminators
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/listClientTerminatorsEnvelope'
|
|
listServiceEdgeRouters:
|
|
description: A list of edge routers suitable for dialing or binding the specified service by the authenticated identity
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/listServiceEdgeRoutersEnvelope'
|
|
|
|
|
|
definitions:
|
|
listServiceEdgeRoutersEnvelope:
|
|
type: object
|
|
required:
|
|
- meta
|
|
- data
|
|
properties:
|
|
meta:
|
|
$ref: '../shared/standard-responses.yml#/definitions/meta'
|
|
data:
|
|
$ref: '../shared/edge-routers.yml#/definitions/serviceEdgeRouters'
|
|
listClientTerminatorsEnvelope:
|
|
type: object
|
|
required:
|
|
- meta
|
|
- data
|
|
properties:
|
|
meta:
|
|
$ref: '../shared/standard-responses.yml#/definitions/meta'
|
|
data:
|
|
$ref: '#/definitions/terminatorClientList'
|
|
terminatorClientList:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/terminatorClientDetail'
|
|
terminatorClientDetail:
|
|
type: object
|
|
allOf:
|
|
- $ref: '../shared/base-entity.yml#/definitions/baseEntity'
|
|
- type: object
|
|
required:
|
|
- serviceId
|
|
- service
|
|
- routerId
|
|
- identity
|
|
properties:
|
|
serviceId:
|
|
type: string
|
|
service:
|
|
$ref: '../shared/base-entity.yml#/definitions/entityRef'
|
|
routerId:
|
|
type: string
|
|
identity:
|
|
type: string |