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
134 lines
4.4 KiB
YAML
134 lines
4.4 KiB
YAML
---
|
|
paths:
|
|
sessions:
|
|
get:
|
|
summary: List sessions
|
|
description: |
|
|
Retrieves a list of active sessions resources; supports filtering, sorting, and pagination.
|
|
|
|
Sessions are tied to an API session and are moved when an API session times out or logs out. Active sessions
|
|
(i.e. Ziti SDK connected to an edge router) will keep the session and API session marked as active.
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Session
|
|
operationId: listSessions
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/limit'
|
|
- $ref: '../shared/parameters.yml#/offset'
|
|
- $ref: '../shared/parameters.yml#/filter'
|
|
responses:
|
|
'200':
|
|
$ref: '../shared/sessions.yml#/responses/listSessions'
|
|
'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'
|
|
|
|
post:
|
|
summary: Create a session resource
|
|
description: Create a session resource.
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Session
|
|
operationId: createSession
|
|
parameters:
|
|
- name: session
|
|
in: body
|
|
required: true
|
|
description: A session to create
|
|
schema:
|
|
$ref: '#/definitions/sessionCreate'
|
|
responses:
|
|
'201':
|
|
$ref: '#/responses/sessionCreateResponse'
|
|
'400':
|
|
$ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
'404':
|
|
$ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
|
|
'429':
|
|
$ref: '../shared/standard-responses.yml#/responses/rateLimitedResponse'
|
|
'503':
|
|
$ref: '../shared/standard-responses.yml#/responses/serverUnavailableResponse'
|
|
|
|
sessions-id:
|
|
parameters:
|
|
- $ref: '../shared/parameters.yml#/id'
|
|
get:
|
|
summary: Retrieves a single session
|
|
description: Retrieves a single session by id.
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Session
|
|
operationId: detailSession
|
|
responses:
|
|
'200':
|
|
$ref: '../shared/sessions.yml#/responses/detailSession'
|
|
'404':
|
|
$ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
delete:
|
|
summary: Delete a session
|
|
description: Delete a session by id.
|
|
security:
|
|
- ztSession: [ ]
|
|
- oauth2: [ openid ]
|
|
tags:
|
|
- Session
|
|
operationId: deleteSession
|
|
responses:
|
|
'200':
|
|
$ref: '../shared/standard-responses.yml#/responses/deleteResponse'
|
|
'400':
|
|
$ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
|
|
'401':
|
|
$ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
|
|
'409':
|
|
$ref: '../shared/standard-responses.yml#/responses/cannotDeleteReferencedResourceResponse'
|
|
'429':
|
|
$ref: '../shared/standard-responses.yml#/responses/rateLimitedResponse'
|
|
'503':
|
|
$ref: '../shared/standard-responses.yml#/responses/serverUnavailableResponse'
|
|
|
|
responses:
|
|
sessionCreateResponse:
|
|
description: The create request was successful and the resource has been added at the following location
|
|
headers:
|
|
WWW-Authenticate:
|
|
description: "Denotes different type of security token related information"
|
|
type: array
|
|
items:
|
|
type: string
|
|
schema:
|
|
$ref: '#/definitions/sessionCreateEnvelope'
|
|
|
|
definitions:
|
|
sessionCreateEnvelope:
|
|
type: object
|
|
properties:
|
|
meta:
|
|
$ref: '../shared/standard-responses.yml#/definitions/meta'
|
|
data:
|
|
$ref: '../shared/sessions.yml#/definitions/sessionDetail'
|
|
sessionCreate:
|
|
type: object
|
|
properties:
|
|
serviceId:
|
|
type: string
|
|
type:
|
|
$ref: '../shared/base-entity.yml#/definitions/dialBind'
|
|
tags:
|
|
$ref: '../shared/base-entity.yml#/definitions/tags'
|