Feed Schema
Patch Extend is currently in beta and available for testing. We're actively refining the feature and building out comprehensive documentation. We recommend evaluating it in a test environment before deploying to production, and we welcome your feedback as we continue to improve!
What this schema covers​
patch-extend-feed.schema.json describes a Patch Extend feed envelope (schemaVersion, feedId, payload.apps, …)—the wire shape Patch loads from a file or HTTPS URI.
It does not describe the built-in Alectrona Patch software catalog API.
Download​
- Schema: patch-extend-feed.schema.json
- Example feeds: see Author a feed
Validate a feed instance​
Check that your feed JSON matches the published schema (shape only—this does not configure Patch or resolve apps). Validate every complete feed file you publish. Do not pass the schema file itself as a feed instance.
Pick any of these approaches:
- check-jsonschema (uv)
- check-jsonschema (pipx)
- ajv-cli (npx)
Requires uv. uvx runs the tool in an isolated environment (similar to npx). If Patch is already installed, you can install uv with sudo patch install uv.
uvx check-jsonschema \
--schemafile patch-extend-feed.schema.json \
your-feed.json
Requires pipx.
pipx run check-jsonschema \
--schemafile patch-extend-feed.schema.json \
your-feed.json
Requires Node.js / npm. The published schema is JSON Schema Draft 2020-12, so pass --spec=draft2020. Without that flag, ajv-cli fails looking up the 2020-12 meta-schema.
npx --yes ajv-cli@5 validate \
--spec=draft2020 \
--strict=false \
-s patch-extend-feed.schema.json \
-d your-feed.json
You may see warnings about the date-time format on generatedAt; with --strict=false a valid feed still reports as valid.