From d09998cce1c2bbd1254ed783f9acd90986257638 Mon Sep 17 00:00:00 2001 From: Raul Ochoa Date: Thu, 12 Mar 2015 12:57:29 +0100 Subject: [PATCH] Extra notes about optional but deprecated endpoints - /tiles/layergroup - /tiles/template --- docs/Routes.md | 39 ++++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/docs/Routes.md b/docs/Routes.md index abb13ec6..8bfa86a0 100644 --- a/docs/Routes.md +++ b/docs/Routes.md @@ -3,25 +3,25 @@ This document list all routes available in Windshaft-cartodb Maps API server. ## Routes list 1. `GET (?:/api/v1/map|/tiles/layergroup)/:token/:z/:x/:y@:scale_factor?x.:format {:token(f),:z(f),:x(f),:y(f),:scale_factor(t),:format(f)} (1)` -
Notes: Mapnik retina tiles +
Notes: Mapnik retina tiles [0] 1. `GET (?:/api/v1/map|/tiles/layergroup)/:token/:z/:x/:y.:format {:token(f),:z(f),:x(f),:y(f),:format(f)} (1)` -
Notes: Mapnik tiles +
Notes: Mapnik tiles [0] 1. `GET (?:/api/v1/map|/tiles/layergroup)/:token/:layer/:z/:x/:y.(:format) {:token(f),:layer(f),:z(f),:x(f),:y(f),:format(f)} (1)` -
Notes: Per :layer rendering based on :format +
Notes: Per :layer rendering based on :format [0] 1. `GET (?:/api/v1/map|/tiles/layergroup) {} (1)` -
Notes: Map instantiation +
Notes: Map instantiation [0] 1. `GET (?:/api/v1/map|/tiles/layergroup)/:token/:layer/attributes/:fid {:token(f),:layer(f),:fid(f)} (1)` -
Notes: Endpoint for info windows data, alternative for sql api when tables are private +
Notes: Endpoint for info windows data, alternative for sql api when tables are private [0] 1. `GET (?:/api/v1/map|/tiles/layergroup)/static/center/:token/:z/:lat/:lng/:width/:height.:format {:token(f),:z(f),:lat(f),:lng(f),:width(f),:height(f),:format(f)} (1)` -
Notes: Static Maps API +
Notes: Static Maps API [0] 1. `GET (?:/api/v1/map|/tiles/layergroup)/static/bbox/:token/:west,:south,:east,:north/:width/:height.:format {:token(f),:west(f),:south(f),:east(f),:north(f),:width(f),:height(f),:format(f)} (1)` -
Notes: Static Maps API +
Notes: Static Maps API [0] 1. `GET / {} (1)`
Notes: Welcome message @@ -36,13 +36,13 @@ This document list all routes available in Windshaft-cartodb Maps API server.
Notes: **[DEPRECATED]** Style for :table 1. `GET (?:/api/v1/map/named|/tiles/template)/:template_id/jsonp {:template_id(f)} (1)` -
Notes: Named maps JSONP instantiation +
Notes: Named maps JSONP instantiation [1] 1. `GET (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)` -
Notes: Named map retrieval (w/ API KEY) +
Notes: Named map retrieval (w/ API KEY) [1] 1. `GET (?:/api/v1/map/named|/tiles/template) {} (1)` -
Notes: List named maps (w/ API KEY) +
Notes: List named maps (w/ API KEY) [1] 1. `GET /tiles/:table/infowindow {:table(f)} (1)`
Notes: **[DEPRECATED]** retrieve info window template for :table @@ -54,7 +54,7 @@ This document list all routes available in Windshaft-cartodb Maps API server.
Notes: Healt check 1. `OPTIONS (?:/api/v1/map|/tiles/layergroup) {} (1)` -
Notes: CORS +
Notes: CORS [0] 1. `OPTIONS /tiles/:table/:z/:x/:y.* {:table(f),:z(f),:x(f),:y(f)} (1)`
Notes: **[DEPRECATED]** CORS @@ -63,31 +63,36 @@ This document list all routes available in Windshaft-cartodb Maps API server.
Notes: **[DEPRECATED]** CORS 1. `OPTIONS (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)` -
Notes: CORS +
Notes: CORS [1] 1. `POST (?:/api/v1/map|/tiles/layergroup) {} (1)` -
Notes: Map instantiation +
Notes: Map instantiation [0] 1. `POST /tiles/:table/style {:table(f)} (1)`
Notes: **[DEPRECATED]** Create style for :table 1. `POST (?:/api/v1/map/named|/tiles/template) {} (1)` -
Notes: Create named map +
Notes: Create named map (w/ API KEY) [1] 1. `POST (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)` -
Notes: Instantiate named map +
Notes: Instantiate named map [1] 1. `DELETE /tiles/:table/style {:table(f)} (1)`
Notes: **[DEPRECATED]** Delete :table style 1. `DELETE (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)` -
Notes: Delete named map +
Notes: Delete named map (w/ API KEY) [1] 1. `DELETE /tiles/:table/flush_cache {:table(f)} (1)`
Notes: **[DEPRECATED]** Flush internal caches for :table 1. `PUT (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)` -
Notes: Update a named map +
Notes: Update a named map (w/ API KEY) [1] + +## Optional deprecated routes + +[0] `/tiles/layergroup` is deprecated and `/api/v1/map` should be used but we keep it for now. +[1] `/tiles/template` is deprecated and `/api/v1/map/named` should be used but we keep it for now. ## How to generate the list of routes