# Config 资源

> 核验版本：1.1.0；通道：stable；文档 ID：resource.config

在明文 plain.data 中保存可版本控制的 JSON 文档，并可用受限 JSON Schema 校验。适合非秘密配置，不是通用加密对象；秘密叶子应显式引用 secret 资源。

本页核对 Viat 1.1.0 稳定版。示例使用合成值/服务桩，未执行、未连接真实服务、未发送消息。先读[资源总览](index.md)。

## 前置条件与权限

先创建被引用的 secret 类型资源。明确哪些设置通过 pull/push/import 迁移，哪些顶层 plain 字段应以 $keep 留给服务端管理。

## 完整配置字段

表中“必填”描述结构解析；提供方/后端的条件必填、运行时默认及限制在下节补充。`null` 仅在类型明确允许时可用，数字格式的存储上限不等于有意义的业务范围。不要依赖未知键被忽略来检测拼写。

### `plain`

| 字段 | 类型/允许值 | 必填 | 省略默认 | 约束 | 含义 |
| --- | --- | --- | --- | --- | --- |
| `plain.data` | JSON | 否；可能条件必填 | `null` | — | 实际配置文档，创建/PUT 在此要求非 null。 |
| `plain.schema` | JSON | 否；可能条件必填 | 无显式默认；见规则 | — | 配置数据的受限 JSON Schema，不是资源类型 schema。 |

### `secret`

空对象 `{}`，本类型在这一半没有字段。

## 运行规则、默认值与限制

创建/完整 PUT 时，plain.data 必须存在且非 null；{plain:{batch:10}} 是错误写法，会报 resource.config.empty_data。不配 schema 时可用任意非 null JSON 值，通常用对象。schema 可选，设置时根必须声明 type:object。每次写入都会校验 schema 和 data。default 是表单注解，不代表自动填充缺失数据。

根支持的键为 type/properties/required/additionalProperties/title/description/$schema。属性通用键为 type/title/description/default/enum。string 增加 minLength/maxLength/pattern/format（format 仅注解），integer/number 增加 minimum/maximum，array 增加 items/minItems/maxItems，object 增加 properties/required/additionalProperties（仅布尔值）。类型限 string/integer/number/boolean/array/object，数组须有受支持的 items schema。不支持的 $ref、组合器等关键字会被拒绝，不会只执行部分约束。

叶子（包括数组内）应严格写为 {"$secret":"token"}，附加兄弟键或非字符串目标均无效。它不是字符串插值，不会把任意字符串递归变成秘密。解析检查目标类型与文件夹身份；CRUD/pull 保留引用，消费 config 的脚本得到已解析的值。schema 校验将引用视为秘密占位符，不会因目标属性为 string 就要求引用也是字符串。存储文档虽可迁移，解析后数据仍属敏感。

## 权限、身份与保存语义

管理 API 需要平台登录及项目成员身份。列举/查看需要成员身份；创建、PUT、PATCH、Test、refresh、copy、delete 需要有效项目角色 Owner/Admin/Developer；较低权限的 operator 角色不可写。管理权限不自动赋予上游账号权限，也不替代运行时的 s3/file/行级授权。MCP 只开放其工具清单实际声明的能力，不能把资源 schema 当作完整 MCP CRUD。

- 创建：`POST /projects/{slug}/resources`，请求为 `{name,folder?,kind,plain,secret}`。name 长度 1–64 字节且不可含 /；system 为保留名。folder 省略/空字符串表示根，非空为 [A-Za-z0-9_-]+ 段，最多 8 层/255 字节，无首尾或连续 /。
- 资源身份为同项目 `(folder,name)`，不是全项目裸名。同名可以位于不同文件夹。详情路由用 `/resources/{name}?folder=team` 显式定位；CLI 用 `team/name`。脚本裸引用按自身文件夹、根、全项目唯一名顺序解析，建议跨文件夹显式限定，Python 用 `getattr(ctx.resources, "team/name")`，TypeScript 用 `ctx.resources["team/name"]`，而非属性链。
- PUT 是完整替换：须重发正确 kind、完整 plain 与全部要保留的秘密值，不能从 show 的掩码恢复秘密。PATCH 的 kind 固定；省略 plain 保留，提供 plain 则整体替换（不是深合并）；secret 仅逐字段覆盖，省略字段保留。移动 folder 时引用在新位置重检。
- 清除可选秘密用 PATCH 显式 null（仅允许 null 的字段）或空字符串（仅允许空值的字段）；必需/条件必需字段不能清空。清除可选 plain 字段需发送去掉该字段的完整 plain，让类型默认/缺省生效。不要用 null 代替所有类型，也不要把 *** 当作旧值。
- `$keep` 是仅 PATCH/仓库同步使用的**顶层 plain 字段**占位符，保留服务端已有同名字段，连数字/布尔也可保留；新资源/不存在字段不能使用。嵌套 `$keep` 不是深合并指令。
- 仓库文件 `resources/<folder>/<name>.yaml` 由路径承载 folder，name 仍是裸名。`viat pull` 将 secret 字段写为字符串 `$secret`；`viat push` 去掉这些占位（也接受旧 !secret 标签），对已有资源 PATCH，绝不把占位当凭据。新资源必须先安全提供实际必需秘密；占位不能创建凭据。顶层 allowed_authorizers 是仓库访问同步元数据，不要擅自塞进 plain。

`$secret` 占位与凭据引用不同：`{"$secret":"name"}` 在 config/cloud 支持位置命名另一个 secret 资源；HTTP/GraphQL 字符串头用整个 `"$secret:name"`。它们不等于秘密明文，保存/读取/导出保留引用，使用时解析。目标按消费资源文件夹锚定并须已存在且为 secret 类型，不能用字符串拼接插值。

公开响应含资源标识、kind、folder、plain 及秘密摘要，不返回秘密值；摘要 *** 表示该种类声明的字段，不证明每个可选凭据实际已填。plain 会原样可读/导出；secret 通过部署秘密后端加密。脚本/依赖的发布版本按快照规则冻结，uses 无 (live) 时亦冻结，不可把所有依赖描述为每次读 live；资源读取/代理操作和显式实时 secret IO 是不同边界。

## 脚本秘密边界

存储文档是明文，引用秘密在解析后有意进入消费脚本，这不是代理凭据隔离。限制脚本/依赖，不要返回整个解析文档。

## 最小配置：管理 API / CLI 文件

下面是创建请求 JSON，同时也是合法 YAML，可作为 `resource.yaml` 交给真实 CLI 命令。域名/凭据均为测试值，生产使用前须替换并完成前置条件；不要把真实 secret 文件提交仓库。

```json
{
  "name": "demo",
  "folder": "",
  "kind": "config",
  "plain": {
    "data": {
      "batch": 10,
      "enabled": true
    },
    "schema": {
      "type": "object",
      "properties": {
        "batch": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "enabled": {
          "type": "boolean"
        }
      },
      "required": [
        "batch",
        "enabled"
      ],
      "additionalProperties": false
    }
  },
  "secret": {}
}
```

```sh
viat project select <slug>
viat resource create --file resource.yaml
viat resource show demo --json
```

等价 API 为 `POST /projects/{slug}/resources`（相对实例管理 API 根），请求体如上。预期得到已保存资源的公开表示和掩码摘要，不是秘密回显；示例名已存在则 409。仓库同步时去掉 folder，把配置放 `resources/demo.yaml`；`viat push` 可同步完整 plain 及未被占位过滤的 secret。创建成功不保证每个远程动作成功。

## SDK 操作与示例

Python 将文档本身暴露为 dict（demo["batch"]），TypeScript 使用 demo.batch 或 demo["batch"]。没有 demo.data 包装、demo.value 或 config 写助手。Rust meta() 看到原始投影 {kind:"config",data:…}，须显式读 data。更新应走 PATCH/PUT/仓库 push，而不是修改 worker 对象。

这两个完整脚本均声明同一个根资源 demo；在获批准的测试运行中使用。写入、发送、构建和数据删除不是 dry-run。

### Python

```python
# @resource demo
from viat import ctx

def main():
    return {"batch": ctx.resources.demo["batch"], "enabled": ctx.resources.demo["enabled"]}
```

### TypeScript

```typescript
// @resource demo
import { ctx } from "viat";

export async function main() {
  return { batch: ctx.resources.demo.batch, enabled: ctx.resources.demo.enabled };
}
```

### Rust

Rust 的已验证表面是 `ctx.resource(name)` 的通用 `call(op,req)`（library 用 `ctx.library`）；不是照搬 Python 方法名。下面展示对应协议调用，返回原始操作结果，可能不同于上方复合示例。

```rust
// @resource demo
use serde_json::{json, Value};
use viat::{Ctx, Error};

fn main() {
    viat::serve(|ctx: &Ctx, _args: Value| -> Result<Value, Error> {
        Ok(json!({"batch": ctx.resource("demo").meta()["data"]["batch"], "enabled": ctx.resource("demo").meta()["data"]["enabled"]}))
    });
}
```

Shell 没有方法装饰的 ctx.resources，仅有 JSON 环境投影；不能把上述方法名直接写成 shell 函数。binary 程序可按 worker 协议实现相应 RPC，并非自动拥有 Python/TypeScript 方法。sql 语言仅用于四种 SQL 数据源，viat_gql 仅用于 PostgreSQL/MySQL/SQLite，graphql 语言用于远程 graphql，llm 语言用于 llm；不支持的组合不会自动适配。

### 预期结果

示例返回 {batch:10,enabled:true}。batch 改为 0 会在保存时校验失败，而非等到脚本读取时。secret 为 {}，无凭据字段。

## Test 行为与副作用

返回 ok:false，“config resources have no connection to test”。保存时的 schema/引用校验才是配置校验面，消费方测试用于检查解析后的结构。

管理 API 使用 `POST /projects/{slug}/resources/{name}/test?folder=`；CLI 为 `viat resource test demo`。API 检查响应体 `ok`：连接失败通常仍为 HTTP 200 `{ok:false,error:"…"}`，可能附 `schema_warnings`，不能只检查状态码。CLI 失败会非零退出。仅在允许出站/文件动作后执行。

## 常见失败与恢复

resource.config.empty_data 应把文档放到 plain.data；bad_schema 应移除不支持的关键字/修正类型；invalid 应修正消息指出的数据路径；bad_secret_ref 应使用精确引用对象。unknown_secret/not_a_secret 应在解析目标文件夹创建 secret。PATCH 一旦提供 plain 就是替换，因此仅发送 plain.schema 可能将 data 重置为 null，应带完整 data。

管理错误一般为 `{error,message}`。DTO 的 `resource.<kind>.*` 经常位于 400 `bad_request` 的 message，而非顶层 error；不要把它们当成所有运行时助手都会返回的统一枚举。401 先恢复平台登录，403 检查有效项目角色/运行时规则，404 检查 folder/name，409 先解决同名或 `resource_in_use` 引用。远程拒绝与平台拒绝分开诊断，重试前判断上一次动作是否可能已生效。

## 生产注意与清理

绝不要将密码明文放入 plain.data，它会被返回和导出。$keep 只在顶层生效（plain.data:"$keep" 保留整个已有文档），嵌套的 "$keep" 是普通业务数据。删除前有计划地迁移读取方和引用秘密；删除资源不会移除外部服务设置。

通用删除步骤：先停用调用脚本、代理/CRUD 目标及相关触发器，迁移依赖并保留需要的证据，再用 `viat resource delete demo` 或 DELETE 详情路由。409 `resource_in_use` 时先重新绑定/删除消息指出的端点，不应强行绕过引用。删除配置资产不等于撤销第三方凭据、删除外部数据或回滚已发生副作用。

## 相关资源与维护依据

- [Secret 资源](secret.md)
- [HTTP API 资源](http_api.md)
- [Cloud API 资源](cloud_api.md)
- [资源总览](index.md)

固定契约：`contracts/1.1.0/resources.json` → `resource.config`。

核对实现（产品仓库相对路径）：viat-core/src/types/resource.rs (KindSpec/Plain/Secret); viat-api/src/dto.rs (normalization/validation); viat-api/src/handlers/resources.rs (CRUD/Test); viat-runtime/src/resource_io.rs, resources_json.rs, python.rs, typescript.rs; viat-api/src/runner/broker.rs; viat-cli/src/main.rs and repo/resources.rs; viat-core/src/types/snapshot.rs.