@usestatemachines/sdk 0.7.1 → 0.8.1

package/openapi.json

@@ -20,67 +20,6 @@
         "required": ["id", "name", "summary"],
         "type": "object"
       },
-      "Api": {
-        "properties": {
-          "actorHeader": {
-            "maxLength": 200,
-            "type": "string"
-          },
-          "actorVariable": {
-            "maxLength": 200,
-            "type": "string"
-          },
-          "apiVersions": {
-            "items": {
-              "maxLength": 32,
-              "type": "string"
-            },
-            "maxItems": 200,
-            "type": "array"
-          },
-          "id": {
-            "maxLength": 64,
-            "minLength": 1,
-            "type": "string"
-          },
-          "interactive": {
-            "type": "boolean"
-          },
-          "limitations": {
-            "items": {
-              "maxLength": 500,
-              "type": "string"
-            },
-            "maxItems": 50,
-            "type": "array"
-          },
-          "name": {
-            "maxLength": 120,
-            "minLength": 1,
-            "type": "string"
-          },
-          "pathTemplate": {
-            "maxLength": 500,
-            "type": "string"
-          },
-          "requestContentType": {
-            "maxLength": 200,
-            "type": "string"
-          }
-        },
-        "required": [
-          "id",
-          "name",
-          "apiVersions",
-          "pathTemplate",
-          "requestContentType",
-          "actorHeader",
-          "actorVariable",
-          "limitations",
-          "interactive"
-        ],
-        "type": "object"
-      },
       "App": {
         "properties": {
           "defaultVersionId": {
@@ -119,6 +58,17 @@
         ],
         "type": "object"
       },
+      "AppEntry": {
+        "anyOf": [
+          {
+            "pattern": "^[a-z][a-z0-9-]{1,39}$",
+            "type": "string"
+          },
+          {
+            "$ref": "#/components/schemas/CreateEnvironmentApp"
+          }
+        ]
+      },
       "AuditEvent": {
         "properties": {
           "data": {
@@ -207,31 +157,7 @@
         "properties": {
           "apps": {
             "items": {
-              "anyOf": [
-                {
-                  "pattern": "^[a-z][a-z0-9-]{1,39}$",
-                  "type": "string"
-                },
-                {
-                  "additionalProperties": false,
-                  "properties": {
-                    "app": {
-                      "pattern": "^[a-z][a-z0-9-]{1,39}$",
-                      "type": "string"
-                    },
-                    "name": {
-                      "pattern": "^[a-z][a-z0-9-]{0,39}$",
-                      "type": "string"
-                    },
-                    "settings": {
-                      "additionalProperties": {},
-                      "type": "object"
-                    }
-                  },
-                  "required": ["app"],
-                  "type": "object"
-                }
-              ]
+              "$ref": "#/components/schemas/AppEntry"
             },
             "maxItems": 10,
             "minItems": 1,
@@ -270,12 +196,140 @@
         },
         "type": "object"
       },
+      "CreateEnvironmentApp": {
+        "additionalProperties": false,
+        "properties": {
+          "appId": {
+            "pattern": "^[a-z][a-z0-9-]{1,39}$",
+            "type": "string"
+          },
+          "name": {
+            "pattern": "^[a-z][a-z0-9-]{0,39}$",
+            "type": "string"
+          },
+          "services": {
+            "additionalProperties": {},
+            "type": "object"
+          },
+          "setup": {
+            "additionalProperties": {},
+            "type": "object"
+          }
+        },
+        "required": ["appId"],
+        "type": "object"
+      },
+      "Credential": {
+        "oneOf": [
+          {
+            "properties": {
+              "apiKeyKind": {
+                "type": "null"
+              },
+              "expiresAt": {
+                "format": "date-time",
+                "type": "string"
+              },
+              "id": {
+                "type": "string"
+              },
+              "idleExpiresAt": {
+                "type": "null"
+              },
+              "kind": {
+                "enum": ["session"],
+                "type": "string"
+              },
+              "name": {
+                "type": "null"
+              }
+            },
+            "required": [
+              "kind",
+              "id",
+              "name",
+              "expiresAt",
+              "idleExpiresAt",
+              "apiKeyKind"
+            ],
+            "type": "object"
+          },
+          {
+            "properties": {
+              "apiKeyKind": {
+                "type": "null"
+              },
+              "expiresAt": {
+                "format": "date-time",
+                "type": "string"
+              },
+              "id": {
+                "type": "string"
+              },
+              "idleExpiresAt": {
+                "format": "date-time",
+                "type": "string"
+              },
+              "kind": {
+                "enum": ["cli_token"],
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "kind",
+              "id",
+              "name",
+              "expiresAt",
+              "idleExpiresAt",
+              "apiKeyKind"
+            ],
+            "type": "object"
+          },
+          {
+            "properties": {
+              "apiKeyKind": {
+                "enum": ["dashboard", "cli_run", "env_pull"],
+                "type": "string"
+              },
+              "expiresAt": {
+                "format": "date-time",
+                "type": ["string", "null"]
+              },
+              "id": {
+                "type": "string"
+              },
+              "idleExpiresAt": {
+                "type": "null"
+              },
+              "kind": {
+                "enum": ["api_key"],
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "kind",
+              "id",
+              "name",
+              "expiresAt",
+              "idleExpiresAt",
+              "apiKeyKind"
+            ],
+            "type": "object"
+          }
+        ]
+      },
       "Credentials": {
         "properties": {
           "actorId": {
             "type": "string"
           },
-          "app": {
+          "appName": {
             "pattern": "^[a-z][a-z0-9-]{0,39}$",
             "type": "string"
           },
@@ -287,12 +341,6 @@
             "format": "date-time",
             "type": "string"
           },
-          "headers": {
-            "additionalProperties": {
-              "type": "string"
-            },
-            "type": "object"
-          },
           "login": {
             "properties": {
               "authentication": {
@@ -317,20 +365,55 @@
             "required": ["authentication", "url", "parameters", "secrets"],
             "type": ["object", "null"]
           },
-          "token": {
-            "type": "string"
+          "services": {
+            "items": {
+              "properties": {
+                "headers": {
+                  "additionalProperties": {
+                    "type": "string"
+                  },
+                  "type": "object"
+                },
+                "id": {
+                  "pattern": "^[a-z][a-z0-9-]{0,39}$",
+                  "type": "string"
+                },
+                "servers": {
+                  "items": {
+                    "properties": {
+                      "name": {
+                        "type": "string"
+                      },
+                      "url": {
+                        "description": "The MCP server's URL. On an environment created with `tokenInUrl`, a request with no `Authorization` header acts as the actor that this call picks when you send no `actorId`. To act as `actorId`, send the service's headers.",
+                        "type": "string"
+                      }
+                    },
+                    "required": ["name", "url"],
+                    "type": "object"
+                  },
+                  "type": "array"
+                },
+                "url": {
+                  "description": "The URL where the service's paths start: the app URL followed by the service's path. The `url` of the service at `/` is the app URL itself. On an environment created with `tokenInUrl`, the app URL is in its token form. A client of a service that serves MCP servers calls the URL of one of its MCP servers instead.",
+                  "type": "string"
+                }
+              },
+              "required": ["id", "url", "headers"],
+              "type": "object"
+            },
+            "type": "array"
           },
-          "url": {
+          "token": {
             "type": "string"
           }
         },
         "required": [
           "environmentId",
-          "app",
+          "appName",
           "actorId",
-          "url",
-          "headers",
           "token",
+          "services",
           "expiresAt",
           "login"
         ],
@@ -348,7 +431,11 @@
                   "pattern": "^[a-z][a-z0-9-]{0,39}$",
                   "type": "string"
                 },
-                "settings": {
+                "services": {
+                  "additionalProperties": {},
+                  "type": "object"
+                },
+                "setup": {
                   "additionalProperties": {},
                   "type": "object"
                 },
@@ -368,7 +455,8 @@
                 "appId",
                 "versionId",
                 "version",
-                "settings",
+                "setup",
+                "services",
                 "url"
               ],
               "type": "object"
@@ -454,7 +542,7 @@
       },
       "EnvironmentFailure": {
         "properties": {
-          "app": {
+          "appName": {
             "type": "string"
           },
           "code": {
@@ -462,7 +550,8 @@
               "start_failed",
               "pause_removed",
               "version_unavailable",
-              "invalid_settings"
+              "invalid_setup",
+              "invalid_services"
             ],
             "type": "string"
           },
@@ -470,7 +559,7 @@
             "type": "string"
           }
         },
-        "required": ["app", "code", "message"],
+        "required": ["appName", "code", "message"],
         "type": ["object", "null"]
       },
       "EnvironmentStatus": {
@@ -498,6 +587,7 @@
                   "body_too_large",
                   "version_unavailable",
                   "environment_limit_reached",
+                  "rate_limited",
                   "internal_error",
                   "unavailable"
                 ],
@@ -529,8 +619,49 @@
         "required": ["error"],
         "type": "object"
       },
+      "McpServer": {
+        "properties": {
+          "name": {
+            "pattern": "^[a-z0-9][a-z0-9/_-]{0,199}$",
+            "type": "string"
+          },
+          "tools": {
+            "items": {
+              "$ref": "#/components/schemas/McpTool"
+            },
+            "maxItems": 500,
+            "type": "array"
+          }
+        },
+        "required": ["name", "tools"],
+        "type": "object"
+      },
+      "McpTool": {
+        "properties": {
+          "description": {
+            "maxLength": 10000,
+            "type": "string"
+          },
+          "name": {
+            "pattern": "^[A-Za-z0-9_.-]{1,128}$",
+            "type": "string"
+          },
+          "title": {
+            "maxLength": 200,
+            "type": "string"
+          },
+          "writes": {
+            "type": "boolean"
+          }
+        },
+        "required": ["name", "description", "writes"],
+        "type": "object"
+      },
       "Me": {
         "properties": {
+          "credential": {
+            "$ref": "#/components/schemas/Credential"
+          },
           "limits": {
             "properties": {
               "concurrentEnvironments": {
@@ -618,6 +749,7 @@
         },
         "required": [
           "principal",
+          "credential",
           "user",
           "organization",
           "organizations",
@@ -675,7 +807,7 @@
       },
       "Request": {
         "properties": {
-          "app": {
+          "appName": {
             "type": "string"
           },
           "completedAt": {
@@ -696,9 +828,16 @@
           "id": {
             "type": "string"
           },
+          "mcpServer": {
+            "description": "The MCP server that the request called, as the app named it. `null` when the gateway answered, when State Machines refused the request before the app read it, or when the request called no MCP server that the environment serves.",
+            "type": ["string", "null"]
+          },
           "method": {
             "type": "string"
           },
+          "operation": {
+            "type": ["string", "null"]
+          },
           "path": {
             "type": "string"
           },
@@ -721,15 +860,25 @@
           },
           "responseStatus": {
             "type": "integer"
+          },
+          "service": {
+            "type": ["string", "null"]
+          },
+          "tool": {
+            "type": ["string", "null"]
           }
         },
         "required": [
           "id",
           "environmentId",
-          "app",
+          "appName",
           "method",
           "path",
           "query",
+          "service",
+          "mcpServer",
+          "tool",
+          "operation",
           "responseStatus",
           "respondedBy",
           "errorCode",
@@ -828,6 +977,22 @@
             "minimum": 0,
             "type": "integer"
           },
+          "services": {
+            "items": {
+              "properties": {
+                "count": {
+                  "exclusiveMinimum": 0,
+                  "type": "integer"
+                },
+                "id": {
+                  "type": "string"
+                }
+              },
+              "required": ["id", "count"],
+              "type": "object"
+            },
+            "type": "array"
+          },
           "successCount": {
             "minimum": 0,
             "type": "integer"
@@ -846,10 +1011,63 @@
           "serverErrorCount",
           "p50Ms",
           "p95Ms",
+          "services",
           "buckets"
         ],
         "type": "object"
       },
+      "Service": {
+        "properties": {
+          "description": {
+            "type": "string"
+          },
+          "id": {
+            "pattern": "^[a-z][a-z0-9-]{0,39}$",
+            "type": "string"
+          },
+          "limitations": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "name": {
+            "type": "string"
+          },
+          "path": {
+            "pattern": "^(?=.{1,500}$)(?:\\/|(?:\\/(?!\\.\\.?(?:\\/|$))[^\\s/%?#{}]+)+)$",
+            "type": "string"
+          },
+          "prompt": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "servers": {
+            "items": {
+              "$ref": "#/components/schemas/McpServer"
+            },
+            "maxItems": 50,
+            "minItems": 1,
+            "type": "array"
+          },
+          "visibility": {
+            "enum": ["public", "preview"],
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "path",
+          "name",
+          "description",
+          "limitations",
+          "visibility",
+          "prompt"
+        ],
+        "type": "object"
+      },
       "Snapshot": {
         "properties": {
           "apps": {
@@ -862,6 +1080,14 @@
                   "pattern": "^[a-z][a-z0-9-]{0,39}$",
                   "type": "string"
                 },
+                "services": {
+                  "additionalProperties": {},
+                  "type": "object"
+                },
+                "setup": {
+                  "additionalProperties": {},
+                  "type": "object"
+                },
                 "sizeBytes": {
                   "type": ["integer", "null"]
                 },
@@ -878,6 +1104,8 @@
                 "appId",
                 "versionId",
                 "version",
+                "setup",
+                "services",
                 "sizeBytes"
               ],
               "type": "object"
@@ -899,6 +1127,9 @@
             "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
             "type": "string"
           },
+          "environmentName": {
+            "type": ["string", "null"]
+          },
           "failure": {
             "properties": {
               "code": {
@@ -938,6 +1169,7 @@
           "id",
           "workspaceId",
           "environmentId",
+          "environmentName",
           "name",
           "status",
           "failure",
@@ -962,12 +1194,6 @@
             },
             "type": "array"
           },
-          "apis": {
-            "items": {
-              "$ref": "#/components/schemas/Api"
-            },
-            "type": "array"
-          },
           "appId": {
             "pattern": "^[a-z][a-z0-9-]{1,39}$",
             "type": "string"
@@ -987,6 +1213,12 @@
             "format": "date-time",
             "type": ["string", "null"]
           },
+          "services": {
+            "items": {
+              "$ref": "#/components/schemas/Service"
+            },
+            "type": "array"
+          },
           "status": {
             "enum": ["published", "retired"],
             "type": "string"
@@ -1001,7 +1233,7 @@
           "version",
           "status",
           "isDefault",
-          "apis",
+          "services",
           "actors",
           "publishedAt",
           "retiredAt"
@@ -1587,6 +1819,32 @@
               "type": "array"
             }
           },
+          {
+            "in": "query",
+            "name": "appId",
+            "required": false,
+            "schema": {
+              "items": {
+                "pattern": "^[a-z][a-z0-9-]{1,39}$",
+                "type": "string"
+              },
+              "maxItems": 20,
+              "type": "array"
+            }
+          },
+          {
+            "in": "query",
+            "name": "createdBy",
+            "required": false,
+            "schema": {
+              "items": {
+                "pattern": "^(user_[0-9A-Za-z]+|key_[0-9a-z]{16})$",
+                "type": "string"
+              },
+              "maxItems": 50,
+              "type": "array"
+            }
+          },
           {
             "in": "query",
             "name": "snapshotId",
@@ -1640,7 +1898,7 @@
                 }
               }
             },
-            "description": "The workspace's environments, newest first"
+            "description": "The workspace's environments, newest created first"
           },
           "400": {
             "content": {
@@ -1903,6 +2161,148 @@
         ]
       }
     },
+    "/v1/environments/creators": {
+      "get": {
+        "operationId": "listEnvironmentCreators",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "workspaceId",
+            "required": false,
+            "schema": {
+              "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "properties": {
+                    "data": {
+                      "items": {
+                        "$ref": "#/components/schemas/Principal"
+                      },
+                      "type": "array"
+                    }
+                  },
+                  "required": ["data"],
+                  "type": "object"
+                }
+              }
+            },
+            "description": "Each principal that created an environment in the workspace, by name"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Invalid request"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Authentication required"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Permission denied"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Resource not found"
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Conflicting request"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Request body too large"
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Version unavailable"
+          },
+          "429": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Limit reached"
+          },
+          "500": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Unexpected failure"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            },
+            "description": "Dependency unavailable"
+          }
+        },
+        "security": [
+          {
+            "bearerAuth": []
+          }
+        ]
+      }
+    },
     "/v1/environments/{environmentId}": {
       "delete": {
         "operationId": "deleteEnvironment",
@@ -2365,6 +2765,14 @@
                     "maxLength": 255,
                     "minLength": 1,
                     "type": "string"
+                  },
+                  "services": {
+                    "items": {
+                      "pattern": "^[a-z][a-z0-9-]{0,39}$",
+                      "type": "string"
+                    },
+                    "maxItems": 20,
+                    "type": "array"
                   }
                 },
                 "type": "object"
@@ -2649,7 +3057,7 @@
           },
           {
             "in": "query",
-            "name": "app",
+            "name": "appName",
             "required": false,
             "schema": {
               "pattern": "^[a-z][a-z0-9-]{0,39}$",
@@ -2702,6 +3110,42 @@
               "type": "boolean"
             }
           },
+          {
+            "in": "query",
+            "name": "service",
+            "required": false,
+            "schema": {
+              "pattern": "^[a-z][a-z0-9-]{0,39}$",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "mcpServer",
+            "required": false,
+            "schema": {
+              "pattern": "^[a-z0-9][a-z0-9/_-]{0,199}$",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "tool",
+            "required": false,
+            "schema": {
+              "pattern": "^[A-Za-z0-9_.-]{1,128}$",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "operation",
+            "required": false,
+            "schema": {
+              "pattern": "^[A-Za-z0-9_.-]{1,128}$",
+              "type": "string"
+            }
+          },
           {
             "in": "query",
             "name": "search",
@@ -2877,7 +3321,7 @@
           },
           {
             "in": "query",
-            "name": "app",
+            "name": "appName",
             "required": false,
             "schema": {
               "pattern": "^[a-z][a-z0-9-]{0,39}$",
@@ -2930,6 +3374,42 @@
               "type": "boolean"
             }
           },
+          {
+            "in": "query",
+            "name": "service",
+            "required": false,
+            "schema": {
+              "pattern": "^[a-z][a-z0-9-]{0,39}$",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "mcpServer",
+            "required": false,
+            "schema": {
+              "pattern": "^[a-z0-9][a-z0-9/_-]{0,199}$",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "tool",
+            "required": false,
+            "schema": {
+              "pattern": "^[A-Za-z0-9_.-]{1,128}$",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "operation",
+            "required": false,
+            "schema": {
+              "pattern": "^[A-Za-z0-9_.-]{1,128}$",
+              "type": "string"
+            }
+          },
           {
             "in": "query",
             "name": "search",