events.iterate.com

Event type

events.iterate.com/workspace/configured

Deep-merges a configuration patch into an existing workspace configuration. Plain objects recurse, so a `mounts` patch edits the table per mount point: an unknown key adds a mount, a partial value changes just those fields of an existing mount, and `null` removes one. Omitted keys are untouched.

Payload schema

configobject

A configuration patch: deep-merged per mount point; null unmounts.

mountsRecord<string, object | null>optional

Per-mount-point patches: an unknown key adds a mount, a partial value edits just those fields, null unmounts. Omitted keys are untouched.

Raw JSON schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "mounts": {
          "description": "Per-mount-point patches: an unknown key adds a mount, a partial value edits just those fields, null unmounts. Omitted keys are untouched.",
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "policy": {
                    "description": "New commit policy for this mount, when given.",
                    "type": "string",
                    "enum": [
                      "commit-to-main",
                      "read-only"
                    ]
                  },
                  "repoPath": {
                    "description": "New backing repo for this mount, when given.",
                    "type": "string"
                  }
                },
                "additionalProperties": false,
                "description": "Partial mount fields, merged into the existing mount at this path. An entry that never forms a complete mount is DROPPED by the reduce (the configure door rejects it loudly before the append)."
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "additionalProperties": false,
      "description": "A configuration patch: deep-merged per mount point; null unmounts."
    }
  },
  "required": [
    "config"
  ],
  "additionalProperties": false
}