This repository has been archived by the owner on Aug 20, 2024. It is now read-only.
forked from nextflow-io/nf-schema
-
Notifications
You must be signed in to change notification settings - Fork 19
Parameters meta-schema - first draft #133
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema", | ||
| "$id": "https://nextflow.io", | ||
| "title": "Nextflow Schema Meta-schema", | ||
| "description": "Meta-schema to validate Nextflow parameter schema files", | ||
| "type": "object", | ||
| "properties": { | ||
| "$schema": { | ||
| "title": "schema", | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "$id": { | ||
| "title": "ID URI", | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "title": { | ||
| "title": "Title", | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "description": { | ||
| "title": "Description", | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "type": { | ||
| "title": "Top level type", | ||
| "type": "string", | ||
| "const": "object" | ||
| }, | ||
| "definitions": { | ||
| "title": "Parameter groups", | ||
| "type": "object", | ||
| "patternProperties": { | ||
| "^.*$": { | ||
| "type": "object", | ||
| "required": [ | ||
| "title", | ||
| "type", | ||
| "properties" | ||
| ], | ||
| "properties": { | ||
| "title": { | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "type": { | ||
| "const": "object" | ||
| }, | ||
| "fa_icon": { | ||
| "type": "string", | ||
| "pattern": "^fa" | ||
| }, | ||
| "description": { | ||
| "type": "string" | ||
| }, | ||
| "required": { | ||
| "type": "array" | ||
| }, | ||
| "properties": { | ||
| "type": "object", | ||
| "patternProperties": { | ||
| "^.*$": { | ||
| "type": "object", | ||
| "required": [ | ||
| "type" | ||
| ], | ||
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "enum": ["string", "boolean", "integer", "number"] | ||
| }, | ||
| "format": { | ||
| "type": "string", | ||
| "enum": ["file-path", "directory-path", "path", "file-path-pattern"] | ||
| }, | ||
| "exists": { | ||
| "type": "boolean" | ||
| }, | ||
| "mimetype": { | ||
| "type": "string", | ||
| "pattern": ".+/.+" | ||
| }, | ||
| "pattern": { | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "schema": { | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "description": { | ||
| "type": "string" | ||
| }, | ||
| "help_text": { | ||
| "type": "string" | ||
| }, | ||
| "fa_icon": { | ||
| "type": "string", | ||
| "pattern": "^fa" | ||
| }, | ||
| "errorMessage": { | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "hidden": { | ||
| "type": "boolean" | ||
| }, | ||
| "minLength": { | ||
| "type": "integer" | ||
| }, | ||
| "maxLength": { | ||
| "type": "integer" | ||
| }, | ||
| "minimum": { | ||
| "type": "integer" | ||
| }, | ||
| "maximum": { | ||
| "type": "integer" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "allOf": { | ||
| "title": "Combine definition groups", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "required": [ | ||
| "$ref" | ||
| ], | ||
| "properties": { | ||
| "$ref": { | ||
| "type": "string", | ||
| "pattern": "^#/definitions/" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "$schema", | ||
| "$id", | ||
| "title", | ||
| "description", | ||
| "type" | ||
| ] | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how about adding a description with a link to fontaweseome?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Description is a Nextflow schema thing, not a JSON schema thing (it's a non-standard field).
We already document it here: https://nextflow-io.github.io/nf-validation/nextflow_schema/nextflow_schema_specification/#fa_icon