@ellipsis-dev/sdk 0.10.0 → 0.11.0

package/schema/openapi.v1.json

@@ -1083,6 +1083,16 @@
           "file": {
             "title": "File",
             "type": "string"
+          },
+          "repository": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/AgentConfigRepository"
+              },
+              {
+                "type": "null"
+              }
+            ]
           }
         },
         "required": [
@@ -1974,6 +1984,10 @@
             "description": "The last commit the config was synced from.",
             "title": "Last Synced Commit Sha"
           },
+          "managed_by": {
+            "$ref": "#/components/schemas/ConfigManagedBy",
+            "description": "Which writer owns this agent. \"github\" agents are defined by a file in a repository and are changed by editing that file; \"api\" agents have no file and are changed through this API."
+          },
           "name": {
             "anyOf": [
               {
@@ -2015,11 +2029,21 @@
           "sha",
           "created_at",
           "updated_at",
+          "managed_by",
           "agent_config"
         ],
         "title": "Config",
         "type": "object"
       },
+      "ConfigManagedBy": {
+        "description": "Which writer owns an agent: the repository file it is defined in, or\nthis API. Every agent has exactly one owner, fixed when it is created and\nchanged only by linking or unlinking it.",
+        "enum": [
+          "github",
+          "api"
+        ],
+        "title": "ConfigManagedBy",
+        "type": "string"
+      },
       "ContributorUsage": {
         "description": "An author who merged a pull request in the window. The pull-request and\nline counts cover their merged pull requests; `reviews` counts reviews this\nperson also submitted.",
         "properties": {
@@ -2079,7 +2103,7 @@
         "type": "object"
       },
       "CreateAgentConfigRequest": {
-        "description": "Parameters for creating an agent config via a pull request. Exactly\none of config or template_id must be set.",
+        "description": "Parameters for creating an agent config. Exactly one of config or\ntemplate_id must be set.",
         "properties": {
           "config": {
             "anyOf": [
@@ -2101,13 +2125,20 @@
                 "type": "null"
               }
             ],
-            "description": "File path within the repo. Omit for the default agents/<slug>.yaml; if set it must be a location the config sync scans (a .yaml/.yml file under agents/, .agents/, ellipsis/, or .ellipsis/ at any depth).",
+            "description": "File path within the repo, when a repository is named. Omit for the default agents/<slug>.yaml; if set it must be a location the config sync scans (a .yaml/.yml file under agents/, .agents/, ellipsis/, or .ellipsis/ at any depth).",
             "title": "Path"
           },
           "repository": {
-            "description": "Target repository name within the caller's account; the owner is always the account, so pass a bare name (e.g. \"my-service\"), not \"owner/my-service\".",
-            "title": "Repository",
-            "type": "string"
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "Define the agent as a file in this repository: Ellipsis opens a pull request adding it, and the agent goes live when that merges. Repository name within the caller's account; the owner is always the account, so pass a bare name (e.g. \"my-service\"), not \"owner/my-service\". Omit to create the agent through the API alone, with no file and live immediately.",
+            "title": "Repository"
           },
           "template_id": {
             "anyOf": [
@@ -2122,34 +2153,43 @@
             "title": "Template Id"
           }
         },
-        "required": [
-          "repository"
-        ],
         "title": "CreateAgentConfigRequest",
         "type": "object"
       },
       "CreateAgentConfigResponse": {
-        "description": "The created agent config and the pull request that adds its file.",
+        "description": "The created agent config, plus the pull request that adds its file when\none was opened.",
         "properties": {
           "config": {
             "$ref": "#/components/schemas/Config",
             "description": "The created agent config."
           },
           "path": {
-            "description": "The file path the config was written to.",
-            "title": "Path",
-            "type": "string"
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "The file path the config was written to, or null when the agent has no file.",
+            "title": "Path"
           },
           "pull_request_url": {
-            "description": "The pull request that adds the config file. The agent becomes live once it merges and syncs.",
-            "title": "Pull Request Url",
-            "type": "string"
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "The pull request that adds the config file. The agent becomes live once it merges and syncs. Null when no repository was named: the agent is already live.",
+            "title": "Pull Request Url"
           }
         },
         "required": [
-          "config",
-          "path",
-          "pull_request_url"
+          "config"
         ],
         "title": "CreateAgentConfigResponse",
         "type": "object"
@@ -3846,6 +3886,59 @@
         "title": "LinearTeamsListResponse",
         "type": "object"
       },
+      "LinkAgentConfigRequest": {
+        "description": "Where to put the config file of an agent being moved into a repository.",
+        "properties": {
+          "path": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "File path within the repo. Omit for the default agents/<slug>.yaml; if set it must be a location the config sync scans (a .yaml/.yml file under agents/, .agents/, ellipsis/, or .ellipsis/ at any depth).",
+            "title": "Path"
+          },
+          "repository": {
+            "description": "Repository name within the caller's account; the owner is always the account, so pass a bare name (e.g. \"my-service\"), not \"owner/my-service\".",
+            "title": "Repository",
+            "type": "string"
+          }
+        },
+        "required": [
+          "repository"
+        ],
+        "title": "LinkAgentConfigRequest",
+        "type": "object"
+      },
+      "LinkAgentConfigResponse": {
+        "description": "The agent and the pull request that would put it in a repository.",
+        "properties": {
+          "config": {
+            "$ref": "#/components/schemas/Config",
+            "description": "The agent, still managed through the API until the pull request merges."
+          },
+          "path": {
+            "description": "The file path the config will be written to.",
+            "title": "Path",
+            "type": "string"
+          },
+          "pull_request_url": {
+            "description": "The pull request that adds the config file. The agent becomes managed by that file once it merges.",
+            "title": "Pull Request Url",
+            "type": "string"
+          }
+        },
+        "required": [
+          "config",
+          "path",
+          "pull_request_url"
+        ],
+        "title": "LinkAgentConfigResponse",
+        "type": "object"
+      },
       "LinkedGithubIdentity": {
         "description": "The GitHub identity linked to a Slack member.",
         "properties": {
@@ -8675,6 +8768,20 @@
         "title": "TranscriptIngestResult",
         "type": "object"
       },
+      "UpdateAgentConfigRequest": {
+        "description": "A replacement definition for an agent managed through the API.",
+        "properties": {
+          "config": {
+            "$ref": "#/components/schemas/AgentConfig",
+            "description": "The agent's new definition. Replaces the previous one wholesale \u2014 this is not a partial update."
+          }
+        },
+        "required": [
+          "config"
+        ],
+        "title": "UpdateAgentConfigRequest",
+        "type": "object"
+      },
       "UsageDailyPoint": {
         "description": "One day's usage: tokens split by type, and cost split into the four\nbilled categories. `tokens` is the sum of the four token types.",
         "properties": {
@@ -8996,7 +9103,7 @@
         "x-ellipsis-sdk-method": "agents.configs.list"
       },
       "post": {
-        "description": "Create an agent config via pull request.\n\nThe PR adds the config file to agents/ on the target\nrepository; the agent goes live when it merges.\n\nAccepts an inline config or a gallery template slug. 409 when\nanother live agent already holds the name.",
+        "description": "Create an agent config.\n\nName a repository and Ellipsis opens a pull request adding the\nconfig file to agents/ there; the agent goes live when it\nmerges. Omit it and the agent is created here, with no file,\nlive immediately \u2014 and every file reference in it must name the\nrepository it lives in.\n\nAccepts an inline config or a gallery template slug. 409 when\nanother live agent already holds the name.",
         "operationId": "create_agent_config",
         "parameters": [
           {
@@ -9095,7 +9202,7 @@
                 }
               }
             },
-            "description": "The agent's name contains no usable characters."
+            "description": "The agent's name contains no usable characters, or a file reference names no repository."
           }
         },
         "security": [
@@ -9111,6 +9218,102 @@
       }
     },
     "/agents/configs/{config_id}": {
+      "delete": {
+        "description": "Delete an agent, by id or by the agent's name.\n\nThe agent stops running and its name is freed immediately; its\npast sessions remain readable. Only for agents managed through\nthis API \u2014 delete the file to remove one defined by a\nrepository.",
+        "operationId": "delete_agent_config",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "config_id",
+            "required": true,
+            "schema": {
+              "title": "Config Id",
+              "type": "string"
+            }
+          },
+          {
+            "in": "header",
+            "name": "user-agent",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "User-Agent"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Successful Response"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The bearer token is missing, invalid, or revoked."
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The credential may not perform this action, or the account is blocked."
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "No such config in your account."
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The agent is defined by a file in a repository; delete that file instead."
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            },
+            "description": "Validation Error"
+          }
+        },
+        "security": [
+          {
+            "HTTPBearer": []
+          }
+        ],
+        "summary": "Delete Agent Config",
+        "tags": [
+          "v1"
+        ],
+        "x-ellipsis-sdk-method": "agents.configs.delete"
+      },
       "get": {
         "description": "Return one saved agent config, by id or by the agent's name.",
         "operationId": "get_agent_config",
@@ -9203,6 +9406,359 @@
           "v1"
         ],
         "x-ellipsis-sdk-method": "agents.configs.get"
+      },
+      "put": {
+        "description": "Replace an agent's definition, by id or by the agent's name.\n\nThe whole definition is replaced, and the change is live at\nonce. Only for agents managed through this API: one defined by a\nrepository file is a 409, since the next push to that file would\nrevert the change \u2014 unlink it first to take ownership.",
+        "operationId": "update_agent_config",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "config_id",
+            "required": true,
+            "schema": {
+              "title": "Config Id",
+              "type": "string"
+            }
+          },
+          {
+            "in": "header",
+            "name": "user-agent",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "User-Agent"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateAgentConfigRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AgentConfigResponse"
+                }
+              }
+            },
+            "description": "Successful Response"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The config is invalid (for example an unschedulable cron expression)."
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The bearer token is missing, invalid, or revoked."
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The credential may not perform this action, or the account is blocked."
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "No such config in your account."
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The agent is defined by a file in a repository, or another live agent already holds the new name."
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The agent's name is missing or malformed, or a file reference names no repository."
+          }
+        },
+        "security": [
+          {
+            "HTTPBearer": []
+          }
+        ],
+        "summary": "Update Agent Config",
+        "tags": [
+          "v1"
+        ],
+        "x-ellipsis-sdk-method": "agents.configs.update"
+      }
+    },
+    "/agents/configs/{config_id}/link": {
+      "post": {
+        "description": "Move an agent into a repository, by id or by the agent's name.\n\nOpens a pull request adding the agent's config file. The agent\nkeeps running unchanged meanwhile; merging hands it over to the\nfile, after which the file is what changes it. Nothing happens\nif the pull request is never merged.",
+        "operationId": "link_agent_config",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "config_id",
+            "required": true,
+            "schema": {
+              "title": "Config Id",
+              "type": "string"
+            }
+          },
+          {
+            "in": "header",
+            "name": "user-agent",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "User-Agent"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/LinkAgentConfigRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/LinkAgentConfigResponse"
+                }
+              }
+            },
+            "description": "Successful Response"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The path is not a synced config location, or the repository has no commits."
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The bearer token is missing, invalid, or revoked."
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The credential may not perform this action, or the account is blocked."
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The config or repository was not found in your account."
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The agent is already defined by a file, a link is already open for it, a file already exists at that path, or another agent syncs from it."
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "GitHub rejected the pull request."
+          }
+        },
+        "security": [
+          {
+            "HTTPBearer": []
+          }
+        ],
+        "summary": "Link Agent Config",
+        "tags": [
+          "v1"
+        ],
+        "x-ellipsis-sdk-method": "agents.configs.link"
+      }
+    },
+    "/agents/configs/{config_id}/unlink": {
+      "post": {
+        "description": "Take over an agent from its file, by id or by the agent's name.\n\nThe file stops governing the agent immediately and further\nchanges go through this API. The file is left in place, inert \u2014\ndelete it whenever you like.",
+        "operationId": "unlink_agent_config",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "config_id",
+            "required": true,
+            "schema": {
+              "title": "Config Id",
+              "type": "string"
+            }
+          },
+          {
+            "in": "header",
+            "name": "user-agent",
+            "required": false,
+            "schema": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "title": "User-Agent"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AgentConfigResponse"
+                }
+              }
+            },
+            "description": "Successful Response"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The bearer token is missing, invalid, or revoked."
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The credential may not perform this action, or the account is blocked."
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "No such config in your account."
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The agent is already managed through the API."
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "The config has a file reference that names no repository, so it cannot resolve without its source repository."
+          }
+        },
+        "security": [
+          {
+            "HTTPBearer": []
+          }
+        ],
+        "summary": "Unlink Agent Config",
+        "tags": [
+          "v1"
+        ],
+        "x-ellipsis-sdk-method": "agents.configs.unlink"
       }
     },
     "/agents/defaults": {