From 5d9f508724b4e3d3ccc50bd800fb73f4c17d5cc4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=A1clav=20Bla=C5=BEek?= Date: Thu, 1 Jun 2017 18:29:27 +0200 Subject: [PATCH] Update resources.md --- docs/resources.md | 34 ++++++++++++++-------------------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/docs/resources.md b/docs/resources.md index 6c1c5bf..d8e1aeb 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -25,6 +25,15 @@ a JSON file on disk (for JSON resource backend) or a python data tree. * `Array`: array of given type(s) * `Optional` given entry is optional * `?` no fixed name + +Complex datatypes: + +```javascript +ResourceId`: { + String group // group this resource belongs to + String id // resource identifier (withing group) +} +``` Basic resource layout: @@ -142,28 +151,16 @@ All surface drivers support these (optional) options: // by mapproxy. See below. ``` -Introspection is extending configuration for mapproxy served `mapConfig.json` (only when browsing is enabled). +Introspection is extended configuration for mapproxy served `mapConfig.json` (only when browsing is enabled). ```javascript introspection = { - Optional Array position; // VTS position in JSON/python format - Optional Object/Array tms // bound layer(s) mapped on the surface, see below + Optional Array position; // VTS position in JSON/python format + Optional ResourceId/Array tms // bound layer(s) mapped on the surface, see below + Optional ResourceId/Array geodata // free layer(s) (geodata) mapped on the surface, see below } ``` -TMS in the above introspection is one or more TMS resource identifiers: -```javascript -tms = [ - { - String group // group part of TMS resource identifier - Strting id // ID part of TMS resource identifier - } - ... -] -``` - -If there is just one TMS resource used in the introspection then the enclosing array is optional. - ### surface-spheroid This driver generates meshed surface for reference frame's spheroid. If geoid grid is provided the resulting body @@ -243,10 +240,7 @@ introspection configuration. ```javascript introspection = { - Optional Object surface = { // optional surface mapping - String group // group part of surface resource identifier - Strting id // ID part of surface resource identifier - } + Optional ResourceId surface // optional surface mapping } ```