Files
openstapps/frontend/app/config/config.schema.json

68 lines
1.7 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "App Config",
"type": "object",
"properties": {
"$schema": {
"type": "string"
},
"appName": {
"type": "string",
"description": "Full app name",
"examples": ["Open StApps"]
},
"appDisplayName": {
"type": "string",
"description": "App name on mobile device homescreen (Not much space)",
"examples": ["StApps"]
},
"backendUrl": {
"type": "string",
"description": "Publicly available backend url",
"examples": ["https://your.backend.server.tld"]
},
"backendVersion": {
"type": "string",
"description": "Minimum backend version the app will request",
"examples": ["3.0.0"]
},
"appLinkHost": {
"type": "string",
"description": "Your host used for universal (deep) links",
"examples": ["your.deep.link.host.tdl"]
},
"appUrlScheme": {
"type": "string",
"description": "Custom url scheme for native app versions",
"examples": ["de.anyschool.app"]
},
"appMarketingVersion": {
"type": "string",
"description": "App marketing version used in Stores (preferably SemVer or CalVer)",
"examples": ["1.0.0"]
},
"android": {
"type": "object",
"properties": {
"packageName": {
"type": "string",
"description": "Android package name",
"examples": ["de.anyschool.app"]
}
},
"required": ["packageName"]
}
},
"required": [
"$schema",
"appName",
"appDisplayName",
"backendUrl",
"backendVersion",
"appLinkHost",
"appUrlScheme",
"appMarketingVersion",
"android"
]
}