is_repeated tweaks, name positional args, template properties->variables
This commit is contained in:
parent
11d34ed1e8
commit
41fd5ab4d5
2 changed files with 23 additions and 9 deletions
|
|
@ -68,6 +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",
|
||||||
"description": "Path to access",
|
"description": "Path to access",
|
||||||
"default": "/Users/username/Desktop",
|
"default": "/Users/username/Desktop",
|
||||||
"is_required": true,
|
"is_required": true,
|
||||||
|
|
@ -94,7 +95,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
|
||||||
"template": "--mount=type=bind,src={source_path},dst={target_path}",
|
"template": "--mount=type=bind,src={source_path},dst={target_path}",
|
||||||
"is_required": true,
|
"is_required": true,
|
||||||
"is_repeated": true,
|
"is_repeated": true,
|
||||||
"properties": {
|
"variables": {
|
||||||
"source_path": {
|
"source_path": {
|
||||||
"description": "Source path on host",
|
"description": "Source path on host",
|
||||||
"format": "filepath",
|
"format": "filepath",
|
||||||
|
|
@ -111,6 +112,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
|
||||||
"package_arguments": [
|
"package_arguments": [
|
||||||
{
|
{
|
||||||
"type": "positional",
|
"type": "positional",
|
||||||
|
"name": "target_dir",
|
||||||
"value": "/project",
|
"value": "/project",
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
@ -220,7 +222,7 @@ API Response:
|
||||||
"template": "--mount=type=bind,src={source_path},dst={target_path}",
|
"template": "--mount=type=bind,src={source_path},dst={target_path}",
|
||||||
"is_required": true,
|
"is_required": true,
|
||||||
"is_repeated": true,
|
"is_repeated": true,
|
||||||
"properties": {
|
"variables": {
|
||||||
"source_path": {
|
"source_path": {
|
||||||
"description": "Source path on host",
|
"description": "Source path on host",
|
||||||
"format": "filepath",
|
"format": "filepath",
|
||||||
|
|
@ -237,6 +239,7 @@ API Response:
|
||||||
"package_arguments": [
|
"package_arguments": [
|
||||||
{
|
{
|
||||||
"type": "positional",
|
"type": "positional",
|
||||||
|
"name": "target_dir",
|
||||||
"value": "/project",
|
"value": "/project",
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
|
||||||
|
|
@ -206,10 +206,6 @@ components:
|
||||||
is_required:
|
is_required:
|
||||||
type: boolean
|
type: boolean
|
||||||
default: false
|
default: false
|
||||||
is_repeated:
|
|
||||||
type: boolean
|
|
||||||
description: Whether the input can be repeated multiple times in the command line.
|
|
||||||
default: false
|
|
||||||
format:
|
format:
|
||||||
type: string
|
type: string
|
||||||
description: Input format. Includes a variety of standardized formats, including `filepath`, which should be interpreted as a file on the user's filesystem.
|
description: Input format. Includes a variety of standardized formats, including `filepath`, which should be interpreted as a file on the user's filesystem.
|
||||||
|
|
@ -239,11 +235,20 @@ components:
|
||||||
- type: object
|
- type: object
|
||||||
required:
|
required:
|
||||||
- type
|
- type
|
||||||
|
- name
|
||||||
properties:
|
properties:
|
||||||
type:
|
type:
|
||||||
type: string
|
type: string
|
||||||
enum: [positional]
|
enum: [positional]
|
||||||
example: "positional"
|
example: "positional"
|
||||||
|
name:
|
||||||
|
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.
|
||||||
|
example: file_path
|
||||||
|
is_repeated:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the input can be repeated multiple times in the command line.
|
||||||
|
default: false
|
||||||
|
|
||||||
NamedInput:
|
NamedInput:
|
||||||
description: A command-line `--flag={value}`, named environment variable or header.
|
description: A command-line `--flag={value}`, named environment variable or header.
|
||||||
|
|
@ -261,6 +266,10 @@ components:
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
example: "--port"
|
example: "--port"
|
||||||
|
is_repeated:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the argument or header can be repeated multiple times. Has no effect for environment variables.
|
||||||
|
default: false
|
||||||
|
|
||||||
TemplateInput:
|
TemplateInput:
|
||||||
- type: object
|
- type: object
|
||||||
|
|
@ -281,14 +290,16 @@ components:
|
||||||
type: string
|
type: string
|
||||||
is_required:
|
is_required:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
default: false
|
||||||
is_repeated:
|
is_repeated:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: Whether the input can be repeated multiple times in the command line.
|
description: Whether the argument or header can be repeated multiple times. Has no effect for environment variables.
|
||||||
|
default: false
|
||||||
template:
|
template:
|
||||||
type: string
|
type: string
|
||||||
description: The template string that will be used to generate the value. Values wrapped in `{curly_braces}` will be replaced with the corresponding properties. Input which is not `is_required` is replaced with its `default` value, or otherwise an empty string.
|
description: The template string that will be used to generate the value. Values wrapped in `{curly_braces}` will be replaced with the corresponding variables. Input which is not `is_required` is replaced with its `default` value, or otherwise an empty string.
|
||||||
example: "--mount=type=bind,src={host_path},dst={container_path}"
|
example: "--mount=type=bind,src={host_path},dst={container_path}"
|
||||||
properties:
|
variables:
|
||||||
type: object
|
type: object
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
$ref: '#/components/schemas/UserInput'
|
$ref: '#/components/schemas/UserInput'
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue