catalogue-index.schema.json

This table is generated from contracts/catalogue-index.schema.json.

For what each field means, see the raw schema, which states every rule.

Field	Type	Required	Rules	Description
schema_version	string	yes	enum: ["1"]
generated_at	string	no
catalogue	object	yes	no undeclared keys
catalogue.name	string	yes
catalogue.description	string	no
packs	array of object	yes	items: no undeclared keys
packs[].name	string	yes
packs[].version	string	yes
packs[].scope	string	yes	enum: ["repo", "user"]
packs[].description	string	no
packs[].categories	array of string	no
packs[].adapters	array of string	no
packs[].integrations	array of object	yes	items: no undeclared keys
packs[].integrations[].id	string	yes
packs[].integrations[].pack	string	yes
packs[].integrations[].kind	string	yes	enum: ["input", "augment", "review", "handoff"]
packs[].integrations[].role	string	yes
packs[].integrations_inverse	array of object	yes	items: no undeclared keys
packs[].integrations_inverse[].id	string	yes
packs[].integrations_inverse[].pack	string	yes
packs[].integrations_inverse[].kind	string	yes	enum: ["input", "augment", "review", "handoff"]
packs[].integrations_inverse[].role	string	yes
packs[].journeys	array of object	yes	items: no undeclared keys
packs[].journeys[].journey_id	string	yes
packs[].journeys[].pack	string	yes
packs[].journeys[].start_state	string	yes	enum: ["read-only", "proposed-write", "confirmed-write"]
packs[].journeys[].end_state	string	yes	enum: ["read-only", "proposed-write", "confirmed-write"]
packs[].journeys[].scope	string	yes	enum: ["repo", "user"]
packs[].journeys[].tagline	string	yes
packs[].journeys[].contract	object	yes	no undeclared keys
packs[].journeys[].contract.useItWhen	string	yes
packs[].journeys[].contract.youProvide	string	yes
packs[].journeys[].contract.youReceive	string	yes
packs[].journeys[].contract.yourDecisions	array of string	yes
packs[].journeys[].contract.decisionGateIds	array of string	no
packs[].journeys[].contract.youType	string	no	minLength: 1
packs[].effects	array of object	yes	items: no undeclared keys
packs[].effects[].kind	string	yes	enum: ["file-write", "git-push", "network-call", "shell-exec", "credential-read"]
packs[].effects[].description	string	yes
packs[].content	object	no	no undeclared keys
packs[].content.skills	array of string	no
packs[].content.agents	array of string	no
packs[].content.commands	array of string	no
packs[].content.scripts	array of string	no
packs[].content.hooks	array of string	no
packs[].content.seeds	array of string	no
packs[].content.shared-libs	array of string	no
packs[].content.user-libs	array of string	no
packs[].execution	array of string	no
packs[].documentation	string	no
packs[].digest	string	yes	pattern: ^[a-f0-9]{64}$
profiles	array of object	yes	items: no undeclared keys
profiles[].name	string	yes
profiles[].scope	string	yes	enum: ["user", "repo"]
profiles[].description	string	no
profiles[].packs	array of string	no

See the overview section for this file.