make positional name->name_hint, keep name for kv and flags

This commit is contained in:
Connor Peet 2025-05-13 10:20:17 -07:00
commit 3d695c391e
2 changed files with 13 additions and 13 deletions

View file

@ -68,7 +68,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
"package_arguments": [ "package_arguments": [
{ {
"type": "positional", "type": "positional",
"name": "target_dir", "name_hint": "target_dir",
"description": "Path to access", "description": "Path to access",
"default": "/Users/username/Desktop", "default": "/Users/username/Desktop",
"is_required": true, "is_required": true,
@ -77,7 +77,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
], ],
"environment_variables": [ "environment_variables": [
{ {
"key": "LOG_LEVEL", "name": "LOG_LEVEL",
"description": "Logging level (debug, info, warn, error)", "description": "Logging level (debug, info, warn, error)",
"default": "info" "default": "info"
} }
@ -91,7 +91,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
{ {
"type": "named", "type": "named",
"description": "Mount a volume into the container", "description": "Mount a volume into the container",
"flag": "--mount", "name": "--mount",
"value": "type=bind,src={source_path},dst={target_path}", "value": "type=bind,src={source_path},dst={target_path}",
"is_required": true, "is_required": true,
"is_repeated": true, "is_repeated": true,
@ -112,13 +112,13 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
"package_arguments": [ "package_arguments": [
{ {
"type": "positional", "type": "positional",
"name": "target_dir", "name_hint": "target_dir",
"value": "/project", "value": "/project",
} }
], ],
"environment_variables": [ "environment_variables": [
{ {
"key": "LOG_LEVEL", "name": "LOG_LEVEL",
"description": "Logging level (debug, info, warn, error)", "description": "Logging level (debug, info, warn, error)",
"default": "info" "default": "info"
} }
@ -162,7 +162,7 @@ API Response:
"version": "1.0.2", "version": "1.0.2",
"environment_variables": [ "environment_variables": [
{ {
"key": "BRAVE_API_KEY", "name": "BRAVE_API_KEY",
"description": "Brave Search API Key", "description": "Brave Search API Key",
"is_required": true, "is_required": true,
"is_secret": true "is_secret": true
@ -217,7 +217,7 @@ API Response:
{ {
"type": "named", "type": "named",
"description": "Mount a volume into the container", "description": "Mount a volume into the container",
"flag": "--mount", "name": "--mount",
"value": "type=bind,src={source_path},dst={target_path}", "value": "type=bind,src={source_path},dst={target_path}",
"is_required": true, "is_required": true,
"is_repeated": true, "is_repeated": true,
@ -238,7 +238,7 @@ API Response:
"package_arguments": [ "package_arguments": [
{ {
"type": "positional", "type": "positional",
"name": "target_dir", "name_hint": "target_dir",
"value": "/project", "value": "/project",
} }
] ]

View file

@ -244,13 +244,13 @@ components:
- type: object - type: object
required: required:
- type - type
- name - name_hint
properties: properties:
type: type:
type: string type: string
enum: [positional] enum: [positional]
example: "positional" example: "positional"
name: name_hint:
type: string type: string
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. 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.
example: file_path example: file_path
@ -266,13 +266,13 @@ components:
- type: object - type: object
required: required:
- type - type
- flag - name
properties: properties:
type: type:
type: string type: string
enum: [named] enum: [named]
example: "named" example: "named"
flag: name:
type: string type: string
example: "--port" example: "--port"
is_repeated: is_repeated:
@ -287,7 +287,7 @@ components:
required: required:
- name - name
properties: properties:
key: name:
type: string type: string
description: Name of the header or environment variable. description: Name of the header or environment variable.
example: SOME_VARIABLE example: SOME_VARIABLE