diff --git a/docs/Routes.md b/docs/Routes.md index 0920dadf..fa435d7b 100644 --- a/docs/Routes.md +++ b/docs/Routes.md @@ -2,25 +2,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)` +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/:token/:z/:x/:y@:scale_factor?x.:format {:user(f),:token(f),:z(f),:x(f),:y(f),:scale_factor(t),:format(f)} (1)`
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)` +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/:token/:z/:x/:y.:format {:user(f),:token(f),:z(f),:x(f),:y(f),:format(f)} (1)`
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)` +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/:token/:layer/:z/:x/:y.(:format) {:user(f),:token(f),:layer(f),:z(f),:x(f),:y(f),:format(f)} (1)`
Notes: Per :layer rendering based on :format [0] -1. `GET (?:/api/v1/map|/tiles/layergroup) {} (1)` +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup) {:user(f)} (1)`
Notes: Map instantiation [0] -1. `GET (?:/api/v1/map|/tiles/layergroup)/:token/:layer/attributes/:fid {:token(f),:layer(f),:fid(f)} (1)` +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/:token/:layer/attributes/:fid {:user(f),:token(f),:layer(f),:fid(f)} (1)`
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)` +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/static/center/:token/:z/:lat/:lng/:width/:height.:format {:user(f),:token(f),:z(f),:lat(f),:lng(f),:width(f),:height(f),:format(f)} (1)`
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)` +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/static/bbox/:token/:west,:south,:east,:north/:width/:height.:format {:user(f),:token(f),:west(f),:south(f),:east(f),:north(f),:width(f),:height(f),:format(f)} (1)`
Notes: Static Maps API [0] 1. `GET / {} (1)` @@ -29,66 +29,39 @@ This document list all routes available in Windshaft-cartodb Maps API server. 1. `GET /version {} (1)`
Notes: Return relevant module versions: mapnik, grainstore, etc -1. `GET /tiles/:table/:z/:x/:y.* {:table(f),:z(f),:x(f),:y(f)} (1)` -
Notes: **[DEPRECATED]** Per :table tiles rendering - -1. `GET /tiles/:table/style {:table(f)} (1)` -
Notes: **[DEPRECATED]** Style for :table - -1. `GET (?:/api/v1/map/named|/tiles/template)/:template_id/jsonp {:template_id(f)} (1)` +1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id/jsonp {:user(f),:template_id(f)} (1)`
Notes: Named maps JSONP instantiation [1] -1. `GET (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)` +1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)`
Notes: Named map retrieval (w/ API KEY) [1] -1. `GET (?:/api/v1/map/named|/tiles/template) {} (1)` +1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template) {:user(f)} (1)`
Notes: List named maps (w/ API KEY) [1] -1. `GET /tiles/:table/infowindow {:table(f)} (1)` -
Notes: **[DEPRECATED]** retrieve info window template for :table - -1. `GET /tiles/:table/map_metadata {:table(f)} (1)` -
Notes: **[DEPRECATED]** retrieve map metadata for :table - 1. `GET /health {} (1)`
Notes: Healt check -1. `OPTIONS (?:/api/v1/map|/tiles/layergroup) {} (1)` +1. `OPTIONS (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup) {:user(f)} (1)`
Notes: CORS [0] -1. `OPTIONS /tiles/:table/:z/:x/:y.* {:table(f),:z(f),:x(f),:y(f)} (1)` -
Notes: **[DEPRECATED]** CORS - -1. `OPTIONS /tiles/:table/style {:table(f)} (1)` -
Notes: **[DEPRECATED]** CORS - -1. `OPTIONS (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)` +1. `OPTIONS (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)`
Notes: CORS [1] -1. `POST (?:/api/v1/map|/tiles/layergroup) {} (1)` +1. `POST (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup) {:user(f)} (1)`
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)` +1. `POST (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template) {:user(f)} (1)`
Notes: Create named map (w/ API KEY) [1] -1. `POST (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)` +1. `POST (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)`
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 (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)` +1. `PUT (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)`
Notes: Update a named map (w/ API KEY) [1] +1. `DELETE (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` +
Notes: Delete 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.