Compatibility / Capability contract
Module Layout V1
Defines the versioned module layout v1 boundary used by Workspai and its consumers.
- Schema version
rapidkit.module-layout.v1- Contract path
contracts/module-layout.v1.json- Publication
- synced-supporting-contract
- Defined fields
- 19
- 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 |
|---|---|---|---|---|
| canonicalModuleRoot | string | Yes | Published canonicalmoduleroot capability data. | — |
| frameworks | object | Yes | Published frameworks capability data. | — |
| frameworks.fastapi | object | Yes | Published fastapi capability data. | — |
| frameworks.fastapi.injectAnchors | array | Yes | Published injectanchors capability data. | — |
| frameworks.fastapi.injectAnchors[] | string | Yes | Published injectanchors[] capability data. | — |
| frameworks.fastapi.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| frameworks.fastapi.moduleMarkerFiles | array | Yes | Published modulemarkerfiles capability data. | — |
| frameworks.fastapi.moduleMarkerFiles[] | string | Yes | Published modulemarkerfiles[] capability data. | — |
| frameworks.nestjs | object | Yes | Published nestjs capability data. | — |
| frameworks.nestjs.injectAnchors | array | Yes | Published injectanchors capability data. | — |
| frameworks.nestjs.injectAnchors[] | string | Yes | Published injectanchors[] capability data. | — |
| frameworks.nestjs.moduleCommands | boolean | Yes | Published modulecommands capability data. | — |
| frameworks.nestjs.moduleMarkerFiles | array | Yes | Published modulemarkerfiles capability data. | — |
| frameworks.nestjs.moduleMarkerFiles[] | string | Yes | Published modulemarkerfiles[] capability data. | — |
| pathPattern | string | Yes | Published pathpattern capability data. | — |
| schemaVersion | string | Yes | Published schemaversion capability data. | — |
| slugPattern | string | Yes | Published slugpattern capability data. | — |
| unsupportedModuleFrameworks | array | Yes | Published unsupportedmoduleframeworks capability data. | — |
| unsupportedModuleFrameworks[] | string | Yes | Published unsupportedmoduleframeworks[] capability data. | — |
Canonical machine-readable definition
The raw synchronized contract remains authoritative. The educational sections above are projections of this definition.
Show raw JSON
{
"schemaVersion": "rapidkit.module-layout.v1",
"canonicalModuleRoot": "src/modules/free",
"pathPattern": "src/modules/free/{category}/{module}",
"slugPattern": "free/{category}/{module}",
"frameworks": {
"fastapi": {
"moduleCommands": true,
"injectAnchors": [
"src/routing/__init__.py",
"src/modules/__init__.py"
],
"moduleMarkerFiles": [
"__init__.py"
]
},
"nestjs": {
"moduleCommands": true,
"injectAnchors": [
"src/app.module.ts",
"src/modules/index.ts"
],
"moduleMarkerFiles": [
"index.ts",
"module.ts"
]
}
},
"unsupportedModuleFrameworks": [
"go",
"springboot",
"dotnet"
]
}