fengming 0.3.10 → 0.3.12

package/docs/gateway/secrets-plan-contract.md

@@ -1,159 +0,0 @@
----
-summary: "Contract for `secrets apply` plans: target validation, path matching, and `auth-profiles.json` target scope"
-read_when:
-  - Generating or reviewing `fengming secrets apply` plans
-  - Debugging `Invalid plan target path` errors
-  - Understanding target type and path validation behavior
-title: "Secrets apply plan contract"
----
-
-This page defines the strict contract enforced by `fengming secrets apply`.
-
-If a target does not match these rules, apply fails before mutating configuration.
-
-## Plan file shape
-
-`fengming secrets apply --from <plan.json>` expects a `targets` array of plan targets:
-
-```json5
-{
-  version: 1,
-  protocolVersion: 1,
-  targets: [
-    {
-      type: "models.providers.apiKey",
-      path: "models.providers.openai.apiKey",
-      pathSegments: ["models", "providers", "openai", "apiKey"],
-      providerId: "openai",
-      ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },
-    },
-    {
-      type: "auth-profiles.api_key.key",
-      path: "profiles.openai:default.key",
-      pathSegments: ["profiles", "openai:default", "key"],
-      agentId: "main",
-      ref: { source: "env", provider: "default", id: "OPENAI_API_KEY" },
-    },
-  ],
-}
-```
-
-## Provider upserts and deletes
-
-Plans may also include two optional top-level fields that mutate the
-`secrets.providers` map alongside the per-target writes:
-
-- `providerUpserts` — an object keyed by provider alias. Each value is a
-  provider definition (the same shape accepted under
-  `secrets.providers.<alias>` in `fengming.json`, e.g. an `exec` or `file`
-  provider).
-- `providerDeletes` — an array of provider aliases to remove.
-
-`providerUpserts` runs before `targets`, so a `target.ref.provider` may
-reference a provider alias that the same plan introduces in
-`providerUpserts`. Without this, plans that reference an alias not yet
-configured in `fengming.json` fail with `provider "<alias>" is not
-configured`.
-
-```json5
-{
-  version: 1,
-  protocolVersion: 1,
-  providerUpserts: {
-    onepassword_anthropic: {
-      source: "exec",
-      command: "/usr/bin/op",
-      args: ["read", "op://Vault/Anthropic/credential"],
-    },
-  },
-  providerDeletes: ["legacy_unused_alias"],
-  targets: [
-    {
-      type: "models.providers.apiKey",
-      path: "models.providers.anthropic.apiKey",
-      pathSegments: ["models", "providers", "anthropic", "apiKey"],
-      providerId: "anthropic",
-      ref: { source: "exec", provider: "onepassword_anthropic", id: "credential" },
-    },
-  ],
-}
-```
-
-Exec providers introduced via `providerUpserts` are still subject to the
-exec consent rules in [Exec provider consent behavior](#exec-provider-consent-behavior):
-plans containing exec providers require `--allow-exec` in write mode.
-
-## Supported target scope
-
-Plan targets are accepted for supported credential paths in:
-
-- [SecretRef Credential Surface](/reference/secretref-credential-surface)
-
-## Target type behavior
-
-General rule:
-
-- `target.type` must be recognized and must match the normalized `target.path` shape.
-
-Compatibility aliases remain accepted for existing plans:
-
-- `models.providers.apiKey`
-- `skills.entries.apiKey`
-- `channels.googlechat.serviceAccount`
-
-## Path validation rules
-
-Each target is validated with all of the following:
-
-- `type` must be a recognized target type.
-- `path` must be a non-empty dot path.
-- `pathSegments` can be omitted. If provided, it must normalize to exactly the same path as `path`.
-- Forbidden segments are rejected: `__proto__`, `prototype`, `constructor`.
-- The normalized path must match the registered path shape for the target type.
-- If `providerId` or `accountId` is set, it must match the id encoded in the path.
-- `auth-profiles.json` targets require `agentId`.
-- When creating a new `auth-profiles.json` mapping, include `authProfileProvider`.
-
-## Failure behavior
-
-If a target fails validation, apply exits with an error like:
-
-```text
-Invalid plan target path for models.providers.apiKey: models.providers.openai.baseUrl
-```
-
-No writes are committed for an invalid plan.
-
-## Exec provider consent behavior
-
-- `--dry-run` skips exec SecretRef checks by default.
-- Plans containing exec SecretRefs/providers are rejected in write mode unless `--allow-exec` is set.
-- When validating/applying exec-containing plans, pass `--allow-exec` in both dry-run and write commands.
-
-## Runtime and audit scope notes
-
-- Ref-only `auth-profiles.json` entries (`keyRef`/`tokenRef`) are included in runtime resolution and audit coverage.
-- `secrets apply` writes supported `fengming.json` targets, supported `auth-profiles.json` targets, and optional scrub targets.
-
-## Operator checks
-
-```bash
-# Validate plan without writes
-fengming secrets apply --from /tmp/fengming-secrets-plan.json --dry-run
-
-# Then apply for real
-fengming secrets apply --from /tmp/fengming-secrets-plan.json
-
-# For exec-containing plans, opt in explicitly in both modes
-fengming secrets apply --from /tmp/fengming-secrets-plan.json --dry-run --allow-exec
-fengming secrets apply --from /tmp/fengming-secrets-plan.json --allow-exec
-```
-
-If apply fails with an invalid target path message, regenerate the plan with `fengming secrets configure` or fix the target path to a supported shape above.
-
-## Related docs
-
-- [Secrets Management](/gateway/secrets)
-- [CLI `secrets`](/cli/secrets)
-- [SecretRef Credential Surface](/reference/secretref-credential-surface)
-- [Configuration Reference](/gateway/configuration-reference)