Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@ repos:
- id: check-jsonschema
files: ^[^/]*\.json$
args:
# Using local schema file to avoid caching issues with remote URLs
[
"--schemafile",
"https://raw.githubusercontent.com/Slicer/Slicer/main/Schemas/slicer-extension-catalog-entry-schema-v1.0.1.json",
"schemas/slicer-extension-catalog-entry-schema-v1.0.1.json",
]
- id: check-dependabot
- id: check-github-workflows
73 changes: 73 additions & 0 deletions schemas/slicer-extension-catalog-entry-schema-v1.0.1.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/Slicer/Slicer/main/Schemas/slicer-extension-catalog-entry-schema-v1.0.1.json#",
"type": "object",
"title": "3D Slicer extensions catalog entry schema",
"description": "Schema for storing information about a 3D Slicer extension to allow it to be listed in the extension catalog.",
"required": [
"$schema",
"category",
"scm_url"
],
"additionalProperties": false,
"properties": {
"$schema": {
"$id": "#schema",
"type": "string",
"title": "Schema",
"description": "URL of versioned schema."
},
"category": {
"$id": "#category",
"type": "string",
"title": "Category used to organize the extension in the extension catalog."
},
"scm_url": {
"$id": "#scm_url",
"type": "string",
"title": "Filename or URL of the repository."
},
"scm_revision": {
"$id": "#scm_revision",
"type": "string",
"title": "Hash, branch or tag name to identify the revision within the repository."
},
"scm_type": {
"$id": "#scm_type",
"type": "string",
"title": "Type of revision control system.",
"enum": [
"git",
"local"
],
"default": "git"
},
"build_dependencies": {
"$id": "#build_dependencies",
"type": "array",
"title": "List of extensions required to build this extension.",
"additionalItems": false,
"items": { "type": "string" }
},
"build_subdirectory": {
"$id": "#build_subdirectory",
"type": "string",
"title": "Name of the inner build directory in case of superbuild based extension.",
"default": "."
},
"enabled": {
"$id": "#enabled",
"type": "boolean",
"title": "Specify if the extension should be enabled after its installation.",
"default": true
},
"tier": {
"$id": "#tier",
"type": "integer",
"title": "Maturity and support level of the extension. Higher is better. 1 means experimental, 3 means supported by community, 5 means supported by Slicer core developers.",
"default": 1,
"minimum": 1,
"maximum": 5
}
}
}