Schema toolInfoProfileSchema.json

Location:	E:\repos\GitHub\Tool-Information-Profiles\stable\toolInfoProfileSchema.json
Version:	latest
Definitions:	toolInfoProfileSchema.json toolInfoProfile rule requirement constraint types attributes

Document schema toolInfoProfileSchema.json

diagram
location	E:\repos\GitHub\Tool-Information-Profiles\stable\toolInfoProfileSchema.json
reference	toolInfoProfile
source code	{     "$schema": "http://json-schema.org/schema#",     "$ref": "#/definitions/toolInfoProfile" }

Schema definition toolInfoProfile

diagram
location	E:\repos\GitHub\Tool-Information-Profiles\stable\toolInfoProfileSchema.json
schema details	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	Name    Occurrence metadata    Required rules    Required
used by	toolInfoProfileSchema.json
source code	"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 }

Property toolInfoProfile / metadata

diagram
property details	Occurrence   Required
schema details	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    Occurrence name    Required description    Required version    Optional comment    Optional schemaVersion    Optional
source code	"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 }

Property toolInfoProfile / metadata / name

diagram
property details	Occurrence   Required
type	String
source code	"name": {     "type": "string" }

Property toolInfoProfile / metadata / description

diagram
property details	Occurrence   Required
type	String
source code	"description": {     "type": "string" }

Property toolInfoProfile / metadata / version

diagram
property details	Occurrence   Optional
type	String
source code	"version": {     "type": "string" }

Property toolInfoProfile / metadata / comment

diagram
property details	Occurrence   Optional
type	String
source code	"comment": {     "type": "string" }

Property toolInfoProfile / metadata / schemaVersion

diagram
property details	Occurrence   Optional
type	String
source code	"schemaVersion": {     "type": "string" }

Property toolInfoProfile / rules

diagram
property details	Occurrence   Required
schema details	Title   Tool information profile rules Description   A set of rules that define the tool information profile.
type	Array
array items	[0]+   rule
source code	"rules": {     "title": "Tool information profile rules",     "description": "A set of rules that define the tool information profile.",     "type": "array",     "items": {         "$ref": "#/definitions/rule"     } }

Schema definition rule

diagram
location	E:\repos\GitHub\Tool-Information-Profiles\stable\toolInfoProfileSchema.json
schema details	Title   Tool information profile rule Description   A rule within the tool information profile.
type	Object
properties	Name    Occurrence attributes    Required constraint    Optional types    Required requirement    Required comment    Optional
used by	toolInfoProfile / rules
source code	"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 }

Property rule / attributes

diagram
property details	Occurrence   Required
reference	attributes
source code	"attributes": {     "$ref": "#/definitions/attributes" }

Property rule / constraint

diagram
property details	Occurrence   Optional
reference	constraint
source code	"constraint": {     "$ref": "#/definitions/constraint" }

Property rule / types

diagram
property details	Occurrence   Required
reference	types
source code	"types": {     "$ref": "#/definitions/types" }

Property rule / requirement

diagram
property details	Occurrence   Required
reference	requirement
source code	"requirement": {     "$ref": "#/definitions/requirement" }

Property rule / comment

diagram
property details	Occurrence   Optional
schema details	Title   Rule comment Description   An optional comment about the rule
type	String
source code	"comment": {     "title": "Rule comment",     "description": "An optional comment about the rule",     "type": "string" }

Schema definition requirement

diagram
location	E:\repos\GitHub\Tool-Information-Profiles\stable\toolInfoProfileSchema.json
schema details	Title   Rule (information requirement) Description   The information requirement for attribute(s) in a rule.
type	String
enumerations	Type    Value string    Mandatory string    Recomended string    Optional string    Not applicable
used by	rule / requirement
source code	"requirement": {     "title": "Rule (information requirement)",     "description": "The information requirement for attribute(s) in a rule.",     "type": "string",     "enum": [         "Mandatory",         "Recomended",         "Optional",         "Not applicable"     ] }

Schema definition constraint

diagram
location	E:\repos\GitHub\Tool-Information-Profiles\stable\toolInfoProfileSchema.json
schema details	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
enumerations	Type    Value string    1 or more string    all
used by	rule / constraint
source code	"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"     ] }

Schema definition types

diagram
location	E:\repos\GitHub\Tool-Information-Profiles\stable\toolInfoProfileSchema.json
schema details	Title   Rule (tool types) Description   Types of tool (defined in biotoolsSchema) which the rule applies to.
type	Array
array constraints	Unique Items   true
array items	[0]+   Schema
used by	rule / types
source code	"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"         ]     } }

Array item wildcard types > array items [0]+ / Schema

diagram
type	String
enumerations	Type    Value string    Bioinformatics portal string    Command-line tool string    Database portal string    Desktop application string    Library string    Ontology string    Plug-in string    Script string    SPARQL endpoint string    Suite string    Web application string    Web API string    Web service string    Workbench string    Workflow
source code	{     "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"     ] }

Schema definition attributes

diagram
location	E:\repos\GitHub\Tool-Information-Profiles\stable\toolInfoProfileSchema.json
schema details	Title   Rule (tool attributes) Description   Tool attributes (defined in biotoolsSchema) that are covered by a rule.
type	Array
array constraints	Unique Items   true
array items	[0]+   Schema
used by	rule / attributes
source code	"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",             "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",             "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"         ]     } }

Array item wildcard attributes > array items [0]+ / Schema

diagram
type	String
enumerations	Type    Value string    name string    description string    homepage string    biotoolsID string    biotoolsCURIE string    version string    otherID string    operation string    inputData string    inputFormat string    outputData string    outputFormat string    functionNote string    functionCmd string    toolType string    topic string    operatingSystem string    language string    license string    collectionID string    maturity string    cost string    accessibility string    elixirPlatform string    elixirNode string    discussionForum string    helpdesk string    issueTracker string    mailingList string    mirror string    softwareCatalogue string    repository string    socialMedia string    service string    galaxyService string    technicalMonitoring string    linkOther string    apiSpecification string    biologicalData string    binaries string    commandlineSpecification string    containerFile string    icon string    screenshot string    sourceCode string    softwarePackage string    testData string    testScript string    toolWrapperCWL string    toolWrapperGalaxy string    toolWrapperTaverna string    toolWrapperOther string    vmImage string    downloadsPage string    downloadsOther string    apiDocumentation string    citationInstructions string    commandlineOptions string    contributionsPolicy string    faq string    generalDocumentation string    governance string    installationInstructions string    userManual string    releaseNotes string    termsOfUse string    trainingMaterial string    documentationOther string    publicationPrimary string    publicationMethod string    publicationUsage string    publicationBenchmarkingStudy string    publicationReview string    publicationOther string    relationIsNewVersionOf string    relationHasNewVersion string    relationUses string    relationUsedBy string    relationIncludes string    relationIncludedIn string    creditPerson string    creditProject string    creditDivision string    creditInstitute string    creditConsortium string    creditFundingAgency string    creditDeveloper string    creditMaintainer string    creditProvider string    creditDocumentor string    creditContributor string    creditSupport string    creditprimaryContact
source code	{     "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",         "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",         "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"     ] }

JSON Schema documentation generated by XMLSpy JSON Schema Editor http://www.altova.com/xmlspy/json-schema-editor.html