toolInfoProfileSchema_dev.json

{
    "$schema": "http://json-schema.org/schema#",
    "$ref": "#/definitions/toolInfoProfile",
    "definitions":
    {
	"toolInfoProfile":
	{
	    "title": "Tool information profile schema",
	    "description": "A JSON schema which specifies which tool attributes - defined in biotoolsSchema - should be specified within a set of tool descriptions.",
	    "type": "object",
	    "properties":
	    {
		"metadata":
		{
		    "title": "Tool information profile metadata",
		    "description": "Metadata about the tool information profile. Use 'version' for an (optional) profile version number and 'schemaVersion' for the version of toolInfoProfileSchema that the profile conforms to.",
		    "type": "object",
		    "properties":
		    {
			"name":
			{
			    "type": "string"
			},
			"description":
			{
			    "type": "string"
			},
			"version":
			{
			    "type": "string"
			},
			"comment":
			{
			    "type": "string"
			},
    			"schemaVersion":
			{
			    "type": "string"
			}
		    },
		    "required":
		    [
			"name",
			"description"
		    ],
	    "additionalProperties": false
		    
		},
		"rules":
		{
		    "title": "Tool information profile rules",
		    "description": "A set of rules that define the tool information profile.",
		    "type": "array",
		    "items": {
			"$ref": "#/definitions/rule"
		    }
		}
	    },
	    "required":
	    [
		"metadata",
		"rules"
	    ],
	    "additionalProperties": false
	},
	    "rule": {
	    	   "title": "Tool information profile rule",
		    "description": "A rule within the tool information profile.",
		"type": "object",
		"properties": {
		    "attributes": {
			"$ref": "#/definitions/attributes"
		    },
		    "constraint": {
			"$ref": "#/definitions/constraint"
		    },
		    "types": {
			"$ref": "#/definitions/types"
		    },
		    "requirement": {
			"$ref": "#/definitions/requirement"
		    },
		    "comment": {
			"title": "Rule comment",
			"description": "An optional comment about the rule",
			"type": "string"
		    }
		},
		"required": [
		    "attributes",
		    "types",
		    "requirement"
		],
		"additionalProperties": false
	    },
	    "requirement": {
		"title": "Rule (information requirement)",
		"description": "The information requirement for attribute(s) in a rule.",
		"type": "string",
		"enum": [
		    "Mandatory",
		    "Recomended",
		    "Optional",
		    "Not applicable"
		]
	    },
	    "constraint": {
		"title": "Rule (tool attribute constraints)",
		"description": "Whther a rule must be applied to (satisfied by) at least 1, or all, of the attributes.",
		"type": "string",
		"enum": [
		    "1 or more",
		    "all"
		]
	    },
	    "types": {
		"title": "Rule (tool types)",
		"description": "Types of tool (defined in biotoolsSchema) which the rule applies to.",
		"type": "array",
		"uniqueItems": true,
		"items": {
		    "type": "string",
		    "enum": [
			"Bioinformatics portal",
			"Command-line tool",
			"Database portal",
			"Desktop application",
			"Library",
			"Ontology",
			"Plug-in",
			"Script",
			"SPARQL endpoint",
			"Suite",
			"Web application",
			"Web API",
			"Web service",
			"Workbench",
			"Workflow"
		    ]
		}
	    },
	    "attributes": {
		"title": "Rule (tool attributes)",
		"description": "Tool attributes (defined in biotoolsSchema) that are covered by a rule.",
		"type": "array",
		"uniqueItems": true,
		"items": {
		    "type": "string",
		    "enum": [
			"name",
			"description",
			"homepage",
			"biotoolsID",
			"biotoolsCURIE",
			"version",
			"otherID",
			"operation",
			"inputData",
			"inputFormat",
			"outputData",
			"outputFormat",
			"functionNote",
			"functionCmd",
			"toolType",
			"topic",
			"operatingSystem",
			"language",
			"license",
			"collectionID",
			"maturity",
			"cost",
			"accessibility",
			"elixirPlatform",
			"elixirNode",
			"elixirCommunity",
			"discussionForum",
			"helpdesk",
			"issueTracker",
			"mailingList",
			"mirror",
			"softwareCatalogue",
			"repository",
			"socialMedia",
			"service",
			"galaxyService",
			"technicalMonitoring",
			"linkOther",
			"apiSpecification",
			"biologicalData",
			"binaries",
			"commandlineSpecification",
			"containerFile",
			"icon",
			"screenshot",
			"sourceCode",
			"softwarePackage",
			"testData",
			"testScript",
			"toolWrapperCWL",
			"toolWrapperGalaxy",
			"toolWrapperTaverna",
			"toolWrapperOther",
			"vmImage",
			"downloadsPage",
			"downloadsOther",
			"apiDocumentation",
			"citationInstructions",
			"commandlineOptions",
			"contributionsPolicy",
			"faq",
			"quickStartGuide",
			"generalDocumentation",
			"governance",
			"installationInstructions",
			"userManual",
			"releaseNotes",
			"termsOfUse",
			"trainingMaterial",
			"documentationOther",
			"publicationPrimary",
			"publicationMethod",
			"publicationUsage",
			"publicationBenchmarkingStudy",
			"publicationReview",
			"publicationOther",
			"relationIsNewVersionOf",
			"relationHasNewVersion",
			"relationUses",
			"relationUsedBy",
			"relationIncludes",
			"relationIncludedIn",
			"creditPerson",
			"creditProject",
			"creditDivision",
			"creditInstitute",
			"creditConsortium",
			"creditFundingAgency",
			"creditDeveloper",
			"creditMaintainer",
			"creditProvider",
			"creditDocumentor",
			"creditContributor",
			"creditSupport",
			"creditprimaryContact"
		    ]
		}
	    }
	}
    }