-
Notifications
You must be signed in to change notification settings - Fork 215
/
command.yml
58 lines (58 loc) · 1.93 KB
/
command.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
post:
summary: Send a command to a specific Connection.
description: |-
Sends the command specified in the body to the connection identified by the `connectionId`
path parameter.
tags:
- Connections
parameters:
- $ref: '../../parameters/connectionIdPathParam.yml'
responses:
'200':
description: The command was sent to the connection successfully.
'400':
description: |-
The request could not be completed. The `connectionId` must be an URI.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'402':
description: The request could not be completed due to exceeded transaction count.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'403':
description: The request could not be completed due to invalid authentication.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
'404':
description: |-
The request could not be completed. The connection with ID `connectionId` was not found.
content:
application/json:
schema:
$ref: '../../schemas/errors/advancedError.yml'
requestBody:
content:
text/plain:
schema:
type: string
example: '<commmand>'
description: |-
The command to send. Supported commands are
* `connectivity.commands:openConnection`
* `connectivity.commands:closeConnection`
* `connectivity.commands:resetConnectionMetrics`
* `connectivity.commands:enableConnectionLogs`
* `connectivity.commands:resetConnectionLogs`
required: true