From 3d695c391e49fb908aef162a3a2b497b073fb4a5 Mon Sep 17 00:00:00 2001
From: Connor Peet <connor@peet.io>
Date: Tue, 13 May 2025 10:20:17 -0700
Subject: [PATCH] make positional name->name_hint, keep name for kv and flags

---
 api/README.md    | 16 ++++++++--------
 api/openapi.yaml | 10 +++++-----
 2 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/api/README.md b/api/README.md
index 1a6f0fb..cbd6aac 100644
--- a/api/README.md
+++ b/api/README.md
@@ -68,7 +68,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
       "package_arguments": [
         {
           "type": "positional",
-          "name": "target_dir",
+          "name_hint": "target_dir",
           "description": "Path to access",
           "default": "/Users/username/Desktop",
           "is_required": true,
@@ -77,7 +77,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
       ],
       "environment_variables": [
         {
-          "key": "LOG_LEVEL",
+          "name": "LOG_LEVEL",
           "description": "Logging level (debug, info, warn, error)",
           "default": "info"
         }
@@ -91,7 +91,7 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
         {
           "type": "named",
           "description": "Mount a volume into the container",
-          "flag": "--mount",
+          "name": "--mount",
           "value": "type=bind,src={source_path},dst={target_path}",
           "is_required": true,
           "is_repeated": true,
@@ -112,13 +112,13 @@ GET /v0/servers/a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1?version=0.0.3
       "package_arguments": [
         {
           "type": "positional",
-          "name": "target_dir",
+          "name_hint": "target_dir",
           "value": "/project",
         }
       ],
       "environment_variables": [
         {
-          "key": "LOG_LEVEL",
+          "name": "LOG_LEVEL",
           "description": "Logging level (debug, info, warn, error)",
           "default": "info"
         }
@@ -162,7 +162,7 @@ API Response:
       "version": "1.0.2",
       "environment_variables": [
         {
-          "key": "BRAVE_API_KEY",
+          "name": "BRAVE_API_KEY",
           "description": "Brave Search API Key",
           "is_required": true,
           "is_secret": true
@@ -217,7 +217,7 @@ API Response:
         {
           "type": "named",
           "description": "Mount a volume into the container",
-          "flag": "--mount",
+          "name": "--mount",
           "value": "type=bind,src={source_path},dst={target_path}",
           "is_required": true,
           "is_repeated": true,
@@ -238,7 +238,7 @@ API Response:
       "package_arguments": [
         {
           "type": "positional",
-          "name": "target_dir",
+          "name_hint": "target_dir",
           "value": "/project",
         }
       ]
diff --git a/api/openapi.yaml b/api/openapi.yaml
index b3e18c8..3658cd0 100644
--- a/api/openapi.yaml
+++ b/api/openapi.yaml
@@ -244,13 +244,13 @@ components:
         - type: object
           required:
             - type
-            - name
+            - name_hint
           properties:
             type:
               type: string
               enum: [positional]
               example: "positional"
-            name:
+            name_hint:
               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.
               example: file_path
@@ -266,13 +266,13 @@ components:
         - type: object
           required:
             - type
-            - flag
+            - name
           properties:
             type:
               type: string
               enum: [named]
               example: "named"
-            flag:
+            name:
               type: string
               example: "--port"
             is_repeated:
@@ -287,7 +287,7 @@ components:
           required:
             - name
           properties:
-            key:
+            name:
               type: string
               description: Name of the header or environment variable.
               example: SOME_VARIABLE