cartodb4/Windshaft-cartodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Some notes about routes

Browse Source
This commit is contained in:
Raul Ochoa
2015-03-12 12:38:06 +01:00
parent f1eed600d5
commit 83e5d889a7
1 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Routes.md
+28 -28
View File
@@ -3,91 +3,91 @@ 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)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Mapnik retina tiles
1. `GET (?:/api/v1/map|/tiles/layergroup)/:token/:z/:x/:y.:format {:token(f),:z(f),:x(f),:y(f),:format(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Mapnik tiles
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)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Per :layer rendering based on :format
1. `GET (?:/api/v1/map|/tiles/layergroup) {} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Map instantiation
1. `GET (?:/api/v1/map|/tiles/layergroup)/:token/:layer/attributes/:fid {:token(f),:layer(f),:fid(f)} (1)`
<br/>Notes: [DEPRECATED]?
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)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Static Maps API
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)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Static Maps API
1. `GET / {} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Welcome message
1. `GET /version {} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Return relevant module versions: mapnik, grainstore, etc
1. `GET /tiles/:table/:z/:x/:y.* {:table(f),:z(f),:x(f),:y(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: **[DEPRECATED]** Per :table tiles rendering
1. `GET /tiles/:table/style {:table(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: **[DEPRECATED]** Style for :table
1. `GET (?:/api/v1/map/named|/tiles/template)/:template_id/jsonp {:template_id(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Named maps JSONP instantiation
1. `GET (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Named map retrieval (w/ API KEY)
1. `GET (?:/api/v1/map/named|/tiles/template) {} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: List named maps (w/ API KEY)
1. `GET /tiles/:table/infowindow {:table(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: **[DEPRECATED]** retrieve info window template for :table
1. `GET /tiles/:table/map_metadata {:table(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: **[DEPRECATED]** retrieve map metadata for :table
1. `GET /health {} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Healt check
1. `OPTIONS (?:/api/v1/map|/tiles/layergroup) {} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: CORS
1. `OPTIONS /tiles/:table/:z/:x/:y.* {:table(f),:z(f),:x(f),:y(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: **[DEPRECATED]** CORS
1. `OPTIONS /tiles/:table/style {:table(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: **[DEPRECATED]** CORS
1. `OPTIONS (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: CORS
1. `POST (?:/api/v1/map|/tiles/layergroup) {} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Map instantiation
1. `POST /tiles/:table/style {:table(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: **[DEPRECATED]** Create style for :table
1. `POST (?:/api/v1/map/named|/tiles/template) {} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Create named map
1. `POST (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Instantiate named map
1. `DELETE /tiles/:table/style {:table(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: **[DEPRECATED]** Delete :table style
1. `DELETE (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Delete named map
1. `DELETE /tiles/:table/flush_cache {:table(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: **[DEPRECATED]** Flush internal caches for :table
1. `PUT (?:/api/v1/map/named|/tiles/template)/:template_id {:template_id(f)} (1)`
<br/>Notes: [DEPRECATED]?
<br/>Notes: Update a named map
## How to generate the list of routes