ResolveTemplateResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amigo/main/json-schema/amigo-resolve-template-response-schema.json",
  "title": "ResolveTemplateResponse",
  "description": "Resolved SurfaceSpec with prefill values.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amigo-form-templates-api-openapi.yml#/components/schemas/ResolveTemplateResponse",
  "properties": {
    "spec": {
      "$ref": "#/$defs/SurfaceSpec"
    },
    "prefilled_count": {
      "type": "integer",
      "title": "Prefilled Count"
    },
    "total_fields": {
      "type": "integer",
      "title": "Total Fields"
    }
  },
  "type": "object",
  "required": [
    "spec",
    "prefilled_count",
    "total_fields"
  ],
  "$defs": {
    "BrandingConfig": {
      "properties": {
        "logo_url": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2048
            },
            {
              "type": "null"
            }
          ],
          "title": "Logo Url"
        },
        "primary_color": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 32
            },
            {
              "type": "null"
            }
          ],
          "title": "Primary Color"
        },
        "background_color": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 32
            },
            {
              "type": "null"
            }
          ],
          "title": "Background Color"
        },
        "font_family": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 256
            },
            {
              "type": "null"
            }
          ],
          "title": "Font Family"
        }
      },
      "type": "object",
      "title": "BrandingConfig",
      "description": "Visual branding for patient-facing surfaces."
    },
    "ChannelType": {
      "type": "string",
      "enum": [
        "email",
        "web",
        "sms"
      ],
      "title": "ChannelType",
      "description": "Delivery channels for surfaces."
    },
    "DescriptionString": {
      "type": "string",
      "maxLength": 2000
    },
    "FieldType": {
      "type": "string",
      "enum": [
        "text",
        "textarea",
        "date",
        "phone",
        "email",
        "number",
        "select",
        "multiselect",
        "checkbox",
        "photo",
        "signature",
        "file",
        "heading",
        "info"
      ],
      "title": "FieldType",
      "description": "Input field types for surface data collection."
    },
    "NameString": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1
    },
    "SurfaceField": {
      "properties": {
        "key": {
          "type": "string",
          "maxLength": 128,
          "minLength": 1,
          "title": "Key"
        },
        "label": {
          "$ref": "#/$defs/NameString"
        },
        "field_type": {
          "$ref": "#/$defs/FieldType"
        },
        "required": {
          "type": "boolean",
          "title": "Required",
          "default": true
        },
        "options": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Options"
        },
        "description": {
          "anyOf": [
            {
              "$ref": "#/$defs/DescriptionString"
            },
            {
              "type": "null"
            }
          ]
        },
        "placeholder": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 256
            },
            {
              "type": "null"
            }
          ],
          "title": "Placeholder"
        },
        "prefill_value": {
          "anyOf": [
            {},
            {
              "type": "null"
            }
          ],
          "title": "Prefill Value"
        },
        "validation": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Validation"
        },
        "sensitive": {
          "type": "boolean",
          "title": "Sensitive",
          "default": false
        },
        "condition": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Condition"
        },
        "consent_text": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 5000
            },
            {
              "type": "null"
            }
          ],
          "title": "Consent Text"
        }
      },
      "type": "object",
      "required": [
        "key",
        "label",
        "field_type"
      ],
      "title": "SurfaceField",
      "description": "A single data collection field in a surface spec.\n\nGenerated by agents from HSM analysis. Each field maps\nto a specific piece of data the world model needs."
    },
    "SurfaceSection": {
      "properties": {
        "title": {
          "$ref": "#/$defs/NameString"
        },
        "description": {
          "anyOf": [
            {
              "$ref": "#/$defs/DescriptionString"
            },
            {
              "type": "null"
            }
          ]
        },
        "field_keys": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "maxItems": 100,
          "minItems": 1,
          "title": "Field Keys"
        },
        "condition": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Condition"
        }
      },
      "type": "object",
      "required": [
        "title",
        "field_keys"
      ],
      "title": "SurfaceSection",
      "description": "A page/step in a multi-page surface form."
    },
    "SurfaceSpec": {
      "properties": {
        "entity_id": {
          "type": "string",
          "format": "uuid",
          "title": "Entity Id"
        },
        "title": {
          "$ref": "#/$defs/NameString"
        },
        "description": {
          "anyOf": [
            {
              "$ref": "#/$defs/DescriptionString"
            },
            {
              "type": "null"
            }
          ]
        },
        "fields": {
          "items": {
            "$ref": "#/$defs/SurfaceField"
          },
          "type": "array",
          "maxItems": 200,
          "minItems": 1,
          "title": "Fields"
        },
        "channel": {
          "$ref": "#/$defs/ChannelType",
          "default": "web"
        },
        "expires_in_hours": {
          "type": "integer",
          "maximum": 8760.0,
          "minimum": 1.0,
          "title": "Expires In Hours",
          "default": 168
        },
        "context": {
          "additionalProperties": true,
          "type": "object",
          "title": "Context"
        },
        "resource_type": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 128
            },
            {
              "type": "null"
            }
          ],
          "title": "Resource Type"
        },
        "branding": {
          "anyOf": [
            {
              "$ref": "#/$defs/BrandingConfig"
            },
            {
              "type": "null"
            }
          ]
        },
        "sections": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/SurfaceSection"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Sections"
        },
        "completion_title": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 256
            },
            {
              "type": "null"
            }
          ],
          "title": "Completion Title"
        },
        "completion_message": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2000
            },
            {
              "type": "null"
            }
          ],
          "title": "Completion Message"
        },
        "completion_action_url": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2048
            },
            {
              "type": "null"
            }
          ],
          "title": "Completion Action Url"
        },
        "submit_button_text": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 128
            },
            {
              "type": "null"
            }
          ],
          "title": "Submit Button Text"
        }
      },
      "type": "object",
      "required": [
        "entity_id",
        "title",
        "fields"
      ],
      "title": "SurfaceSpec",
      "description": "A complete surface specification generated by an agent.\n\nThe agent reads the HSM (entity state, relationships,\nconfidence gaps) and produces this spec. The spec is stored as a\nworld.event and rendered by platform-api into a patient-facing page."
    }
  }
}