101 lines
2.1 KiB
YAML
101 lines
2.1 KiB
YAML
get:
|
|
tags:
|
|
- Flows (Streams)
|
|
security:
|
|
- ApiKeyAuth: []
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Flow ID
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
summary: Get flow
|
|
description: Returns flow details.
|
|
responses:
|
|
'200':
|
|
description: Flow
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../schemas/Stream.yaml
|
|
'400':
|
|
$ref: ../responses/BadRequest.yaml
|
|
'401':
|
|
$ref: ../responses/Unauthorized.yaml
|
|
'402':
|
|
$ref: ../responses/PaymentRequired.yaml
|
|
'404':
|
|
$ref: ../responses/NotFound.yaml
|
|
'500':
|
|
$ref: ../responses/InternalError.yaml
|
|
put:
|
|
tags:
|
|
- Flows (Streams)
|
|
security:
|
|
- ApiKeyAuth: []
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Flow ID
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
summary: Update flow
|
|
description: Updates flow.
|
|
requestBody:
|
|
description: Flows fields to update.
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../schemas/StreamRequestPut.yaml
|
|
responses:
|
|
'200':
|
|
description: Flow details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../schemas/Stream.yaml
|
|
'400':
|
|
$ref: ../responses/BadRequest.yaml
|
|
'401':
|
|
$ref: ../responses/Unauthorized.yaml
|
|
'402':
|
|
$ref: ../responses/PaymentRequired.yaml
|
|
'404':
|
|
$ref: ../responses/NotFound.yaml
|
|
'500':
|
|
$ref: ../responses/InternalError.yaml
|
|
delete:
|
|
tags:
|
|
- Flows (Streams)
|
|
security:
|
|
- ApiKeyAuth: []
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: Flow ID
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
summary: Delete flow
|
|
description: Moves strema to the archive
|
|
responses:
|
|
'200':
|
|
description: Flow
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../schemas/Stream.yaml
|
|
'400':
|
|
$ref: ../responses/BadRequest.yaml
|
|
'401':
|
|
$ref: ../responses/Unauthorized.yaml
|
|
'402':
|
|
$ref: ../responses/PaymentRequired.yaml
|
|
'404':
|
|
$ref: ../responses/NotFound.yaml
|
|
'500':
|
|
$ref: ../responses/InternalError.yaml
|