@epilot/sdk 2.20.11 → 2.20.12

package/definitions/environments-runtime.json

@@ -0,0 +1 @@
+{"s":"https://environments.sls.epilot.io","o":[["listEnvironmentVariables","get","/v1/environments"],["createEnvironmentVariable","post","/v1/environments",null,1],["listEnvironmentGroups","get","/v1/environments/groups"],["putEnvironmentGroup","put","/v1/environments/groups/{name}",null,1],["deleteEnvironmentGroup","delete","/v1/environments/groups/{name}"],["getEnvironmentVariable","get","/v1/environments/{key}"],["updateEnvironmentVariable","put","/v1/environments/{key}",null,1],["deleteEnvironmentVariable","delete","/v1/environments/{key}"]],"v":"3.0.3","pp":{"/v1/environments/groups/{name}":[["name","p",true]],"/v1/environments/{key}":[["key","p",true]]}}

package/definitions/environments.json

@@ -0,0 +1,703 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Environments API",
+    "description": "API for managing organization environment variables and secrets",
+    "version": "1.0.1"
+  },
+  "tags": [
+    {
+      "name": "environments",
+      "description": "Environment variables and secrets management"
+    }
+  ],
+  "security": [
+    {
+      "EpilotAuth": []
+    }
+  ],
+  "paths": {
+    "/v1/environments": {
+      "get": {
+        "operationId": "listEnvironmentVariables",
+        "summary": "listEnvironmentVariables",
+        "description": "List all environment variables for the organization. Returns metadata only, no secret values.",
+        "tags": [
+          "environments"
+        ],
+        "responses": {
+          "200": {
+            "description": "List of environment variables",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EnvironmentVariableList"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      },
+      "post": {
+        "operationId": "createEnvironmentVariable",
+        "summary": "createEnvironmentVariable",
+        "description": "Create a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.",
+        "tags": [
+          "environments"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/EnvironmentVariableCreateRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Created environment variable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EnvironmentVariable"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid request"
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "409": {
+            "description": "Environment variable with this key already exists"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      }
+    },
+    "/v1/environments/groups": {
+      "get": {
+        "operationId": "listEnvironmentGroups",
+        "summary": "listEnvironmentGroups",
+        "description": "List all environment groups for the organization.",
+        "tags": [
+          "environments"
+        ],
+        "responses": {
+          "200": {
+            "description": "List of environment groups",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EnvironmentGroupList"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      }
+    },
+    "/v1/environments/groups/{name}": {
+      "parameters": [
+        {
+          "name": "name",
+          "in": "path",
+          "required": true,
+          "schema": {
+            "type": "string"
+          }
+        }
+      ],
+      "put": {
+        "operationId": "putEnvironmentGroup",
+        "summary": "putEnvironmentGroup",
+        "description": "Create or update an environment group by name. Acts as an upsert — creates the group if it does not exist.",
+        "tags": [
+          "environments"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/EnvironmentGroupUpsertRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Updated group",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EnvironmentGroup"
+                }
+              }
+            }
+          },
+          "201": {
+            "description": "Created group",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EnvironmentGroup"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteEnvironmentGroup",
+        "summary": "deleteEnvironmentGroup",
+        "description": "Deletes a group. Variables assigned to this group become ungrouped.",
+        "tags": [
+          "environments"
+        ],
+        "responses": {
+          "204": {
+            "description": "Group deleted"
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "description": "Group not found"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      }
+    },
+    "/v1/environments/{key}": {
+      "parameters": [
+        {
+          "name": "key",
+          "in": "path",
+          "required": true,
+          "description": "Environment variable key",
+          "schema": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9_.\\-]{0,127}$"
+          }
+        }
+      ],
+      "get": {
+        "operationId": "getEnvironmentVariable",
+        "summary": "getEnvironmentVariable",
+        "description": "Get an environment variable by key. Returns value for non-secret types, omitted for SecretString.",
+        "tags": [
+          "environments"
+        ],
+        "responses": {
+          "200": {
+            "description": "Environment variable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EnvironmentVariable"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "description": "Environment variable not found"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      },
+      "put": {
+        "operationId": "updateEnvironmentVariable",
+        "summary": "updateEnvironmentVariable",
+        "description": "Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.",
+        "tags": [
+          "environments"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/EnvironmentVariableUpdateRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Updated environment variable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EnvironmentVariable"
+                }
+              }
+            }
+          },
+          "201": {
+            "description": "Created environment variable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EnvironmentVariable"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid request"
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "409": {
+            "description": "Cannot change the type of a variable that currently holds a value"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteEnvironmentVariable",
+        "summary": "deleteEnvironmentVariable",
+        "description": "Delete an environment variable by key.",
+        "tags": [
+          "environments"
+        ],
+        "responses": {
+          "204": {
+            "description": "Environment variable deleted"
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden"
+          },
+          "404": {
+            "description": "Environment variable not found"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "EpilotAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      }
+    },
+    "schemas": {
+      "EnvironmentValueType": {
+        "type": "string",
+        "description": "The structure a variable's value holds. `SecretString` is encrypted at rest and\nits value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`\nmay be served to browser-facing consumers; `String` and `SecretString` may not.\n",
+        "enum": [
+          "String",
+          "SecretString",
+          "Text",
+          "Number",
+          "Boolean",
+          "Map",
+          "JSON",
+          "Link"
+        ]
+      },
+      "StringTranslations": {
+        "description": "A string translated per language. Keys are language codes (e.g. `de`,\n`en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses\neverywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces\nthat with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are\nnot otherwise linked. The pattern is documented rather than declared\nbecause `propertyNames` is JSON Schema / OAS 3.1 and this document is\n3.0.3, where it fails `spectral lint` (oas3-schema).\n",
+        "type": "object",
+        "minProperties": 1,
+        "additionalProperties": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "MapEntry": {
+        "description": "One entry of a Map. `key` is the token a journey submits; `value` is\nwhat the customer reads — either one string, or one string per\nlanguage. Every entry of a Map must agree on which of the two it uses.\n",
+        "type": "object",
+        "required": [
+          "key",
+          "value"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "key": {
+            "type": "string",
+            "minLength": 1
+          },
+          "value": {
+            "oneOf": [
+              {
+                "type": "string",
+                "minLength": 1
+              },
+              {
+                "$ref": "#/components/schemas/StringTranslations"
+              }
+            ]
+          }
+        }
+      },
+      "MapValue": {
+        "type": "object",
+        "required": [
+          "options"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "fallbackLanguage": {
+            "type": "string",
+            "minLength": 2,
+            "default": "de"
+          },
+          "options": {
+            "type": "array",
+            "minItems": 1,
+            "items": {
+              "$ref": "#/components/schemas/MapEntry"
+            }
+          }
+        }
+      },
+      "JsonValue": {
+        "description": "Arbitrary JSON object, e.g. a flat key/value map used by integrations for\nenum translation: {\"Mr.\": 1, \"Ms. / Mrs.\": 2}. Max 32 KB serialised.\n",
+        "type": "object",
+        "additionalProperties": true
+      },
+      "LinkValue": {
+        "description": "One URL with a label and description a customer reads. `label` and\n`description` are each either a plain string or one string per language;\nthe two fields decide that independently — a plain string means \"the\nsame in every language\". A translated field must carry the fallback\nlanguage.\n\nThe URL must be absolute and `http`/`https` only. This value is served\nto browser-facing consumers, so `javascript:` and `data:` URLs are\nrejected at write time.\n\nWritten flat rather than composed from a shared field set: `allOf` plus\n`additionalProperties: false` is rejected by most validators, because\neach branch sees the sibling's properties as unknown. The composition\nlives in zod (LinkFieldsSchema) — see src/core/value-types.ts.\n\nEach translated value of `label` and `description` is also limited to\nthe same maximum as the plain-string form above — 255 characters for\n`label`, 1024 for `description`. The limit is enforced by the server\neven though the shared `StringTranslations` schema referenced below\ndoes not itself declare it.\n",
+        "type": "object",
+        "required": [
+          "url",
+          "label"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "url": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 2048
+          },
+          "label": {
+            "oneOf": [
+              {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 255
+              },
+              {
+                "$ref": "#/components/schemas/StringTranslations"
+              }
+            ]
+          },
+          "description": {
+            "oneOf": [
+              {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 1024
+              },
+              {
+                "$ref": "#/components/schemas/StringTranslations"
+              }
+            ]
+          },
+          "fallbackLanguage": {
+            "type": "string",
+            "minLength": 2,
+            "default": "de"
+          }
+        }
+      },
+      "EnvironmentValue": {
+        "description": "A variable's value. The JSON type corresponds to the variable's `type`:\n`String`, `SecretString` and `Text` are strings, `Number` is a number,\n`Boolean` is a boolean, and `Map`, `JSON` and `Link` are objects. Numbers are\nIEEE 754 doubles; integers above 2^53 may lose precision on round-trip.\n",
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "boolean"
+          },
+          {
+            "$ref": "#/components/schemas/MapValue"
+          },
+          {
+            "$ref": "#/components/schemas/JsonValue"
+          },
+          {
+            "$ref": "#/components/schemas/LinkValue"
+          }
+        ]
+      },
+      "EnvironmentVariable": {
+        "type": "object",
+        "required": [
+          "key",
+          "type",
+          "created_at",
+          "updated_at"
+        ],
+        "properties": {
+          "key": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9_.\\-]{0,127}$"
+          },
+          "type": {
+            "$ref": "#/components/schemas/EnvironmentValueType"
+          },
+          "description": {
+            "type": "string"
+          },
+          "group": {
+            "type": "string",
+            "description": "Optional group name for organising variables in the UI"
+          },
+          "value": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/EnvironmentValue"
+              }
+            ],
+            "description": "Returned for non-secret types, omitted for SecretString. Also omitted when\nthe variable has been created without a value — for example by a blueprint\ninstall, which syncs a variable's key and type but never its value.\n"
+          },
+          "protected": {
+            "type": "boolean",
+            "description": "Whether the variable is protected from editing"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time"
+          }
+        }
+      },
+      "EnvironmentVariableListItem": {
+        "type": "object",
+        "required": [
+          "key",
+          "type",
+          "created_at",
+          "updated_at"
+        ],
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "type": {
+            "$ref": "#/components/schemas/EnvironmentValueType"
+          },
+          "description": {
+            "type": "string"
+          },
+          "group": {
+            "type": "string",
+            "description": "Optional group name for organising variables in the UI"
+          },
+          "value": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/EnvironmentValue"
+              }
+            ],
+            "description": "Returned for non-secret types, omitted for SecretString. Also omitted when\nthe variable has been created without a value — for example by a blueprint\ninstall, which syncs a variable's key and type but never its value.\n"
+          },
+          "protected": {
+            "type": "boolean",
+            "description": "Whether the variable is protected from editing"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time"
+          }
+        }
+      },
+      "EnvironmentVariableList": {
+        "type": "object",
+        "required": [
+          "items"
+        ],
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EnvironmentVariableListItem"
+            }
+          }
+        }
+      },
+      "EnvironmentVariableCreateRequest": {
+        "type": "object",
+        "required": [
+          "key",
+          "type"
+        ],
+        "properties": {
+          "key": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9_.\\-]{0,127}$"
+          },
+          "type": {
+            "$ref": "#/components/schemas/EnvironmentValueType"
+          },
+          "description": {
+            "type": "string"
+          },
+          "group": {
+            "type": "string"
+          },
+          "value": {
+            "$ref": "#/components/schemas/EnvironmentValue"
+          },
+          "protected": {
+            "type": "boolean",
+            "description": "Whether the variable is protected from editing"
+          }
+        }
+      },
+      "EnvironmentVariableUpdateRequest": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "description": "Type of variable. Used when creating a new variable. Defaults to String.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/EnvironmentValueType"
+              }
+            ]
+          },
+          "value": {
+            "$ref": "#/components/schemas/EnvironmentValue"
+          },
+          "description": {
+            "type": "string"
+          },
+          "group": {
+            "type": "string"
+          },
+          "protected": {
+            "type": "boolean",
+            "description": "Whether the variable is protected from editing"
+          }
+        }
+      },
+      "EnvironmentGroup": {
+        "type": "object",
+        "required": [
+          "name",
+          "created_at",
+          "updated_at"
+        ],
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time"
+          }
+        }
+      },
+      "EnvironmentGroupList": {
+        "type": "object",
+        "required": [
+          "items"
+        ],
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EnvironmentGroup"
+            }
+          }
+        }
+      },
+      "EnvironmentGroupUpsertRequest": {
+        "type": "object",
+        "properties": {
+          "description": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
+  "servers": [
+    {
+      "url": "https://environments.sls.epilot.io"
+    }
+  ]
+}