Schemas used to validate files.

renovate[bot] b0f498daf8 chore(deps): update dependency got to v14.2.0 9 months ago
.github fa765fc053 chore(deps): update actions/setup-node action to v4 (#146) 1 year ago
schemas 5bd37986b4 wip: 1.10 9 months ago
server f4fbdb810f chore(deps): update dependency @vitest/ui to v1 (#148) 11 months ago
.dockerignore bec5700ded chore: update schemas 1 year ago
.editorconfig bec5700ded chore: update schemas 1 year ago
.eslintrc.cjs bec5700ded chore: update schemas 1 year ago
.gitattributes bec5700ded chore: update schemas 1 year ago
.gitignore b8dba22926 🔄 Created local '.gitignore' from remote '.gitignore' 2 years ago
.prettierignore bec5700ded chore: update schemas 1 year ago
.prettierrc.cjs bec5700ded chore: update schemas 1 year ago
Dockerfile 0a34cb8bd4 chore: fix ci 1 year ago
LICENSE 1411a53328 🔄 Synced local 'LICENSE' with remote 'LICENSE' 2 years ago
README.md bec5700ded chore: update schemas 1 year ago
package.json 928e6ebcb3 chore: update version 1 year ago
pnpm-lock.yaml b0f498daf8 chore(deps): update dependency got to v14.2.0 9 months ago
pnpm-workspace.yaml bec5700ded chore: update schemas 1 year ago
renovate.json 73f119b96f move renovate 1 year ago

README.md

PreMiD Schemas

This repository contains the schemas used to validate various files over the PreMiD source code repositories. If you have found a problem with a schema, please feel free to open a pull request.

Schema versioning

Schemas are versioned using MAJOR.MINOR. Patches are applied directly to the applicable version of the schema. Minor is bumped when a new property is added and it can be extended from a previous version of the schema. Major is bumped when properties are removed or the new iteration of the schema cannot be extended from the previous version.

schemas.premid.app

All schemas are hosted under schemas.premid.app. To use a schema, use https://schemas.premid.app/:schemaName/:version as the URL. :schemaName is the name of the thing you need the schema for (e.g. metadata) and :version is the version of the schema (e.g. 1.0).

Folder structure

schemas # where the schemas are stored
├── schemaName # the name of the schema
│   ├── version.json # the schema file itself, where the name is the version
│   └── README.md # simple README to document version changelogs and what the schema is for
server # schema server files