Planning and generation / JSON Schema

Private Product Manifest V1

Defines the versioned private product manifest v1 boundary used by Workspai and its consumers.

Schema version: rapidkit.private-product-manifest.v1
Contract path: contracts/private-product-manifest.v1.json
Publication: json-schema
Defined fields: 25
Artifact bindings: 0

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.

This is a supporting, capability, cache, compatibility, or consumer contract. It has no single direct producer command in the canonical Workspace Intelligence execution registry.

Produced artifacts

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

No canonical file artifact is registered for this contract. It may describe capabilities, embedded data, runtime exchange, or supporting state instead of a standalone report.

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
factory	object	Yes	Defines the factory value at this contract boundary.	additionalProperties: false
factory.manifestChecksum	string	Yes	Defines the manifestchecksum value at this contract boundary.	pattern: ^sha256:[a-f0-9]{64}$
factory.releaseEvidencePath	string	Yes	Defines the releaseevidencepath value at this contract boundary.	minLength: 1
factory.requiredCommands	array	Yes	Defines the requiredcommands value at this contract boundary.	—
factory.sourceBacklogPath	string	Yes	Defines the sourcebacklogpath value at this contract boundary.	minLength: 1
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
product	object	Yes	Defines the product value at this contract boundary.	additionalProperties: false
product.category	string	Yes	Defines the category value at this contract boundary.	minLength: 1
product.rank	number	Yes	Defines the rank value at this contract boundary.	—
product.slug	string	Yes	Defines the slug value at this contract boundary.	minLength: 1
product.summary	string	Yes	Defines the summary value at this contract boundary.	—
product.tier	string	Yes	Defines the tier value at this contract boundary.	minLength: 1
product.title	string	Yes	Defines the title value at this contract boundary.	minLength: 1
projects	array	Yes	Defines the projects value at this contract boundary.	minItems: 1 · maxItems: 1
projects[].framework	string	Yes	Defines the framework value at this contract boundary.	const: "fastapi"
projects[].kit	string	Yes	Defines the kit value at this contract boundary.	minLength: 1
projects[].moduleGaps	array	Yes	Defines the modulegaps value at this contract boundary.	—
projects[].modules	array	Yes	Defines the modules value at this contract boundary.	—
projects[].runtime	string	Yes	Defines the runtime value at this contract boundary.	const: "python"
projects[].slug	string	Yes	Defines the slug value at this contract boundary.	const: "api"
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "rapidkit.private-product-manifest.v1"
workspace	object	Yes	Defines the workspace value at this contract boundary.	additionalProperties: false
workspace.name	string	Yes	Defines the name value at this contract boundary.	minLength: 1
workspace.outputHint	string	Yes	Defines the outputhint value at this contract boundary.	minLength: 1
workspace.profile	string	Yes	Defines the profile value at this contract boundary.	const: "enterprise"

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",
    "product",
    "workspace",
    "projects",
    "factory"
  ],
  "properties": {
    "schemaVersion": {
      "const": "rapidkit.private-product-manifest.v1"
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "product": {
      "type": "object",
      "required": [
        "rank",
        "slug",
        "title",
        "category",
        "tier",
        "summary"
      ],
      "properties": {
        "rank": {
          "type": "number"
        },
        "slug": {
          "type": "string",
          "minLength": 1
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "category": {
          "type": "string",
          "minLength": 1
        },
        "tier": {
          "type": "string",
          "minLength": 1
        },
        "summary": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "workspace": {
      "type": "object",
      "required": [
        "name",
        "profile",
        "outputHint"
      ],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "profile": {
          "const": "enterprise"
        },
        "outputHint": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "projects": {
      "type": "array",
      "minItems": 1,
      "maxItems": 1,
      "items": {
        "type": "object",
        "required": [
          "slug",
          "kit",
          "runtime",
          "framework",
          "modules",
          "moduleGaps"
        ],
        "properties": {
          "slug": {
            "const": "api"
          },
          "kit": {
            "type": "string",
            "minLength": 1
          },
          "runtime": {
            "const": "python"
          },
          "framework": {
            "const": "fastapi"
          },
          "modules": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "moduleGaps": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      }
    },
    "factory": {
      "type": "object",
      "required": [
        "sourceBacklogPath",
        "manifestChecksum",
        "requiredCommands",
        "releaseEvidencePath"
      ],
      "properties": {
        "sourceBacklogPath": {
          "type": "string",
          "minLength": 1
        },
        "manifestChecksum": {
          "type": "string",
          "pattern": "^sha256:[a-f0-9]{64}$"
        },
        "requiredCommands": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "releaseEvidencePath": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": true
}