Skip to content

Commit 7b02966

Browse files
committed
make positional name->name_hint, keep name for kv and flags
1 parent db7f9e7 commit 7b02966

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

api/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
6868
"package_arguments": [
6969
{
7070
"type": "positional",
71-
"name": "target_dir",
71+
"name_hint": "target_dir",
7272
"description": "Path to access",
7373
"default": "/Users/username/Desktop",
7474
"is_required": true,
@@ -77,7 +77,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
7777
],
7878
"environment_variables": [
7979
{
80-
"key": "LOG_LEVEL",
80+
"name": "LOG_LEVEL",
8181
"description": "Logging level (debug, info, warn, error)",
8282
"default": "info"
8383
}
@@ -91,7 +91,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
9191
{
9292
"type": "named",
9393
"description": "Mount a volume into the container",
94-
"flag": "--mount",
94+
"name": "--mount",
9595
"value": "type=bind,src={source_path},dst={target_path}",
9696
"is_required": true,
9797
"is_repeated": true,
@@ -112,13 +112,13 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
112112
"package_arguments": [
113113
{
114114
"type": "positional",
115-
"name": "target_dir",
115+
"name_hint": "target_dir",
116116
"value": "/project",
117117
}
118118
],
119119
"environment_variables": [
120120
{
121-
"key": "LOG_LEVEL",
121+
"name": "LOG_LEVEL",
122122
"description": "Logging level (debug, info, warn, error)",
123123
"default": "info"
124124
}
@@ -162,7 +162,7 @@ API Response:
162162
"version": "1.0.2",
163163
"environment_variables": [
164164
{
165-
"key": "BRAVE_API_KEY",
165+
"name": "BRAVE_API_KEY",
166166
"description": "Brave Search API Key",
167167
"is_required": true,
168168
"is_secret": true
@@ -217,7 +217,7 @@ API Response:
217217
{
218218
"type": "named",
219219
"description": "Mount a volume into the container",
220-
"flag": "--mount",
220+
"name": "--mount",
221221
"value": "type=bind,src={source_path},dst={target_path}",
222222
"is_required": true,
223223
"is_repeated": true,
@@ -238,7 +238,7 @@ API Response:
238238
"package_arguments": [
239239
{
240240
"type": "positional",
241-
"name": "target_dir",
241+
"name_hint": "target_dir",
242242
"value": "/project",
243243
}
244244
]

api/openapi.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -244,13 +244,13 @@ components:
244244
- type: object
245245
required:
246246
- type
247-
- name
247+
- name_hint
248248
properties:
249249
type:
250250
type: string
251251
enum: [positional]
252252
example: "positional"
253-
name:
253+
name_hint:
254254
type: string
255255
description: Name of the positional argument. This is not part of the command line, but can be used for reference by client configuration and used to hint users.
256256
example: file_path
@@ -266,13 +266,13 @@ components:
266266
- type: object
267267
required:
268268
- type
269-
- flag
269+
- name
270270
properties:
271271
type:
272272
type: string
273273
enum: [named]
274274
example: "named"
275-
flag:
275+
name:
276276
type: string
277277
example: "--port"
278278
is_repeated:
@@ -287,7 +287,7 @@ components:
287287
required:
288288
- name
289289
properties:
290-
key:
290+
name:
291291
type: string
292292
description: Name of the header or environment variable.
293293
example: SOME_VARIABLE

0 commit comments

Comments
 (0)