Planning and generation / JSON Schema
Product Factory Plan V1
Defines the versioned product factory plan v1 boundary used by Workspai and its consumers.
- Schema version
rapidkit.product-factory-plan.v1- Contract path
contracts/product-factory-plan.v1.json- Publication
- json-schema
- Defined fields
- 32
- 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 |
|---|---|---|---|---|
| defaults | object | Yes | Defines the defaults value at this contract boundary. | additionalProperties: false |
| defaults.kit | string | Yes | Defines the kit value at this contract boundary. | minLength: 1 |
| defaults.projectSlug | string | Yes | Defines the projectslug value at this contract boundary. | const: "api" |
| defaults.workspaceProfile | string | Yes | Defines the workspaceprofile value at this contract boundary. | const: "enterprise" |
| generatedAt | string | Yes | Defines the generatedat value at this contract boundary. | format: date-time |
| products | array | Yes | Defines the products value at this contract boundary. | — |
| products[].category | string | Yes | Defines the category value at this contract boundary. | minLength: 1 |
| products[].moduleGaps | array | Yes | Defines the modulegaps value at this contract boundary. | — |
| products[].modules | array | Yes | Defines the modules value at this contract boundary. | — |
| products[].rank | number | Yes | Defines the rank value at this contract boundary. | — |
| products[].readiness | object | Yes | Defines the readiness value at this contract boundary. | additionalProperties: false |
| products[].readiness.blockingGaps | array | Yes | Defines the blockinggaps value at this contract boundary. | — |
| products[].readiness.status | enum | Yes | Defines the status value at this contract boundary. | enum: ready-for-private-manifest, blocked-by-module-gaps |
| products[].recommendedKit | string | Yes | Defines the recommendedkit value at this contract boundary. | minLength: 1 |
| products[].slug | string | Yes | Defines the slug value at this contract boundary. | minLength: 1 |
| products[].summary | string | Yes | Defines the summary value at this contract boundary. | — |
| products[].tier | string | Yes | Defines the tier value at this contract boundary. | minLength: 1 |
| products[].title | string | Yes | Defines the title value at this contract boundary. | minLength: 1 |
| products[].workspaceProfile | string | Yes | Defines the workspaceprofile value at this contract boundary. | const: "enterprise" |
| schemaVersion | string | Yes | Defines the schemaversion value at this contract boundary. | const: "rapidkit.product-factory-plan.v1" |
| source | object | Yes | Defines the source value at this contract boundary. | additionalProperties: false |
| source.backlogPath | string | Yes | Defines the backlogpath value at this contract boundary. | minLength: 1 |
| source.backlogSchemaVersion | string | null | Yes | Defines the backlogschemaversion value at this contract boundary. | — |
| source.publicationRule | string | null | Yes | Defines the publicationrule value at this contract boundary. | — |
| source.purpose | string | null | Yes | Defines the purpose value at this contract boundary. | — |
| stats | object | Yes | Defines the stats value at this contract boundary. | additionalProperties: false |
| stats.blockedProducts | integer | Yes | Defines the blockedproducts value at this contract boundary. | minimum: 0 |
| stats.knownModuleGaps | integer | Yes | Defines the knownmodulegaps value at this contract boundary. | minimum: 0 |
| stats.plannedProducts | integer | Yes | Defines the plannedproducts value at this contract boundary. | minimum: 0 |
| stats.readyProducts | integer | Yes | Defines the readyproducts value at this contract boundary. | minimum: 0 |
| stats.totalProducts | integer | Yes | Defines the totalproducts value at this contract boundary. | minimum: 0 |
| stats.uniqueModules | integer | Yes | Defines the uniquemodules value at this contract boundary. | minimum: 0 |
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",
"source",
"defaults",
"stats",
"products"
],
"properties": {
"schemaVersion": {
"const": "rapidkit.product-factory-plan.v1"
},
"generatedAt": {
"type": "string",
"format": "date-time"
},
"source": {
"type": "object",
"required": [
"backlogPath",
"backlogSchemaVersion",
"purpose",
"publicationRule"
],
"properties": {
"backlogPath": {
"type": "string",
"minLength": 1
},
"backlogSchemaVersion": {
"type": [
"string",
"null"
]
},
"purpose": {
"type": [
"string",
"null"
]
},
"publicationRule": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"defaults": {
"type": "object",
"required": [
"kit",
"workspaceProfile",
"projectSlug"
],
"properties": {
"kit": {
"type": "string",
"minLength": 1
},
"workspaceProfile": {
"const": "enterprise"
},
"projectSlug": {
"const": "api"
}
},
"additionalProperties": false
},
"stats": {
"type": "object",
"required": [
"totalProducts",
"plannedProducts",
"readyProducts",
"blockedProducts",
"uniqueModules",
"knownModuleGaps"
],
"properties": {
"totalProducts": {
"type": "integer",
"minimum": 0
},
"plannedProducts": {
"type": "integer",
"minimum": 0
},
"readyProducts": {
"type": "integer",
"minimum": 0
},
"blockedProducts": {
"type": "integer",
"minimum": 0
},
"uniqueModules": {
"type": "integer",
"minimum": 0
},
"knownModuleGaps": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"rank",
"slug",
"title",
"category",
"tier",
"summary",
"modules",
"moduleGaps",
"recommendedKit",
"workspaceProfile",
"readiness"
],
"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"
},
"modules": {
"type": "array",
"items": {
"type": "string"
}
},
"moduleGaps": {
"type": "array",
"items": {
"type": "string"
}
},
"recommendedKit": {
"type": "string",
"minLength": 1
},
"workspaceProfile": {
"const": "enterprise"
},
"readiness": {
"type": "object",
"required": [
"status",
"blockingGaps"
],
"properties": {
"status": {
"enum": [
"ready-for-private-manifest",
"blocked-by-module-gaps"
]
},
"blockingGaps": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": true
}