Skip to content

Commit 5015cd6

Browse files
committed
Improve description of variables object
1 parent 256ff1b commit 5015cd6

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -115,12 +115,16 @@ This describes the REST request encoding, which provides a URL template with var
115115
| uriTemplate | string | Can override the URL template from the capabilities document with a custom version that can be customized with the `variables` provided. |
116116
| variables | Map\<string, \*> | This object contains one key per substitution variable in the `urlTemplate`. |
117117

118-
**variables**: Each key defines the schema of one substitution variable using a JSON Schema fragmen
119-
and can thus include things like the data type of the variable, enumerations, minimum values, maximum values, etc.
120-
Note that clients may have varying capabilities to parse and hanle the schemas provided for the variables.
121-
If you want to ensure that the WMTS can be easily read, stick to very simply schemas
118+
**variables**: Each key defines the schema of one substitution variable using a JSON Schema fragment.
119+
120+
Providing a reasonable default value for all variables is strongly recommended as they
121+
are likely to be used for a default visualization.
122+
Additional information such as the data type of the variable, enumerations, minimum values, maximum values, etc.
123+
can be provided for creating interactive UIs where the user can select values depending on the schema.
124+
Note that clients may have varying capabilities to parse and handle the schemas provided for the variables.
125+
If you want to ensure that the WMTS can be easily read, stick to very simple schemas
122126
(e.g., enums for strings, minimum/maximum values for numbers).
123-
Providing a reasonable default value for all variables is recommended.
127+
124128
Variables with a constant value should be encoded directly in the URL without using a variable.
125129

126130
### PMTiles

0 commit comments

Comments
 (0)