Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
0.5.2.json
policyurl
URL to your privacy policy description
{}
0.5.2.json
techDetails
Technical details of your community's Freifunk implementation
{"type": "object", "properties": {"firmware": {"type": "object", "properties": {"url": {}, "docs": {}, "vpnaccess": {"type": "string", "enum": ["", "automatic", "fwimage", "mail", "webform", "else"], "default": ""}, "registrationurl": {}, "orgrestrictions": {"type": "string"}, "techrestrictions": {"type": "string"}, "name": {"type": "string"}}, "additionalProperties": false}, "dns": {"type": "array", "items": {"type": "object", "properties": {"domainname": {"type": "string", "pattern": "^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df\\.\\-\\_]{2,}$"}, "nameserver": {"type": "array", "items": {"type": "string", "pattern": "^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df_\\-\\.:]*$"}}}, "additionalProperties": false}}, "networks": {"type": "object", "properties": {"ipv6": {"type": "array", "items": {"type": "object", "properties": {"network": {"type": "string", "pattern": "^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/(\\d|\\d\\d|1[0-1]\\d|12[0-8]))$"}}, "additionalProperties": false}}, "ipv4": {"type": "array", "items": {"type": "object", "properties": {"network": {"type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(\\d|[1-2]\\d|3[0-2]))$"}}, "additionalProperties": false}}}, "additionalProperties": false}, "routing": {"type": "array", "items": {"type": "string", "enum": ["802.11s", "Babel", "batman-adv", "bmx6", "bmxd", "cjdns", "OLSR", "OLSRv2"]}}, "legals": {"type": "array", "items": {"type": "string", "enum": ["nothing", "vpnnational", "vpninternational", "zappscript", "p2pblock", "splashpage", "termsconditions", "anonymizer", "institutions"]}}, "updatemode": {"type": "array", "items": {"type": "string", "enum": ["none", "manual", "autoupdate"]}}}, "additionalProperties": false}
0.5.2.json
url
Link to your firmware images
{}
0.5.2.json
docs
Link to your firmware docs
{}
0.5.2.json
vpnaccess
How to access your VPN services
{"type": "string", "enum": ["", "automatic", "fwimage", "mail", "webform", "else"], "default": ""}
0.5.2.json
registrationurl
link to your website to request a new VPN key
{}
0.5.2.json
orgrestrictions
Are there any organizational restrictions when using/installing your firmware?
{"type": "string"}
0.5.2.json
techrestrictions
Are there any technical restrictions like hardware?
{"type": "string"}
0.5.2.json
name
Name of your firmware
{"type": "string"}
0.5.2.json
dns
DNS servers for domains used by your community
{"type": "array", "items": {"type": "object", "properties": {"domainname": {"type": "string", "pattern": "^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df\\.\\-\\_]{2,}$"}, "nameserver": {"type": "array", "items": {"type": "string", "pattern": "^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df_\\-\\.:]*$"}}}, "additionalProperties": false}}
0.5.2.json
domainname
The domain name (e.g. ffhh, ffol)
{"type": "string", "pattern": "^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df\\.\\-\\_]{2,}$"}
0.5.2.json
nameserver
Nameservers servings zones of your domain
{"type": "array", "items": {"type": "string", "pattern": "^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df_\\-\\.:]*$"}}
0.5.2.json
networks
Networks used by your community
{"type": "object", "properties": {"ipv6": {"type": "array", "items": {"type": "object", "properties": {"network": {"type": "string", "pattern": "^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/(\\d|\\d\\d|1[0-1]\\d|12[0-8]))$"}}, "additionalProperties": false}}, "ipv4": {"type": "array", "items": {"type": "object", "properties": {"network": {"type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(\\d|[1-2]\\d|3[0-2]))$"}}, "additionalProperties": false}}}, "additionalProperties": false}
0.5.2.json
ipv6
IPv6 networks used by your community
{"type": "array", "items": {"type": "object", "properties": {"network": {"type": "string", "pattern": "^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/(\\d|\\d\\d|1[0-1]\\d|12[0-8]))$"}}, "additionalProperties": false}}
0.5.2.json
network
IPv6 network network (e.g.2620:0:2d0:200::7/32) in CIDR notation
{"type": "string", "pattern": "^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/(\\d|\\d\\d|1[0-1]\\d|12[0-8]))$"}
0.5.2.json
ipv4
IPv4 networks used by your community
{"type": "array", "items": {"type": "object", "properties": {"network": {"type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(\\d|[1-2]\\d|3[0-2]))$"}}, "additionalProperties": false}}
0.5.2.json
network
IPv4 network name (e.g. 10.w.x.y/z) in CIDR notation
{"type": "string", "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(\\d|[1-2]\\d|3[0-2]))$"}
0.5.2.json
routing
Routing protocols used within your community
{"type": "array", "items": {"type": "string", "enum": ["802.11s", "Babel", "batman-adv", "bmx6", "bmxd", "cjdns", "OLSR", "OLSRv2"]}}
0.5.2.json
legals
What do you use to handle legal issues, e.g. the German Störerhaftung or restrictions in your country?
{"type": "array", "items": {"type": "string", "enum": ["nothing", "vpnnational", "vpninternational", "zappscript", "p2pblock", "splashpage", "termsconditions", "anonymizer", "institutions"]}}
0.5.2.json
updatemode
How do you deploy firmware updates?
{"type": "array", "items": {"type": "string", "enum": ["none", "manual", "autoupdate"]}}
sourcery_yaml_schema.json
RuleType
An enumeration.
{"enum": ["refactoring", "suggestion", "comment", "hover"]}
sourcery_yaml_schema.json
disable
A list of rule IDs Sourcery will never suggest.
{"default": [], "type": "array", "items": {"type": "string"}}
sourcery_yaml_schema.json
python_version
A string specifying the lowest Python version your project supports. Sourcery will not suggest refactorings requiring a higher Python version.
{"anyOf": [{"type": "string"}, {}]}
sourcery_yaml_schema.json
RuleLanguage
An enumeration.
{"enum": ["python", "java", "javascript", "typescript"], "type": "string"}
sourcery_yaml_schema.json
version
The schema version of this config file
{"default": "1", "type": "string"}
sourcery_yaml_schema.json
ignore
A list of paths or files which Sourcery will ignore.
{"default": [], "type": "array", "items": {"type": "string"}}
sourcery_yaml_schema.json
rules
A list of custom rules Sourcery will include in its analysis.
{"default": [], "type": "array", "items": {}}
sourcery_yaml_schema.json
rule_tags
Additional rule tags.
{"default": {}, "type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}
catalog-info.json
An API describes an interface that can be exposed by a component. The API can be defined in different formats, like OpenAPI, AsyncAPI, GraphQL, gRPC, or other formats.
{"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1alpha1", "kind": "API", "metadata": {"name": "artist-api", "labels": {"product_name": "Random value Generator"}, "annotations": {"docs": "https://github.com/..../tree/develop/doc"}}, "spec": {"type": "openapi", "lifecycle": "production", "owner": "artist-relations-team", "system": "artist-engagement-portal", "definition": "openapi: \"3.0.0\"\ninfo:..."}}], "allOf": [{}, {"type": "object", "required": ["spec"], "properties": {"apiVersion": {"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]}, "kind": {"enum": ["API"]}, "spec": {"type": "object", "required": ["type", "lifecycle", "owner", "definition"], "properties": {"type": {"type": "string", "examples": ["openapi", "asyncapi", "graphql", "grpc"], "minLength": 1}, "lifecycle": {"type": "string", "examples": ["experimental", "production", "deprecated"], "minLength": 1}, "owner": {"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}, "system": {"type": "string", "minLength": 1}, "definition": {"type": ["string", "object"], "minLength": 1, "properties": {"$text": {"type": "string", "minLength": 1}, "$json": {"type": "string", "minLength": 1}, "$yaml": {"type": "string", "minLength": 1}}, "minProperties": 1, "maxProperties": 1}}}}}]}
catalog-info.json
metadata
Retrieve artist details
{"name": "artist-api", "labels": {"product_name": "Random value Generator"}, "annotations": {"docs": "https://github.com/..../tree/develop/doc"}}
catalog-info.json
type
The type of the API definition.
{"type": "string", "examples": ["openapi", "asyncapi", "graphql", "grpc"], "minLength": 1}
catalog-info.json
lifecycle
The lifecycle state of the API.
{"type": "string", "examples": ["experimental", "production", "deprecated"], "minLength": 1}
catalog-info.json
owner
An entity reference to the owner of the API.
{"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}
catalog-info.json
system
An entity reference to the system that the API belongs to.
{"type": "string", "minLength": 1}
catalog-info.json
definition
The definition of the API, based on the format defined by the type.
{"type": ["string", "object"], "minLength": 1, "properties": {"$text": {"type": "string", "minLength": 1}, "$json": {"type": "string", "minLength": 1}, "$yaml": {"type": "string", "minLength": 1}}, "minProperties": 1, "maxProperties": 1}
catalog-info.json
$text
Interprets the contents of the referenced file as plain text and embeds it as a string.
{"type": "string", "minLength": 1}
catalog-info.json
$json
Interprets the contents of the referenced file as JSON and embeds the parsed structure.
{"type": "string", "minLength": 1}
catalog-info.json
$yaml
Interprets the contents of the referenced file as YAML and embeds the parsed structure.
{"type": "string", "minLength": 1}
catalog-info.json
A Component describes a software component. It is typically intimately linked to the source code that constitutes the component, and should be what a developer may regard a "unit of software", usually with a distinct deployable or linkable artifact.
{"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1alpha1", "kind": "Component", "metadata": {"name": "LoremService", "labels": {"product_name": "Random value Generator"}, "annotations": {"docs": "https://github.com/..../tree/develop/doc"}}, "spec": {"type": "service", "lifecycle": "production", "owner": "tools"}}], "allOf": [{}, {"type": "object", "required": ["spec"], "properties": {"apiVersion": {"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]}, "kind": {"enum": ["Component"]}, "spec": {"type": "object", "required": ["type", "lifecycle", "owner"], "properties": {"type": {"type": "string", "examples": ["service", "website", "library"], "minLength": 1}, "lifecycle": {"type": "string", "examples": ["experimental", "production", "deprecated"], "minLength": 1}, "owner": {"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}, "system": {"type": "string", "minLength": 1}, "subcomponentOf": {"type": "string", "minLength": 1}, "providesApis": {"type": "array", "items": {"type": "string", "minLength": 1}}, "consumesApis": {"type": "array", "items": {"type": "string", "minLength": 1}}, "dependsOn": {"type": "array", "items": {"type": "string", "minLength": 1}}}}}}]}
catalog-info.json
metadata
Creates Lorems like a pro.
{"name": "LoremService", "labels": {"product_name": "Random value Generator"}, "annotations": {"docs": "https://github.com/..../tree/develop/doc"}}
catalog-info.json
type
The type of component.
{"type": "string", "examples": ["service", "website", "library"], "minLength": 1}
catalog-info.json
lifecycle
The lifecycle state of the component.
{"type": "string", "examples": ["experimental", "production", "deprecated"], "minLength": 1}
catalog-info.json
owner
An entity reference to the owner of the component.
{"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}
catalog-info.json
system
An entity reference to the system that the component belongs to.
{"type": "string", "minLength": 1}
catalog-info.json
subcomponentOf
An entity reference to another component of which the component is a part.
{"type": "string", "minLength": 1}
catalog-info.json
providesApis
An array of entity references to the APIs that are provided by the component.
{"type": "array", "items": {"type": "string", "minLength": 1}}
catalog-info.json
consumesApis
An array of entity references to the APIs that are consumed by the component.
{"type": "array", "items": {"type": "string", "minLength": 1}}
catalog-info.json
dependsOn
An array of references to other entities that the component depends on to function.
{"type": "array", "items": {"type": "string", "minLength": 1}}
catalog-info.json
A Domain groups a collection of systems that share terminology, domain models, business purpose, or documentation, i.e. form a bounded context.
{"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1alpha1", "kind": "Domain", "metadata": {"name": "artists"}, "spec": {"owner": "artist-relations-team"}}], "allOf": [{}, {"type": "object", "required": ["spec"], "properties": {"apiVersion": {"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]}, "kind": {"enum": ["Domain"]}, "spec": {"type": "object", "required": ["owner"], "properties": {"owner": {"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}}}}}]}
catalog-info.json
metadata
Everything about artists
{"name": "artists"}
catalog-info.json
owner
An entity reference to the owner of the component.
{"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}
catalog-info.json
A group describes an organizational entity, such as for example a team, a business unit, or a loose collection of people in an interest group. Members of these groups are modeled in the catalog as kind User.
{"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1alpha1", "kind": "Group", "metadata": {"name": "infrastructure"}, "spec": {"type": "business-unit", "profile": {"displayName": "Infrastructure", "email": "[email protected]", "picture": "https://example.com/groups/bu-infrastructure.jpeg"}, "parent": "ops", "children": ["backstage", "other"]}}], "allOf": [{}, {"type": "object", "required": ["spec"], "properties": {"apiVersion": {"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]}, "kind": {"enum": ["Group"]}, "spec": {"type": "object", "required": ["type", "children"], "properties": {"type": {"type": "string", "examples": ["team", "business-unit", "product-area", "root"], "minLength": 1}, "profile": {"type": "object", "properties": {"displayName": {"type": "string", "examples": ["Infrastructure"], "minLength": 1}, "email": {"type": "string", "examples": ["[email protected]"], "minLength": 1}, "picture": {"type": "string", "examples": ["https://example.com/groups/bu-infrastructure.jpeg"], "minLength": 1}}}, "parent": {"type": "string", "examples": ["ops"], "minLength": 1}, "children": {"type": "array", "items": {"type": "string", "examples": ["backstage", "other"], "minLength": 1}}, "members": {"type": "array", "items": {"type": "string", "examples": ["jdoe"], "minLength": 1}}}}}}]}
catalog-info.json
metadata
The infra business unit
{"name": "infrastructure"}
catalog-info.json
type
The type of group. There is currently no enforced set of values for this field, so it is left up to the adopting organization to choose a nomenclature that matches their org hierarchy.
{"type": "string", "examples": ["team", "business-unit", "product-area", "root"], "minLength": 1}
catalog-info.json
profile
Optional profile information about the group, mainly for display purposes. All fields of this structure are also optional. The email would be a group email of some form, that the group may wish to be used for contacting them. The picture is expected to be a URL pointing to an image that's representative of the group, and that a browser could fetch and render on a group page or similar.
{"type": "object", "properties": {"displayName": {"type": "string", "examples": ["Infrastructure"], "minLength": 1}, "email": {"type": "string", "examples": ["[email protected]"], "minLength": 1}, "picture": {"type": "string", "examples": ["https://example.com/groups/bu-infrastructure.jpeg"], "minLength": 1}}}
catalog-info.json
displayName
A simple display name to present to users.
{"type": "string", "examples": ["Infrastructure"], "minLength": 1}
catalog-info.json
email
An email where this entity can be reached.
{"type": "string", "examples": ["[email protected]"], "minLength": 1}
catalog-info.json
picture
The URL of an image that represents this entity.
{"type": "string", "examples": ["https://example.com/groups/bu-infrastructure.jpeg"], "minLength": 1}
catalog-info.json
parent
The immediate parent group in the hierarchy, if any. Not all groups must have a parent; the catalog supports multi-root hierarchies. Groups may however not have more than one parent. This field is an entity reference.
{"type": "string", "examples": ["ops"], "minLength": 1}
catalog-info.json
children
The immediate child groups of this group in the hierarchy (whose parent field points to this group). The list must be present, but may be empty if there are no child groups. The items are not guaranteed to be ordered in any particular way. The entries of this array are entity references.
{"type": "array", "items": {"type": "string", "examples": ["backstage", "other"], "minLength": 1}}
catalog-info.json
members
The users that are members of this group. The entries of this array are entity references.
{"type": "array", "items": {"type": "string", "examples": ["jdoe"], "minLength": 1}}
catalog-info.json
A location is a marker that references other places to look for catalog data.
{"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1alpha1", "kind": "Location", "metadata": {"name": "org-data"}, "spec": {"type": "url", "targets": ["http://github.com/myorg/myproject/org-data-dump/catalog-info-staff.yaml", "http://github.com/myorg/myproject/org-data-dump/catalog-info-consultants.yaml"]}}], "allOf": [{}, {"type": "object", "required": ["spec"], "properties": {"apiVersion": {"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]}, "kind": {"enum": ["Location"]}, "spec": {"type": "object", "required": [], "properties": {"type": {"type": "string", "examples": ["url"], "minLength": 1}, "target": {"type": "string", "examples": ["./details/catalog-info.yaml"], "minLength": 1}, "targets": {"type": "array", "items": {"type": "string", "examples": ["./details/catalog-info.yaml", "http://github.com/myorg/myproject/org-data-dump/catalog-info-staff.yaml"], "minLength": 1}}}}}}]}
catalog-info.json
type
The single location type, that's common to the targets specified in the spec. If it is left out, it is inherited from the location type that originally read the entity data.
{"type": "string", "examples": ["url"], "minLength": 1}
catalog-info.json
target
A single target as a string. Can be either an absolute path/URL (depending on the type), or a relative path such as ./details/catalog-info.yaml which is resolved relative to the location of this Location entity itself.
{"type": "string", "examples": ["./details/catalog-info.yaml"], "minLength": 1}
catalog-info.json
targets
A list of targets as strings. They can all be either absolute paths/URLs (depending on the type), or relative paths such as ./details/catalog-info.yaml which are resolved relative to the location of this Location entity itself.
{"type": "array", "items": {"type": "string", "examples": ["./details/catalog-info.yaml", "http://github.com/myorg/myproject/org-data-dump/catalog-info-staff.yaml"], "minLength": 1}}
catalog-info.json
A resource describes the infrastructure a system needs to operate, like BigTable databases, Pub/Sub topics, S3 buckets or CDNs. Modelling them together with components and systems allows to visualize resource footprint, and create tooling around them.
{"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1alpha1", "kind": "Resource", "metadata": {"name": "artists-db"}, "spec": {"type": "database", "owner": "artist-relations-team", "system": "artist-engagement-portal"}}], "allOf": [{}, {"type": "object", "required": ["spec"], "properties": {"apiVersion": {"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]}, "kind": {"enum": ["Resource"]}, "spec": {"type": "object", "required": ["type", "owner"], "properties": {"type": {"type": "string", "examples": ["database", "s3-bucket", "cluster"], "minLength": 1}, "owner": {"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}, "dependsOn": {"type": "array", "items": {"type": "string", "minLength": 1}}, "system": {"type": "string", "minLength": 1}}}}}]}
catalog-info.json
metadata
Stores artist details
{"name": "artists-db"}
catalog-info.json
type
The type of resource.
{"type": "string", "examples": ["database", "s3-bucket", "cluster"], "minLength": 1}
catalog-info.json
owner
An entity reference to the owner of the resource.
{"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}
catalog-info.json
dependsOn
An array of references to other entities that the resource depends on to function.
{"type": "array", "items": {"type": "string", "minLength": 1}}
catalog-info.json
system
An entity reference to the system that the resource belongs to.
{"type": "string", "minLength": 1}
catalog-info.json
A system is a collection of resources and components. The system may expose or consume one or several APIs. It is viewed as abstraction level that provides potential consumers insights into exposed features without needing a too detailed view into the details of all components. This also gives the owning team the possibility to decide about published artifacts and APIs.
{"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1alpha1", "kind": "System", "metadata": {"name": "artist-engagement-portal"}, "spec": {"owner": "artist-relations-team", "domain": "artists"}}], "allOf": [{}, {"type": "object", "required": ["spec"], "properties": {"apiVersion": {"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]}, "kind": {"enum": ["System"]}, "spec": {"type": "object", "required": ["owner"], "properties": {"owner": {"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}, "domain": {"type": "string", "examples": ["artists"], "minLength": 1}}}}}]}
catalog-info.json
metadata
Handy tools to keep artists in the loop
{"name": "artist-engagement-portal"}
catalog-info.json
owner
An entity reference to the owner of the component.
{"type": "string", "examples": ["artist-relations-team", "user:john.johnson"], "minLength": 1}
catalog-info.json
domain
An entity reference to the domain that the system belongs to.
{"type": "string", "examples": ["artists"], "minLength": 1}
catalog-info.json
A Template describes a scaffolding task for use with the Scaffolder. It describes the required parameters as well as a series of steps that will be taken to execute the scaffolding task.
{"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1beta2", "kind": "Template", "metadata": {"name": "react-ssr-template", "tags": ["recommended", "react"]}, "spec": {"owner": "artist-relations-team", "type": "website", "parameters": {"required": ["name", "description"], "properties": {"name": {"type": "string"}}}, "steps": [{"id": "fetch", "name": "Fetch", "action": "fetch:plain", "parameters": {"url": "./template"}}, {"id": "publish", "name": "Publish to GitHub", "action": "publish:github", "parameters": {"repoUrl": "{{ parameters.repoUrl }}"}, "if": "{{ parameters.repoUrl }}"}], "output": {"catalogInfoUrl": "{{ steps.publish.output.catalogInfoUrl }}"}}}], "allOf": [{}, {"type": "object", "required": ["spec"], "properties": {"apiVersion": {"enum": ["backstage.io/v1beta2"]}, "kind": {"enum": ["Template"]}, "spec": {"type": "object", "required": ["type", "steps"], "properties": {"type": {"type": "string", "examples": ["service", "website", "library"], "minLength": 1}, "parameters": {"oneOf": [{"type": "object"}, {"type": "array", "items": {"type": "object"}}]}, "steps": {"type": "array", "items": {"type": "object", "required": ["action"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "action": {"type": "string"}, "input": {"type": "object"}, "if": {"type": ["string", "boolean"]}}}}, "output": {"type": "object", "properties": {"links": {"type": "array", "items": {"type": "object", "required": [], "properties": {"url": {"type": "string", "examples": ["https://github.com/my-org/my-new-repo"], "minLength": 1}, "entityRef": {"type": "string", "examples": ["Component:default/my-app"], "minLength": 1}, "icon": {"type": "string", "examples": ["dashboard"], "minLength": 1}}}}}, "additionalProperties": {"type": "string"}}, "owner": {"type": "string", "minLength": 1}}}}}]}
catalog-info.json
metadata
Next.js application skeleton for creating isomorphic web applications.
{"name": "react-ssr-template", "tags": ["recommended", "react"]}
catalog-info.json
name
Unique name of the component
{"type": "string"}
catalog-info.json
description
Description of the component
{"type": "string"}
catalog-info.json
type
The type of component created by the template. The software catalog accepts any type value, but an organization should take great care to establish a proper taxonomy for these. Tools including Backstage itself may read this field and behave differently depending on its value. For example, a website type component may present tooling in the Backstage interface that is specific to just websites.
{"type": "string", "examples": ["service", "website", "library"], "minLength": 1}
catalog-info.json
parameters
The JSONSchema describing the inputs for the template.
{"type": "object"}
catalog-info.json
parameters
A list of separate forms to collect parameters.
{"type": "array", "items": {"type": "object"}}
catalog-info.json
items
The JSONSchema describing the inputs for the template.
{"type": "object"}
catalog-info.json
steps
A list of steps to execute.
{"type": "array", "items": {"type": "object", "required": ["action"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "action": {"type": "string"}, "input": {"type": "object"}, "if": {"type": ["string", "boolean"]}}}}
catalog-info.json
items
A description of the step to execute.
{"type": "object", "required": ["action"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "action": {"type": "string"}, "input": {"type": "object"}, "if": {"type": ["string", "boolean"]}}}
catalog-info.json
id
The ID of the step, which can be used to refer to its outputs.
{"type": "string"}
catalog-info.json
name
The name of the step, which will be displayed in the UI during the scaffolding process.
{"type": "string"}
catalog-info.json
action
The name of the action to execute.
{"type": "string"}
catalog-info.json
input
A templated object describing the inputs to the action.
{"type": "object"}
catalog-info.json
if
A templated condition that skips the step when evaluated to false. If the condition is true or not defined, the step is executed. The condition is true, if the input is not `false`, `undefined`, `null`, `""`, `0`, or `[]`.
{"type": ["string", "boolean"]}
catalog-info.json
output
A templated object describing the outputs of the scaffolding task.
{"type": "object", "properties": {"links": {"type": "array", "items": {"type": "object", "required": [], "properties": {"url": {"type": "string", "examples": ["https://github.com/my-org/my-new-repo"], "minLength": 1}, "entityRef": {"type": "string", "examples": ["Component:default/my-app"], "minLength": 1}, "icon": {"type": "string", "examples": ["dashboard"], "minLength": 1}}}}}, "additionalProperties": {"type": "string"}}
catalog-info.json
links
A list of external hyperlinks, typically pointing to resources created or updated by the template
{"type": "array", "items": {"type": "object", "required": [], "properties": {"url": {"type": "string", "examples": ["https://github.com/my-org/my-new-repo"], "minLength": 1}, "entityRef": {"type": "string", "examples": ["Component:default/my-app"], "minLength": 1}, "icon": {"type": "string", "examples": ["dashboard"], "minLength": 1}}}}
catalog-info.json
url
A url in a standard uri format.
{"type": "string", "examples": ["https://github.com/my-org/my-new-repo"], "minLength": 1}
catalog-info.json
entityRef
An entity reference to an entity in the catalog.
{"type": "string", "examples": ["Component:default/my-app"], "minLength": 1}
catalog-info.json
title
A user friendly display name for the link.
{"type": "string", "examples": ["View new repo"], "minLength": 1}
catalog-info.json
icon
A key representing a visual icon to be displayed in the UI.
{"type": "string", "examples": ["dashboard"], "minLength": 1}
catalog-info.json
owner
The user (or group) owner of the template
{"type": "string", "minLength": 1}
catalog-info.json
A user describes a person, such as an employee, a contractor, or similar. Users belong to Group entities in the catalog. These catalog user entries are connected to the way that authentication within the Backstage ecosystem works. See the auth section of the docs for a discussion of these concepts.
{"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1alpha1", "kind": "User", "metadata": {"name": "jdoe"}, "spec": {"profile": {"displayName": "Jenny Doe", "email": "[email protected]", "picture": "https://example.com/staff/jenny-with-party-hat.jpeg"}, "memberOf": ["team-b", "employees"]}}], "allOf": [{}, {"type": "object", "required": ["spec"], "properties": {"apiVersion": {"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]}, "kind": {"enum": ["User"]}, "spec": {"type": "object", "required": ["memberOf"], "properties": {"profile": {"type": "object", "properties": {"displayName": {"type": "string", "examples": ["Jenny Doe"], "minLength": 1}, "email": {"type": "string", "examples": ["[email protected]"], "minLength": 1}, "picture": {"type": "string", "examples": ["https://example.com/staff/jenny-with-party-hat.jpeg"], "minLength": 1}}}, "memberOf": {"type": "array", "items": {"type": "string", "examples": ["team-b", "employees"], "minLength": 1}}}}}}]}
catalog-info.json
profile
Optional profile information about the user, mainly for display purposes. All fields of this structure are also optional. The email would be a primary email of some form, that the user may wish to be used for contacting them. The picture is expected to be a URL pointing to an image that's representative of the user, and that a browser could fetch and render on a profile page or similar.
{"type": "object", "properties": {"displayName": {"type": "string", "examples": ["Jenny Doe"], "minLength": 1}, "email": {"type": "string", "examples": ["[email protected]"], "minLength": 1}, "picture": {"type": "string", "examples": ["https://example.com/staff/jenny-with-party-hat.jpeg"], "minLength": 1}}}
catalog-info.json
displayName
A simple display name to present to users.
{"type": "string", "examples": ["Jenny Doe"], "minLength": 1}