is_repeated tweaks, name positional args, template properties->variables

Author: connor4312

api/README.md

@@ -68,6 +68,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
       "package_arguments": [
         {
           "type": "positional",
+          "name": "target_dir",
           "description": "Path to access",
           "default": "/Users/username/Desktop",
           "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}",
           "is_required": true,
           "is_repeated": true,
-          "properties": {
+          "variables": {
             "source_path": {
               "description": "Source path on host",
               "format": "filepath",
@@ -111,6 +112,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
       "package_arguments": [
         {
           "type": "positional",
+          "name": "target_dir",
           "value": "/project",
         }
       ]
@@ -220,7 +222,7 @@ API Response:
           "template": "--mount=type=bind,src={source_path},dst={target_path}",
           "is_required": true,
           "is_repeated": true,
-          "properties": {
+          "variables": {
             "source_path": {
               "description": "Source path on host",
               "format": "filepath",
@@ -237,6 +239,7 @@ API Response:
       "package_arguments": [
         {
           "type": "positional",
+          "name": "target_dir",
           "value": "/project",
         }
       ]

api/openapi.yaml

@@ -206,10 +206,6 @@ components:
         is_required:
           type: boolean
           default: false
-        is_repeated:
-          type: boolean
-          description: Whether the input can be repeated multiple times in the command line.
-          default: false
         format:
           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.
@@ -239,11 +235,20 @@ components:
         - type: object
           required:
             - type
+            - name
           properties:
             type:
               type: string
               enum: [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:
       description: A command-line `--flag={value}`, named environment variable or header.
@@ -261,6 +266,10 @@ components:
             name:
               type: string
               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:
       - type: object
@@ -281,14 +290,16 @@ components:
             type: string
           is_required:
             type: boolean
+            default: false
           is_repeated:
             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:
             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}"
-          properties:
+          variables:
             type: object
             additionalProperties:
               $ref: '#/components/schemas/UserInput'