-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
134 lines (134 loc) · 4.46 KB
/
openapi.yaml
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
---
openapi: "3.1.0"
info:
title: "httpexec REST API"
version: "1.0.0"
paths:
/{command}:
parameters:
- name: "command"
description: |
"Command path. Must resolve to a location under EXEC_ROOT."
in: path
required: true
schema:
type: string
post:
description: "Execute a remote command."
requestBody:
description: "Command execution parameters."
content:
application/json:
schema:
type: object
properties:
args:
description: "Command arguments."
type: array
items:
type: string
nullable: true
stdin:
description: "STDIN parameters."
type: object
nullable: true
properties:
content:
description: "Contents to pass to command STDIN."
type: string
nullable: true
default: null
encode:
description: "Binary encoding scheme."
type: string
nullable: true
default: null
enum:
- "base64"
- "base85"
- null
stderr:
description: "STDERR parameters."
type: object
properties:
capture:
description: "Capture STDERR from command."
type: boolean
default: false
encode:
description: "Binary encoding scheme."
nullable: true
type: string
default: null
enum:
- "base64"
- "base85"
- null
stdout:
description: "STDOUT parameters."
type: object
properties:
capture:
description: "Capture STDERR from command."
type: boolean
default: false
encode:
description: "Binary encoding scheme."
nullable: true
type: string
default: null
enum:
- "base64"
- "base85"
- null
environment:
description: Environment variable overrides
type: object
nullable: true
responses:
"200":
description: "Command was executed."
content:
application/json:
schema:
type: object
properties:
return:
description: "Command exit status."
type: integer
stderr:
description: "Command STDERR output."
nullable: true
type: object
properties:
content:
description: stream content
type: string
encode:
description: "Binary encoding scheme."
nullable: true
type: string
enum:
- "base64"
- "base85"
- null
stdout:
description: "Command STDOUT output (possibly encoded)."
nullable: true
type: object
properties:
content:
description: stream content
type: string
encode:
description: "Binary encoding scheme."
nullable: true
type: string
enum:
- "base64"
- "base85"
- null
"404":
description: "Command could not be found."
"500":
description: "Command could not be executed."