Planning and generation / JSON Schema

Infra Plan V1

Defines the versioned infra plan v1 boundary used by Workspai and its consumers.

Schema version: rapidkit.infra-plan.v1
Contract path: contracts/infra-plan.v1.json
Publication: json-schema
Defined fields: 28
Artifact bindings: 1

Why this contract exists

Architecture role

Defines a versioned interoperability boundary used by Workspai and contract-aware consumers.

Consumption boundary

• Workspai CLI
• Contract-aware integrations

Related commands

Commands are linked only when the runtime contract identifies a direct production relationship. Supporting contracts may be consumed without having a single producer command.

workspai infra plan

Produced artifacts

These durable files are emitted by registered commands and validated against this contract.

Artifact path	Schema	Producer
.workspai/reports/infra-plan.json	rapidkit.infra-plan.v1	workspai infra plan

Field reference

Every declared schema property or published capability path is listed here. Required means the contract declares or publishes that field at the shown boundary.

Field path	Type	Required	Meaning	Constraints
composePath	string	Yes	Defines the composepath value at this contract boundary.	minLength: 1
connectionEnv	object	Yes	Defines the connectionenv value at this contract boundary.	—
contractPath	string	No	Defines the contractpath value at this contract boundary.	minLength: 1
envExamplePath	string	Yes	Defines the envexamplepath value at this contract boundary.	minLength: 1
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "rapidkit.infra-plan.v1"
serviceEnvOverrides	object	No	Defines the serviceenvoverrides value at this contract boundary.	—
services	array	Yes	Defines the services value at this contract boundary.	—
services[].category	string	Yes	Defines the category value at this contract boundary.	minLength: 1
services[].displayName	string	Yes	Defines the displayname value at this contract boundary.	minLength: 1
services[].id	string	Yes	Defines the id value at this contract boundary.	minLength: 1
services[].image	string	Yes	Defines the image value at this contract boundary.	minLength: 1
services[].ports	array	Yes	Defines the ports value at this contract boundary.	—
services[].ports[].container	integer	Yes	Defines the container value at this contract boundary.	minimum: 1 · maximum: 65535
services[].ports[].host	integer	Yes	Defines the host value at this contract boundary.	minimum: 1 · maximum: 65535
services[].ports[].name	string	Yes	Defines the name value at this contract boundary.	minLength: 1
services[].sources	array	Yes	Defines the sources value at this contract boundary.	—
services[].sources[].kind	enum	Yes	Defines the kind value at this contract boundary.	enum: module, env-var, override, contract-env
services[].sources[].project	string	No	Defines the project value at this contract boundary.	minLength: 1
services[].sources[].value	string	Yes	Defines the value value at this contract boundary.	minLength: 1
sources	object	Yes	Defines the sources value at this contract boundary.	additionalProperties: false
sources.envVars	array	Yes	Defines the envvars value at this contract boundary.	—
sources.modules	array	Yes	Defines the modules value at this contract boundary.	—
sources.overrides	array	Yes	Defines the overrides value at this contract boundary.	—
strategy	string	Yes	Defines the strategy value at this contract boundary.	const: "sidecar"
warnings	array	Yes	Defines the warnings value at this contract boundary.	—
workspaceName	string	No	Defines the workspacename value at this contract boundary.	minLength: 1
workspacePath	string	Yes	Defines the workspacepath value at this contract boundary.	minLength: 1

Canonical machine-readable definition

The raw synchronized contract remains authoritative. The educational sections above are projections of this definition.

Show raw JSON

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "workspacePath",
    "strategy",
    "composePath",
    "envExamplePath",
    "services",
    "connectionEnv",
    "sources",
    "warnings"
  ],
  "properties": {
    "schemaVersion": {
      "const": "rapidkit.infra-plan.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "workspacePath": {
      "type": "string",
      "minLength": 1
    },
    "workspaceName": {
      "type": "string",
      "minLength": 1
    },
    "contractPath": {
      "type": "string",
      "minLength": 1
    },
    "strategy": {
      "const": "sidecar"
    },
    "composePath": {
      "type": "string",
      "minLength": 1
    },
    "envExamplePath": {
      "type": "string",
      "minLength": 1
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "displayName",
          "category",
          "image",
          "ports",
          "sources"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "displayName": {
            "type": "string",
            "minLength": 1
          },
          "category": {
            "type": "string",
            "minLength": 1
          },
          "image": {
            "type": "string",
            "minLength": 1
          },
          "ports": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "name",
                "host",
                "container"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "minLength": 1
                },
                "host": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                },
                "container": {
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 65535
                }
              },
              "additionalProperties": false
            }
          },
          "sources": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "kind",
                "value"
              ],
              "properties": {
                "kind": {
                  "enum": [
                    "module",
                    "env-var",
                    "override",
                    "contract-env"
                  ]
                },
                "value": {
                  "type": "string",
                  "minLength": 1
                },
                "project": {
                  "type": "string",
                  "minLength": 1
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      }
    },
    "connectionEnv": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "sources": {
      "type": "object",
      "required": [
        "modules",
        "envVars",
        "overrides"
      ],
      "properties": {
        "modules": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "envVars": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "overrides": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "serviceEnvOverrides": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": true
}