Skip to content

Commit

Permalink
rebuild JSON from YAML
Browse files Browse the repository at this point in the history
  • Loading branch information
kba committed Feb 14, 2022
1 parent 544e2e3 commit 3c0ca6d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion bagit-profile.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"BagIt-Profile-Info":{"BagIt-Profile-Identifier":"https://ocr-d.de/bagit-profile.json","BagIt-Profile-Version":"1.2.0","Source-Organization":"OCR-D","External-Description":"BagIt profile for OCR data","Contact-Name":"Konstantin Baierer","Contact-Email":"konstantin.baierer@sbb.spk-berlin.de","Version":0.1},"Bag-Info":{"Bagging-Date":{"required":false},"Source-Organization":{"required":false},"Ocrd-Mets":{"required":false,"default":"mets.xml"},"Ocrd-Manifestation-Depth":{"required":false,"default":"partial","values":["partial","full"]},"Ocrd-Identifier":{"required":true},"Ocrd-Checksum":{"required":false,"default":"cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e"}},"Manifests-Required":["sha512"],"Tag-Manifests-Required":[],"Tag-Files-Required":[],"Tag-Files-Allowed":["README.md","Makefile","build.sh","sources.csv","metadata/*.xml","metadata/*.txt"],"Allow-Fetch.txt":true,"Serialization":"required","Accept-Serialization":"application/zip","Accept-BagIt-Version":["1.0"]}
{"BagIt-Profile-Info": {"BagIt-Profile-Identifier": "https://ocr-d.de/bagit-profile.json", "BagIt-Profile-Version": "1.2.0", "Source-Organization": "OCR-D", "External-Description": "BagIt profile for OCR data", "Contact-Name": "Konstantin Baierer", "Contact-Email": "konstantin.baierer@sbb.spk-berlin.de", "Version": 0.1}, "Bag-Info": {"Bagging-Date": {"required": false}, "Source-Organization": {"required": false}, "Ocrd-Mets": {"required": false, "default": "mets.xml"}, "Ocrd-Manifestation-Depth": {"required": false, "default": "partial", "values": ["partial", "full"]}, "Ocrd-Identifier": {"required": true}, "Ocrd-Checksum": {"required": false, "default": "cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e"}}, "Manifests-Required": ["sha512"], "Tag-Manifests-Required": [], "Tag-Files-Required": [], "Tag-Files-Allowed": ["README.md", "Makefile", "build.sh", "sources.csv", "metadata/*.xml", "metadata/*.txt"], "Allow-Fetch.txt": true, "Serialization": "required", "Accept-Serialization": "application/zip", "Accept-BagIt-Version": ["1.0"]}
2 changes: 1 addition & 1 deletion ocrd_tool.schema.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"type":"object","description":"Schema for tools by OCR-D MP","required":["version","git_url","tools"],"additionalProperties":false,"properties":{"version":{"description":"Version of the tool, expressed as MAJOR.MINOR.PATCH.","type":"string","pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+$"},"git_url":{"description":"Github/Gitlab URL","type":"string","format":"url"},"dockerhub":{"description":"DockerHub image","type":"string"},"tools":{"type":"object","additionalProperties":false,"patternProperties":{"ocrd-.*":{"type":"object","additionalProperties":false,"required":["description","steps","executable","categories","input_file_grp"],"properties":{"executable":{"description":"The name of the CLI executable in $PATH","type":"string"},"input_file_grp":{"description":"Input fileGrp@USE this tool expects by default","type":"array","items":{"type":"string","pattern":"^OCR-D-[A-Z0-9-]+$"}},"output_file_grp":{"description":"Output fileGrp@USE this tool produces by default","type":"array","items":{"type":"string","pattern":"^OCR-D-[A-Z0-9-]+$"}},"parameters":{"description":"Object describing the parameters of a tool. Keys are parameter names, values sub-schemas.","type":"object","patternProperties":{".*":{"type":"object","additionalProperties":false,"required":["description","type"],"properties":{"type":{"type":"string","description":"Data type of this parameter","enum":["string","number","boolean","object","array"]},"format":{"description":"Subtype, such as `float` for type `number` or `uri` for type `string`."},"description":{"description":"Concise description of syntax and semantics of this parameter"},"required":{"type":"boolean","description":"Whether this parameter is required"},"default":{"description":"Default value when not provided by the user"},"enum":{"type":"array","description":"List the allowed values if a fixed list."},"content-type":{"type":"string","description":"If parameter is reference to file: Media type of the file"},"cacheable":{"type":"boolean","description":"If parameter is reference to file: Whether the file should be cached, e.g. because it is large and won't change.","default":false}}}}},"description":{"description":"Concise description what the tool does"},"categories":{"description":"Tools belong to this categories, representing modules within the OCR-D project structure","type":"array","items":{"type":"string","enum":["Image preprocessing","Layout analysis","Text recognition and optimization","Model training","Long-term preservation","Quality assurance"]}},"steps":{"description":"This tool can be used at these steps in the OCR-D functional model","type":"array","items":{"type":"string","enum":["preprocessing/characterization","preprocessing/optimization","preprocessing/optimization/cropping","preprocessing/optimization/deskewing","preprocessing/optimization/despeckling","preprocessing/optimization/dewarping","preprocessing/optimization/binarization","preprocessing/optimization/grayscale_normalization","recognition/text-recognition","recognition/font-identification","recognition/post-correction","layout/segmentation","layout/segmentation/text-nontext","layout/segmentation/region","layout/segmentation/line","layout/segmentation/word","layout/segmentation/classification","layout/analysis"]}}}}}}}}
{"type": "object", "description": "Schema for tools by OCR-D MP", "required": ["version", "git_url", "tools"], "additionalProperties": false, "properties": {"version": {"description": "Version of the tool, expressed as MAJOR.MINOR.PATCH.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"}, "git_url": {"description": "Github/Gitlab URL", "type": "string", "format": "url"}, "dockerhub": {"description": "DockerHub image", "type": "string"}, "tools": {"type": "object", "additionalProperties": false, "patternProperties": {"ocrd-.*": {"type": "object", "additionalProperties": false, "required": ["description", "steps", "executable", "categories", "input_file_grp"], "properties": {"executable": {"description": "The name of the CLI executable in $PATH", "type": "string"}, "input_file_grp": {"description": "Input fileGrp@USE this tool expects by default", "type": "array", "items": {"type": "string", "pattern": "^OCR-D-[A-Z0-9-]+$"}}, "output_file_grp": {"description": "Output fileGrp@USE this tool produces by default", "type": "array", "items": {"type": "string", "pattern": "^OCR-D-[A-Z0-9-]+$"}}, "parameters": {"description": "Object describing the parameters of a tool. Keys are parameter names, values sub-schemas.", "type": "object", "patternProperties": {".*": {"type": "object", "additionalProperties": false, "required": ["description", "type"], "properties": {"type": {"type": "string", "description": "Data type of this parameter", "enum": ["string", "number", "boolean", "object", "array"]}, "format": {"description": "Subtype, such as `float` for type `number` or `uri` for type `string`."}, "description": {"description": "Concise description of syntax and semantics of this parameter"}, "required": {"type": "boolean", "description": "Whether this parameter is required"}, "default": {"description": "Default value when not provided by the user"}, "enum": {"type": "array", "description": "List the allowed values if a fixed list."}, "content-type": {"type": "string", "default": "application/octet-stream", "description": "The media type of resources this processor expects for this parameter. Most processors use files for resources (e.g. `*.traineddata` for `ocrd-tesserocr-recognize`) while others use directories of files (e.g. `default` for `ocrd-eynollah-segment`). If a parameter requires directories, it must set `content-type` to `text/directory`.\n"}, "cacheable": {"type": "boolean", "description": "If parameter is reference to file: Whether the file should be cached, e.g. because it is large and won't change.", "default": false}}}}}, "description": {"description": "Concise description what the tool does"}, "categories": {"description": "Tools belong to this categories, representing modules within the OCR-D project structure", "type": "array", "items": {"type": "string", "enum": ["Image preprocessing", "Layout analysis", "Text recognition and optimization", "Model training", "Long-term preservation", "Quality assurance"]}}, "steps": {"description": "This tool can be used at these steps in the OCR-D functional model", "type": "array", "items": {"type": "string", "enum": ["preprocessing/characterization", "preprocessing/optimization", "preprocessing/optimization/cropping", "preprocessing/optimization/deskewing", "preprocessing/optimization/despeckling", "preprocessing/optimization/dewarping", "preprocessing/optimization/binarization", "preprocessing/optimization/grayscale_normalization", "recognition/text-recognition", "recognition/font-identification", "recognition/post-correction", "layout/segmentation", "layout/segmentation/text-nontext", "layout/segmentation/region", "layout/segmentation/line", "layout/segmentation/word", "layout/segmentation/classification", "layout/analysis"]}}, "resource_locations": {"type": "array", "description": "The locations in the filesystem this processor supports for resource lookup", "default": ["data", "cwd", "system", "module"], "items": {"type": "string", "enum": ["data", "cwd", "system", "module"]}}, "resources": {"type": "array", "description": "Resources for this processor", "items": {"type": "object", "additionalProperties": false, "required": ["url", "description", "name", "size"], "properties": {"url": {"type": "string", "description": "URLs of all components of this resource"}, "description": {"type": "string", "description": "A description of the resource"}, "name": {"type": "string", "description": "Name to store the resource as"}, "type": {"type": "string", "enum": ["file", "directory", "archive"], "default": "file", "description": "Type of the URL"}, "parameter_usage": {"type": "string", "description": "Defines how the parameter is to be used", "enum": ["as-is", "without-extension"], "default": "as-is"}, "path_in_archive": {"type": "string", "description": "if type is archive, the resource is at this location in the archive", "default": "."}, "version_range": {"type": "string", "description": "Range of supported versions, syntax like in PEP 440", "default": ">= 0.0.1"}, "size": {"type": "number", "description": "Size of the resource in bytes"}}}}}}}}}}

0 comments on commit 3c0ca6d

Please sign in to comment.