Add routes configuration to config example files

This commit is contained in:
Daniel García Aubert 2018-04-11 16:00:14 +02:00
parent e06d3200c3
commit 9a52edacb2
3 changed files with 102 additions and 0 deletions

View File

@ -13,6 +13,8 @@ var config = {
// from hostname. Must have a single grabbing block. // from hostname. Must have a single grabbing block.
,user_from_host: '^(.*)\\.localhost' ,user_from_host: '^(.*)\\.localhost'
// DEPRECATED: use routes property instead
// ---------------------------------------
// Base URLs for the APIs // Base URLs for the APIs
// //
// See http://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API // See http://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
@ -26,6 +28,38 @@ var config = {
// "tiles/layergroup" is for compatibility with versions up to 1.6.x // "tiles/layergroup" is for compatibility with versions up to 1.6.x
,base_url_detached: '(?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)' ,base_url_detached: '(?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)'
// Base URLs for the APIs
//
// See https://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
,routes: {
api: {
// "/tiles" is for compatibility with versions up to 1.6.x
paths: [
'/api/v1',
'/user/:user/api/v1',
'/tiles' // for compatibility with versions up to 1.6.x
],
// Base url for the Detached Maps API
// "maps" is the the new API,
// "tiles/layergroup" is for compatibility with versions up to 1.6.x
map: {
paths: [
'/map',
'/layergroup'
]
},
// Base url for the Templated Maps API
// "/api/v1/map/named" is the new API,
// "/tiles/template" is for compatibility with versions up to 1.6.x
template: {
paths: [
'/map/named',
'/template'
]
}
}
}
// Resource URLs expose endpoints to request/retrieve metadata associated to Maps: dataviews, analysis node status. // Resource URLs expose endpoints to request/retrieve metadata associated to Maps: dataviews, analysis node status.
// //
// This URLs depend on how `base_url_detached` and `user_from_host` are configured: the application can be // This URLs depend on how `base_url_detached` and `user_from_host` are configured: the application can be

View File

@ -13,6 +13,8 @@ var config = {
// from hostname. Must have a single grabbing block. // from hostname. Must have a single grabbing block.
,user_from_host: '^(.*)\\.cartodb\\.com$' ,user_from_host: '^(.*)\\.cartodb\\.com$'
// DEPRECATED: use routes property instead
// ---------------------------------------
// Base URLs for the APIs // Base URLs for the APIs
// //
// See http://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API // See http://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
@ -26,6 +28,38 @@ var config = {
// "tiles/layergroup" is for compatibility with versions up to 1.6.x // "tiles/layergroup" is for compatibility with versions up to 1.6.x
,base_url_detached: '(?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)' ,base_url_detached: '(?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)'
// Base URLs for the APIs
//
// See https://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
,routes: {
api: {
// "/tiles" is for compatibility with versions up to 1.6.x
paths: [
'/api/v1',
'/user/:user/api/v1',
'/tiles' // for compatibility with versions up to 1.6.x
],
// Base url for the Detached Maps API
// "maps" is the the new API,
// "tiles/layergroup" is for compatibility with versions up to 1.6.x
map: {
paths: [
'/map',
'/layergroup'
]
},
// Base url for the Templated Maps API
// "/api/v1/map/named" is the new API,
// "/tiles/template" is for compatibility with versions up to 1.6.x
template: {
paths: [
'/map/named',
'/template'
]
}
}
}
// Resource URLs expose endpoints to request/retrieve metadata associated to Maps: dataviews, analysis node status. // Resource URLs expose endpoints to request/retrieve metadata associated to Maps: dataviews, analysis node status.
// //
// This URLs depend on how `base_url_detached` and `user_from_host` are configured: the application can be // This URLs depend on how `base_url_detached` and `user_from_host` are configured: the application can be

View File

@ -13,6 +13,8 @@ var config = {
// from hostname. Must have a single grabbing block. // from hostname. Must have a single grabbing block.
,user_from_host: '^(.*)\\.cartodb\\.com$' ,user_from_host: '^(.*)\\.cartodb\\.com$'
// DEPRECATED: use routes property instead
// ---------------------------------------
// Base URLs for the APIs // Base URLs for the APIs
// //
// See http://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API // See http://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
@ -26,6 +28,38 @@ var config = {
// "/tiles/layergroup" is for compatibility with versions up to 1.6.x // "/tiles/layergroup" is for compatibility with versions up to 1.6.x
,base_url_detached: '(?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)' ,base_url_detached: '(?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)'
// Base URLs for the APIs
//
// See https://github.com/CartoDB/Windshaft-cartodb/wiki/Unified-Map-API
,routes: {
api: {
// "/tiles" is for compatibility with versions up to 1.6.x
paths: [
'/api/v1',
'/user/:user/api/v1',
'/tiles' // for compatibility with versions up to 1.6.x
],
// Base url for the Detached Maps API
// "maps" is the the new API,
// "tiles/layergroup" is for compatibility with versions up to 1.6.x
map: {
paths: [
'/map',
'/layergroup'
]
},
// Base url for the Templated Maps API
// "/api/v1/map/named" is the new API,
// "/tiles/template" is for compatibility with versions up to 1.6.x
template: {
paths: [
'/map/named',
'/template'
]
}
}
}
// Resource URLs expose endpoints to request/retrieve metadata associated to Maps: dataviews, analysis node status. // Resource URLs expose endpoints to request/retrieve metadata associated to Maps: dataviews, analysis node status.
// //
// This URLs depend on how `base_url_detached` and `user_from_host` are configured: the application can be // This URLs depend on how `base_url_detached` and `user_from_host` are configured: the application can be