schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
stryker-core.json
maxConcurrentTestRunners
[DEPRECATED please use "concurrency" instead]. Specifies the maximum number of concurrent test runners to spawn. Mutation testing is time consuming. By default, Stryker tries to make the most of your CPU's, by spawning as many test runners as you have CPU cores (`Number.MAX_SAFE_INTEGER`).
{"type": "number", "default": 9007199254740991}
stryker-core.json
maxTestRunnerReuse
Restart each test runner worker process after `n` runs. Not recommended unless you are experiencing memory leaks that you are unable to resolve. Configuring `0` here means infinite reuse.
{"type": "number", "default": 0}
stryker-core.json
mutate
With `mutate` you configure the subset of files or just one specific file to be mutated. These should be your _production code files_, and definitely not your test files. (Whereas with `ignorePatterns` you prevent non-relevant files from being copied to the sandbox directory in the first place) The default will try to guess your production code files based on sane defaults. It reads like this: - Include all js-like files inside the `src` or `lib` dir - Except files inside `__tests__` directories and file names ending with `test` or `spec`. If the defaults are not sufficient for you, for example in a angular project you might want to **exclude** not only the `*.spec.ts` files but other files too, just like the default already does. It is possible to specify exactly which code blocks to mutate by means of a _mutation range_. This can be done postfixing your file with `:startLine[:startColumn]-endLine[:endColumn]`. Example: src/index.js:1:3-1:5
{"type": "array", "items": {"type": "string"}, "default": ["{src,lib}/**/!(*.+(s|S)pec|*.+(t|T)est).+(cjs|mjs|js|ts|jsx|tsx|html|vue)", "!{src,lib}/**/__tests__/**/*.+(cjs|mjs|js|ts|jsx|tsx|html|vue)"]}
stryker-core.json
mutator
Configure how Stryker mutates your code.
{"default": {}}
stryker-core.json
packageManager
The package manager Stryker can use to install missing dependencies.
{"enum": ["npm", "yarn", "pnpm"]}
stryker-core.json
plugins
With 'plugins', you can add additional Node modules for Stryker to load (or require). By default, all node_modules starting with @stryker-mutator/* will be loaded, so you would normally not need to specify this option. These modules should be installed right next to stryker. For a current list of plugins, you can consult 'npm' or 'stryker-mutator.io.'
{"type": "array", "items": {"type": "string"}, "default": ["@stryker-mutator/*"]}
stryker-core.json
appendPlugins
A list of additional plugins you want Stryker to load (`require`) without overwriting the (default) `plugins`.
{"type": "array", "items": {"type": "string"}, "default": []}
stryker-core.json
reporters
With reporters, you can set the reporters for stryker to use.
{"type": "array", "items": {"type": "string"}, "default": ["clear-text", "progress", "html"]}
stryker-core.json
htmlReporter
The options for the html reporter
{"default": {}}
stryker-core.json
jsonReporter
The options for the json reporter
{"default": {}}
stryker-core.json
disableTypeChecks
Set to 'true' to disable type checking, or 'false' to enable it. For more control, configure a pattern that matches the files of which type checking has to be disabled. This is needed because Stryker will create (typescript) type errors when inserting the mutants in your code. Stryker disables type checking by inserting `// @ts-nocheck` atop those files and removing other `// @ts-xxx` directives (so they won't interfere with `@ts-nocheck`). The default setting allows these directives to be stripped from all JavaScript and friend files in `lib`, `src` and `test` directories.
{"oneOf": [{"type": "boolean"}, {"type": "string"}], "examples": ["{test,src,lib}/**/*.{js,ts,jsx,tsx,html,vue,cts,mts}"], "default": true}
stryker-core.json
symlinkNodeModules
The 'symlinkNodeModules' value indicates whether Stryker should create a symbolic link to your current node_modules directory in the sandbox directories. This makes running your tests by Stryker behave more like your would run the tests yourself in your project directory. Only disable this setting if you really know what you are doing.
{"type": "boolean", "default": true}
stryker-core.json
tempDirName
Choose a different temp dir that Stryker uses for mutation testing. This directory will contain copies of your source code during a mutation test run. It will be created if it not exists and is *entirely deleted* after a successful run, so change this with caution.
{"type": "string", "default": ".stryker-tmp"}
stryker-core.json
cleanTempDir
Choose whether or not to clean the temp dir (which is ".stryker-tmp" inside the current working directory by default). - false: Never delete the temp dir; - true: Delete the tmp dir after a successful run; - "always": Always delete the temp dir, regardless of whether the run was successful.
{"enum": ["always", false, true], "default": true}
stryker-core.json
testRunner
With 'testRunner' you specify the test runner that Stryker uses to run your tests. The default value is command. The command runner runs a configurable bash/cmd command and bases the result on the exit code of that program (0 for success, otherwise failed). You can configure this command via the config file using the 'commandRunner: { command: 'npm run mocha' }'. It uses 'npm test' as the command by default.
{"type": "string", "default": "command"}
stryker-core.json
testRunnerNodeArgs
Configure arguments to be passed as exec arguments to the test runner child process. For example, running Stryker with `--timeoutMS 9999999 --concurrency 1 --testRunnerNodeArgs --inspect-brk` will allow you to debug the test runner child process. See `execArgv` of [`child_process.fork`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)
{"type": "array", "default": [], "items": {"type": "string"}}
stryker-core.json
thresholds
Specify the thresholds for mutation score.
{"default": {}}
stryker-core.json
timeoutFactor
Configure the allowed timeout deviation relative to the time of a normal test run. Tweak this if you notice that mutants are prone to creating slower code, but not infinite loops (for that, use `timeoutMS`)
{"type": "number", "default": 1.5}
stryker-core.json
timeoutMS
Configure an absolute timeout deviation. Tweak this if you run Stryker on a busy machine and you need to wait longer to make sure that the code indeed entered an infinite loop.
{"type": "number", "default": 5000}
stryker-core.json
dryRunTimeoutMinutes
Configure an absolute timeout for the initial test run. (It can take a while, therefore we use minutes as time unit.)
{"type": "number", "minimum": 0, "default": 5}
stryker-core.json
tsconfigFile
Configure the (root) tsconfig file for typescript projects. This will allow Stryker to rewrite the `extends` and `references` settings in this and related tsconfig files in your sandbox. Defaults to `tsconfig.json`. This setting is also used when you enable the `@stryker-mutator/typescript-checker plugin
{"type": "string", "default": "tsconfig.json"}
stryker-core.json
warnings
Enable or disable certain warnings
{"default": true, "oneOf": [{"type": "boolean"}, {}]}
stryker-core.json
disableBail
Disables the default of bailing after first failing test. When true runs all tests covering a mutant. Useful when the subject under test is not completely isolated by mocks and you want to know which tests are killing the mutants. This will impact performance.
{"type": "boolean", "default": false}
stryker-core.json
allowEmpty
Allows stryker to exit without any errors in cases where no tests are found
{"type": "boolean", "default": false}
sprite.json
Schema for image sprite generation files
{"$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/sprite.json", "properties": {"customstyles": {"type": "object", "additionalProperties": {"type": ["string", "number"]}}, "dpi": {"type": "integer", "default": 96}, "images": {"type": "object", "additionalProperties": {"type": "string"}}, "optimize": {"enum": ["lossless", "lossy", "none"], "default": "lossless"}, "orientation": {"enum": ["horizontal", "vertical"], "default": "vertical"}, "output": {"enum": ["png", "jpg", "gif"], "default": "png"}, "padding": {"type": "integer", "default": 10}, "pathprefix": {"type": "string", "default": ""}, "stylesheet": {"enum": ["none", "css", "less", "scss", "styl"], "default": "none"}}, "required": ["images"], "type": "object"}
sprite.json
customstyles
Define custom CSS declarations to inject into the generated stylesheet.
{"type": "object", "additionalProperties": {"type": ["string", "number"]}}
sprite.json
additionalProperties
A custom CSS declaration (property: value).
{"type": ["string", "number"]}
sprite.json
dpi
The image resolution of the generated image sprite
{"type": "integer", "default": 96}
sprite.json
images
An array of file paths relative to this document. The name must be unique.
{"type": "object", "additionalProperties": {"type": "string"}}
sprite.json
additionalProperties
A source image for the sprite.
{"type": "string"}
sprite.json
optimize
Optimizes the generated image either lossy or lossless. Requires the "Image Optimizer" extension for Visual Studio
{"enum": ["lossless", "lossy", "none"], "default": "lossless"}
sprite.json
orientation
The orientation of the individual images inside the generated sprite.
{"enum": ["horizontal", "vertical"], "default": "vertical"}
sprite.json
output
Output format of the generated image sprite.
{"enum": ["png", "jpg", "gif"], "default": "png"}
sprite.json
padding
The padding arround each individual image in the sprite. The value is in pixels.
{"type": "integer", "default": 10}
sprite.json
pathprefix
Add any path root in front of the generated. Example: "/images/"
{"type": "string", "default": ""}
sprite.json
stylesheet
Define stylesheets (css, less, sass) to be generated as part of the sprite generation process.
{"enum": ["none", "css", "less", "scss", "styl"], "default": "none"}
0.5.2.json
Freifunk Community API 0.5.2
{"$schema": "http://json-schema.org/draft-07/schema", "type": "object", "definitions": {"city": {"type": "string"}, "country": {"type": "string", "enum": ["", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AC", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "IC", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DG", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "EU", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "NT", "SN", "CS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "SU", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TA", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"]}, "address": {"type": "object", "properties": {"name": {"type": "string"}, "street": {"type": "string"}, "zipcode": {"type": "string"}}, "additionalProperties": false}, "geoCode": {"type": "object", "properties": {"lat": {"type": "number"}, "lon": {"type": "number"}}, "required": ["lat", "lon"], "additionalProperties": false}, "email": {"type": "string", "format": "email", "pattern": "^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+@[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+\\.[A-Za-z]{2,}$"}, "url": {"type": "string", "pattern": "^(http|https)://[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\./]+"}, "phone": {"type": "string"}}, "properties": {"api": {"type": "string", "enum": ["0.1", "0.2.0", "0.2.1", "0.3.0", "0.3.1", "0.3.2", "0.4.0", "0.4.1", "0.4.2", "0.4.3", "0.4.4", "0.4.5", "0.4.6", "0.4.7", "0.4.8", "0.4.9", "0.4.10", "0.4.11", "0.4.12", "0.4.13", "0.4.14", "0.4.15", "0.4.16", "0.5.0", "0.5.1", "0.5.2"], "default": "0.5.2"}, "name": {"type": "string"}, "metacommunity": {"type": "string"}, "location": {"type": "object", "properties": {"city": {}, "country": {}, "address": {}, "geoCode": {}, "additionalLocations": {"type": "array", "items": {"type": "object", "properties": {"city": {}, "country": {}, "address": {}, "geoCode": {}}, "required": ["city", "geoCode"], "additionalProperties": false}}}, "required": ["city", "geoCode"], "additionalProperties": false}, "contact": {"type": "object", "minProperties": 1, "properties": {"email": {}, "facebook": {"type": "string", "pattern": "^(http|https)://([a-z\\-]*\\.|)facebook\\.com/[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\.]+"}, "identica": {"type": "string", "pattern": "^(http|https)://([a-z\\-]*\\.|)identi\\.ca/[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\.]+"}, "irc": {"type": "string", "pattern": "^(irc|ircs)://.*"}, "jabber": {"type": "string", "pattern": "^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+@[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+\\.[A-Za-z]{2,}(\\?join){0,1}$"}, "ml": {"type": "string", "pattern": "^([A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+@[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+\\.[A-Za-z]{2,}|(http|https)://[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\./]+)$"}, "googleplus": {"type": "string", "pattern": "^(http|https)://plus\\.google\\.com/[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\+\\-\\./_]+"}, "matrix": {"type": "string", "pattern": "^https://matrix\\.to/#/"}, "mastodon": {}, "twitter": {"type": "string", "pattern": "^@[A-Za-z0-9_\\-]{1,15}"}, "webform": {}, "phone": {}}, "additionalProperties": false}, "url": {}, "timeline": {"type": "array", "items": {"type": "object", "properties": {"timestamp": {"type": "string", "format": "date", "pattern": "^([0-9]{4})(?:-?W([0-9]+)(?:-?([0-9]+)D?)?|(?:-([0-9]+))?-([0-9]+))(?:[T ]([0-9]+):([0-9]+)(?::([0-9]+)(?:\\.([0-9]+))?)?)?(?:Z(-?[0-9]*))?"}, "url": {}}, "additionalProperties": false}}, "feeds": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "category": {"type": "string", "enum": ["blog", "forum", "ics", "podcast", "wiki", "others", ""], "default": ""}, "type": {"type": "string"}, "url": {}}, "additionalProperties": false}}, "state": {"type": "object", "properties": {"nodes": {"type": "integer", "minimum": 0}, "lastchange": {"type": "string", "format": "date-time", "default": 0}, "message": {"type": "string"}, "focus": {"type": "array", "items": {"type": "string", "enum": ["infrastructure/backbone", "Public Free Wifi", "Social Community Building", "Local services and content", "Free internet access"]}}}, "required": ["lastchange"], "additionalProperties": false}, "nodeMaps": {"type": "array", "items": {"type": "object", "properties": {"url": {}, "interval": {"type": "string"}, "technicalType": {"type": "string", "enum": ["", "ffmap", "ffsomething", "olsr-dot", "openwifimap", "netmon", "libremap", "nodewatcher", "kml", "nodelist", "meshviewer", "hopglass"], "default": ""}, "mapType": {"type": "string", "enum": ["", "geographical", "structural", "list/status"], "default": ""}}, "additionalProperties": false}}, "services": {"type": "array", "items": {"type": "object", "properties": {"serviceName": {"type": "string"}, "serviceDescription": {"type": "string"}, "externalUri": {"type": "string"}, "internalUri": {"type": "string"}}, "additionalProperties": false}}, "support": {"type": "object", "properties": {"club": {"type": "object", "properties": {"name": {"type": "string"}, "street": {"type": "string"}, "zip": {"type": "string"}, "city": {}, "url": {}, "email": {}, "board": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "donations": {"type": "object", "properties": {"bankaccount": {"type": "object", "properties": {"IBAN": {"type": "string"}, "BIC": {"type": "string"}, "usage": {"type": "string"}}, "additionalProperties": false}, "campaigns": {"type": "array", "items": {"type": "object", "properties": {"provider": {"type": "string", "enum": ["", "betterplace", "boost"], "default": ""}, "projectid": {"type": "string"}}, "additionalProperties": false}}}, "additionalProperties": false}}, "additionalProperties": false}, "socialprojects": {"type": "object", "properties": {"number": {"type": "integer", "mininum": 0}, "website": {}, "contact": {}}, "additionalProperties": false}, "privacy": {"type": "object", "properties": {"policyurl": {}}, "additionalProperties": false}, "techDetails": {"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}}, "required": ["name", "location", "contact", "url", "state", "techDetails"], "additionalProperties": false}
0.5.2.json
city
Name of the city
{"type": "string"}
0.5.2.json
country
Your country, list has been taken from http://countrylist.net/de/
{"type": "string", "enum": ["", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AC", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "IC", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DG", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "EU", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "NT", "SN", "CS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "SU", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TA", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"]}
0.5.2.json
address
The address of the place you meet
{"type": "object", "properties": {"name": {"type": "string"}, "street": {"type": "string"}, "zipcode": {"type": "string"}}, "additionalProperties": false}
0.5.2.json
name
The name of the place you meet
{"type": "string"}
0.5.2.json
street
The street address of your meeting place
{"type": "string"}
0.5.2.json
zipcode
The zip code of your meeting place
{"type": "string"}
0.5.2.json
lat
Lattitude of your city in decimal degrees
{"type": "number"}
0.5.2.json
lon
Longitude of your city in decimal degrees
{"type": "number"}
0.5.2.json
api
The Freifunk Community API version you use
{"type": "string", "enum": ["0.1", "0.2.0", "0.2.1", "0.3.0", "0.3.1", "0.3.2", "0.4.0", "0.4.1", "0.4.2", "0.4.3", "0.4.4", "0.4.5", "0.4.6", "0.4.7", "0.4.8", "0.4.9", "0.4.10", "0.4.11", "0.4.12", "0.4.13", "0.4.14", "0.4.15", "0.4.16", "0.5.0", "0.5.1", "0.5.2"], "default": "0.5.2"}
0.5.2.json
name
The name of your community
{"type": "string"}
0.5.2.json
metacommunity
The name of your metacommunity, if your local community belongs to a bigger one
{"type": "string"}
0.5.2.json
location
Position data such as a postal address or geographic coordinates
{"type": "object", "properties": {"city": {}, "country": {}, "address": {}, "geoCode": {}, "additionalLocations": {"type": "array", "items": {"type": "object", "properties": {"city": {}, "country": {}, "address": {}, "geoCode": {}}, "required": ["city", "geoCode"], "additionalProperties": false}}}, "required": ["city", "geoCode"], "additionalProperties": false}
0.5.2.json
additionalLocations
Add some more locations where your community is active.
{"type": "array", "items": {"type": "object", "properties": {"city": {}, "country": {}, "address": {}, "geoCode": {}}, "required": ["city", "geoCode"], "additionalProperties": false}}
0.5.2.json
email
Email address to which other people can contact your community ([email protected])
{}
0.5.2.json
facebook
URL to your community's facebook account (https://facebook.com/...)
{"type": "string", "pattern": "^(http|https)://([a-z\\-]*\\.|)facebook\\.com/[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\.]+"}
0.5.2.json
identica
URL to your community's identica account (https://identi.ca/...)
{"type": "string", "pattern": "^(http|https)://([a-z\\-]*\\.|)identi\\.ca/[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\.]+"}
0.5.2.json
irc
Your community's ICR channel; starts with irc://
{"type": "string", "pattern": "^(irc|ircs)://.*"}
0.5.2.json
jabber
A jabber account someone reads ([email protected])
{"type": "string", "pattern": "^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+@[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+\\.[A-Za-z]{2,}(\\?join){0,1}$"}
0.5.2.json
ml
The email address ([email protected]) of your mailing list or a link to the mailinglist info page (http{s}://...)
{"type": "string", "pattern": "^([A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+@[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+\\.[A-Za-z]{2,}|(http|https)://[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\./]+)$"}
0.5.2.json
googleplus
URL to your community's g+ account (https://plus.google.com/...)
{"type": "string", "pattern": "^(http|https)://plus\\.google\\.com/[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\+\\-\\./_]+"}
0.5.2.json
matrix
URL to your community's matrix channel (https://matrix.to/#/!...)
{"type": "string", "pattern": "^https://matrix\\.to/#/"}
0.5.2.json
mastodon
URL to your community's mastodon profile (https://...)
{}
0.5.2.json
twitter
Your community's Twitter name (starts with @)
{"type": "string", "pattern": "^@[A-Za-z0-9_\\-]{1,15}"}
0.5.2.json
webform
URL to your community's contact form (http{s}://...)
{}
0.5.2.json
phone
If your community has a phone number (e.g. +49 1234 567890 based on the E.123 notation)
{}
0.5.2.json
url
The main website (http{s}://...)
{}
0.5.2.json
timeline
These are lifetime events something like date of birth (and rebirth :-) of your community or other important milestones
{"type": "array", "items": {"type": "object", "properties": {"timestamp": {"type": "string", "format": "date", "pattern": "^([0-9]{4})(?:-?W([0-9]+)(?:-?([0-9]+)D?)?|(?:-([0-9]+))?-([0-9]+))(?:[T ]([0-9]+):([0-9]+)(?::([0-9]+)(?:\\.([0-9]+))?)?)?(?:Z(-?[0-9]*))?"}, "url": {}}, "additionalProperties": false}}
0.5.2.json
description
Description of your lifetime event
{"type": "string"}
0.5.2.json
timestamp
ISO 8601 timestamp of the event's date (format yyyy-mm-dd)
{"type": "string", "format": "date", "pattern": "^([0-9]{4})(?:-?W([0-9]+)(?:-?([0-9]+)D?)?|(?:-([0-9]+))?-([0-9]+))(?:[T ]([0-9]+):([0-9]+)(?::([0-9]+)(?:\\.([0-9]+))?)?)?(?:Z(-?[0-9]*))?"}
0.5.2.json
url
URL to details of this timeline-element
{}
0.5.2.json
feeds
Feeds you provide your community
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "category": {"type": "string", "enum": ["blog", "forum", "ics", "podcast", "wiki", "others", ""], "default": ""}, "type": {"type": "string"}, "url": {}}, "additionalProperties": false}}
0.5.2.json
name
Name of the feed
{"type": "string"}
0.5.2.json
category
Category of the feed like blog entries, calendars, forum messages, wiki articles, ...
{"type": "string", "enum": ["blog", "forum", "ics", "podcast", "wiki", "others", ""], "default": ""}
0.5.2.json
type
Type of the feed like RSS, Atom, XML
{"type": "string"}
0.5.2.json
url
URL of the feed
{}
0.5.2.json
state
A collection of status-related data. Actual open/closed status, icons, last change timestamp etc.
{"type": "object", "properties": {"nodes": {"type": "integer", "minimum": 0}, "lastchange": {"type": "string", "format": "date-time", "default": 0}, "message": {"type": "string"}, "focus": {"type": "array", "items": {"type": "string", "enum": ["infrastructure/backbone", "Public Free Wifi", "Social Community Building", "Local services and content", "Free internet access"]}}}, "required": ["lastchange"], "additionalProperties": false}
0.5.2.json
nodes
Number of active nodes. This field is predestined to be updated regularly, please see sample solutions for <a href="https://github.com/Freifunk-Mainz/changeffapi" target="_blank">Gluon</a> or <a href="https://github.com/freifunk/common.api.freifunk.net/blob/master/contrib/ffapi-update-nodes.py" target="_blank">OLSR</a>
{"type": "integer", "minimum": 0}
0.5.2.json
lastchange
At what ISO 8601 timestamp has your community status lastly changed?
{"type": "string", "format": "date-time", "default": 0}
0.5.2.json
message
A free-form string something like 'open for public', 'members only' or whatever you want it to be)
{"type": "string"}
0.5.2.json
description
Describe your community in a few lines
{"type": "string"}
0.5.2.json
focus
What's the focus of your local community?
{"type": "array", "items": {"type": "string", "enum": ["infrastructure/backbone", "Public Free Wifi", "Social Community Building", "Local services and content", "Free internet access"]}}
0.5.2.json
nodeMaps
Maps of nodes or topology your community provides
{"type": "array", "items": {"type": "object", "properties": {"url": {}, "interval": {"type": "string"}, "technicalType": {"type": "string", "enum": ["", "ffmap", "ffsomething", "olsr-dot", "openwifimap", "netmon", "libremap", "nodewatcher", "kml", "nodelist", "meshviewer", "hopglass"], "default": ""}, "mapType": {"type": "string", "enum": ["", "geographical", "structural", "list/status"], "default": ""}}, "additionalProperties": false}}
0.5.2.json
url
The URL where the map is located
{}
0.5.2.json
interval
How often the map will be refreshed
{"type": "string"}
0.5.2.json
technicalType
The kind of map is used
{"type": "string", "enum": ["", "ffmap", "ffsomething", "olsr-dot", "openwifimap", "netmon", "libremap", "nodewatcher", "kml", "nodelist", "meshviewer", "hopglass"], "default": ""}
0.5.2.json
mapType
{"type": "string", "enum": ["", "geographical", "structural", "list/status"], "default": ""}
0.5.2.json
services
Services Provided by your community
{"type": "array", "items": {"type": "object", "properties": {"serviceName": {"type": "string"}, "serviceDescription": {"type": "string"}, "externalUri": {"type": "string"}, "internalUri": {"type": "string"}}, "additionalProperties": false}}
0.5.2.json
serviceName
Name of your service (e.g. jabber...)
{"type": "string"}
0.5.2.json
serviceDescription
Describe your service
{"type": "string"}
0.5.2.json
externalUri
URI to use your service from the internet
{"type": "string"}
0.5.2.json
internalUri
URI to use your service from Freifunk or icvpn-networks
{"type": "string"}
0.5.2.json
name
Name of the Club
{"type": "string"}
0.5.2.json
street
Address - Street
{"type": "string"}
0.5.2.json
zip
Address - ZIP
{"type": "string"}
0.5.2.json
url
The club's website (http{s}://...)
{}
0.5.2.json
email
Email address to contact the club ([email protected])
{}
0.5.2.json
board
Who are the board members of the club?
{"type": "array", "items": {"type": "string"}}
0.5.2.json
usage
Please use this string as transfer-purpose to define a special usage of your donation.
{"type": "string"}
0.5.2.json
provider
Where do you host your donations?
{"type": "string", "enum": ["", "betterplace", "boost"], "default": ""}
0.5.2.json
projectid
ID of your project, Betterplace-IDs are multiple digits and can be found within the URL
{"type": "string"}
0.5.2.json
number
Number of projects supported by your Community
{"type": "integer", "mininum": 0}
0.5.2.json
website
A link to a web site where people can find an overview over your projects
{}
0.5.2.json
contact
Please provide an email address to contact you on refugees and social projects
{}