diff --git a/docs/endpoints.rst b/docs/endpoints.rst index 0eb8dcb..542c5d9 100644 --- a/docs/endpoints.rst +++ b/docs/endpoints.rst @@ -35,13 +35,14 @@ Static images * All the static image endpoints additionally support following query parameters: - * ``path`` - comma-separated ``lng,lat``, pipe-separated pairs - - * e.g. ``5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8`` - * can be provided multiple times - * or pass the path as per `Maptiler Cloud API `_ - * Match pattern: ((fill|stroke|width)\:[^\|]+\|)*((enc:.+)|((-?\d+\.?\d*,-?\d+\.?\d*\|)+(-?\d+\.?\d*,-?\d+\.?\d*))) - + * ``path`` + * can be provided multiple times + * syntax + * comma-separated ``lng,lat``, pipe-separated pairs + * e.g. ``path=5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8`` + * Match pattern with options ``((fill|stroke|width)\:[^\|]+\|)*((enc:.+)|((-?\d+\.?\d*,-?\d+\.?\d*\|)+(-?\d+\.?\d*,-?\d+\.?\d*)))`` + * e.g. ``path=stroke:yellow|width:2|fill:green|5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8`` or ``path=stroke:yellow|width:2|fill:green|enc:_p~iF~ps|U_ulLnnqC_mqNvxq`@`` + * 'enc:' is specified in `Google Encoded Polyline Format `. If used, the rest of the path parameter is considered to be part of the encoded polyline string -- do not specify the coordinate pairs. * ``latlng`` - indicates coordinates are in ``lat,lng`` order rather than the usual ``lng,lat`` * ``fill`` - color to use as the fill (e.g. ``red``, ``rgba(255,255,255,0.5)``, ``#0000ff``) * ``stroke`` - color of the path stroke