Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
editor-layer-index/schema.json
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
259 lines (259 sloc)
11.3 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "$schema": "http://json-schema.org/draft-04/schema#", | |
| "id": "https://github.com/osmlab/editor-layer-index", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "Feature" | |
| ] | |
| }, | |
| "bbox": { | |
| "$ref": "http://json.schemastore.org/geojson#/properties/bbox" | |
| }, | |
| "geometry": { | |
| "$ref": "http://json.schemastore.org/geojson#/definitions/geometry" | |
| }, | |
| "properties": { | |
| "type": "object", | |
| "additionalProperties": false, | |
| "required": [ | |
| "id", | |
| "type", | |
| "url", | |
| "name" | |
| ], | |
| "properties": { | |
| "name": { | |
| "description": "The name of the imagery source", | |
| "type": "string" | |
| }, | |
| "i18n": { | |
| "description": "Whether the imagery name should be translated", | |
| "type": "boolean" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "tms", | |
| "wms", | |
| "bing", | |
| "scanex", | |
| "wms_endpoint", | |
| "wmts" | |
| ] | |
| }, | |
| "category": { | |
| "description": "A rough categorisation of different types of layers. See https://github.com/osmlab/editor-layer-index/blob/gh-pages/CONTRIBUTING.md#categories for a description of the individual categories.", | |
| "type": "string", | |
| "enum": [ | |
| "photo", | |
| "map", | |
| "historicmap", | |
| "osmbasedmap", | |
| "historicphoto", | |
| "qa", | |
| "elevation", | |
| "other" | |
| ] | |
| }, | |
| "url": { | |
| "description": "A URL template for imagery tiles", | |
| "type": "string" | |
| }, | |
| "min_zoom": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "default": 0 | |
| }, | |
| "max_zoom": { | |
| "type": "integer", | |
| "minimum": 1 | |
| }, | |
| "permission_osm": { | |
| "description": "explicit/implicit permission by the owner for use in OSM", | |
| "type": "string", | |
| "enum": [ | |
| "explicit", | |
| "implicit", | |
| "no" | |
| ] | |
| }, | |
| "license_url": { | |
| "description": "A URL for the license or permissions for the imagery", | |
| "type": "string" | |
| }, | |
| "privacy_policy_url": { | |
| "description": "A URL for the privacy policy of the operator or false if there is no existing privacy policy for tis imagery.", | |
| "type": ["string", "boolean"] | |
| }, | |
| "id": { | |
| "description": "A unique identifier for the source; used in imagery_used changeset tag", | |
| "pattern": "^[-_.A-Za-z0-9]+$", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "A short English-language description of the source", | |
| "type": "string" | |
| }, | |
| "country_code": { | |
| "description": "The ISO 3166-1 alpha-2 two letter country code in upper case. Use ZZ for unknown or multiple.", | |
| "type": "string", | |
| "pattern": "^[A-Z]{2}$" | |
| }, | |
| "default": { | |
| "description": "Whether this imagery should be shown in the default world-wide menu", | |
| "type": "boolean" | |
| }, | |
| "best": { | |
| "description": "Whether this imagery is the best source for the region", | |
| "type": "boolean" | |
| }, | |
| "start_date": { | |
| "description": "The age of the oldest imagery or data in the source, as an RFC3339 date or leading portion of one", | |
| "type": "string", | |
| "pattern": "^\\d\\d\\d\\d(-\\d\\d(-\\d\\d)?)?$" | |
| }, | |
| "end_date": { | |
| "description": "The age of the newest imagery or data in the source, as an RFC3339 date or leading portion of one", | |
| "type": "string", | |
| "pattern": "^\\d\\d\\d\\d(-\\d\\d(-\\d\\d)?)?$" | |
| }, | |
| "no_tile_header": { | |
| "description": "HTTP header to check for information if the tile is invalid", | |
| "type": "object", | |
| "minProperties": 1, | |
| "maxProperties": 1, | |
| "patternProperties": { | |
| "^.*$": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "overlay": { | |
| "description": "'true' if tiles are transparent and can be overlaid on another source", | |
| "type": "boolean", | |
| "default": "false" | |
| }, | |
| "available_projections": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "attribution": { | |
| "type": "object", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "html": { | |
| "type": "string" | |
| }, | |
| "required": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "icon": { | |
| "description": "A URL for an image, that can be displayed in the list of imagery layers next to the name", | |
| "type": "string" | |
| }, | |
| "eula": { | |
| "description": "A link to an EULA text that has to be accepted by the user, before the imagery source is added. Can contain {lang} to be replaced by a current user language wiki code (like FR:) or an empty string for the default English text.", | |
| "type": "string" | |
| }, | |
| "logo-image": { | |
| "description": "A URL for an image, that is displayed in the mapview for attribution", | |
| "type": "string" | |
| }, | |
| "terms-of-use-text": { | |
| "description": "Customized text for the terms of use link (default is \"Background Terms of Use\")", | |
| "type": "string" | |
| }, | |
| "no-tile-checksum": { | |
| "description": "Specify a checksum for tiles, which aren't real tiles. `type` is the digest type and can be MD5, SHA-1, SHA-256, SHA-384 and SHA-512, value is the hex encoded checksum in lower case. To create a checksum save the tile as file and upload it to e.g. https://defuse.ca/checksums.htm.", | |
| "type": "string" | |
| }, | |
| "metadata-header": { | |
| "description": "header-name attribute specifies a header returned by tile server, that will be shown as `metadata-key` attribute in Show Tile Info dialog", | |
| "type": "string" | |
| }, | |
| "valid-georeference": { | |
| "description": "Set to `true` if imagery source is properly aligned and does not need imagery offset adjustments. This is used for OSM based sources too.", | |
| "type": "boolean" | |
| }, | |
| "tile-size": { | |
| "description": "Size of individual tiles delivered by a TMS service", | |
| "type": "integer", | |
| "default": 256 | |
| }, | |
| "mod-tile-features": { | |
| "description": "Whether tiles status can be accessed by appending /status to the tile URL and can be submitted for re-rendering by appending /dirty.", | |
| "type": "string" | |
| }, | |
| "custom-http-headers": { | |
| "description": "HTTP headers to be sent to server. It has two attributes header-name and header-value. May be specified multiple times.", | |
| "type": "object", | |
| "properties": { | |
| "header-name": { | |
| "type": "string" | |
| }, | |
| "header-value": { | |
| "type": "string" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "default-layers": { | |
| "description": "Default layer to open (when using WMS_ENDPOINT type). Contains list of layer tag with two attributes - name and style, e.g. `\"default-layers\": [\"layer\": { name=\"Basisdata_NP_Basiskart_JanMayen_WMTS_25829\" \"style\":\"default\" } ]` (not allowed in `mirror` attribute)", | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "layer" : { | |
| "type": "object", | |
| "properties": { | |
| "layer-name": { | |
| "type": "string" | |
| }, | |
| "layer-style": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "format": { | |
| "description": "format to use when connecting tile server (when using WMS_ENDPOINT type)", | |
| "type": "string" | |
| }, | |
| "transparent": { | |
| "description": "If `true` transparent tiles will be requested from WMS server", | |
| "type": "boolean", | |
| "default": "false" | |
| }, | |
| "minimum-tile-expire": { | |
| "description": "minimum expiry time for tiles in seconds. The larger the value, the longer entry in cache will be considered valid", | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } |