diff --git a/docs/Map-API.md b/docs/Map-API.md index a4bd403c..6060afa2 100644 --- a/docs/Map-API.md +++ b/docs/Map-API.md @@ -547,8 +547,6 @@ If a template with the same name does NOT exist, a 400 HTTP response is generate } ``` -Updating a template map will also remove all signatures from previously initialized maps. - ### Delete Delete the specified template map from the server and disables any previously initialized versions of the map. diff --git a/docs/Template-maps.md b/docs/Template-maps.md index dc596094..8267f2ef 100644 --- a/docs/Template-maps.md +++ b/docs/Template-maps.md @@ -5,13 +5,6 @@ layergroup configurations (instantiation). Template maps are persistent, can only be created and deleted by the CartoDB user showing a valid API_KEY. -Instantiating a signed template map would result in a [signed -map](https://github.com/CartoDB/Windshaft-cartodb/wiki/Signed-maps) -instance that would be signed with the same signature as the template. - -Deleting a signed template results in deletion of all signatures created -as a result of instantiation. - # Template format @@ -43,9 +36,6 @@ Placeholder default value will be used when not provided at instantiation time and could be used to test validity of the template by creating a default instance. -Additionally you'll be able to embed an authorization -certificate that would be used to sign any instance of the template. - ```js // template.json { @@ -56,7 +46,6 @@ certificate that would be used to sign any instance of the template. name: "template_name", // embedded authorization certificate auth: { - // See https://github.com/CartoDB/Windshaft-cartodb/wiki/Signed-maps method: "token", // or "open" (the default if no "method" is given) // only (required and non empty) for "token" method valid_tokens: ["auth_token1","auth_token2"] @@ -92,7 +81,8 @@ certificate that would be used to sign any instance of the template. # Creating a templated map -You can create a signed template map with a single call (for simplicity). +You can create a template map with a single call (for simplicity). + You'd use a POST sending JSON data: ```sh @@ -121,10 +111,7 @@ Errors are in this form: # Updating an existing template -Update of a template map implies removal all signatures from previous -map instances. - -You can update a signed template map with a PUT: +You can update a template map with a PUT: ```sh curl -X PUT \ @@ -243,13 +230,7 @@ or, on error: You can then use the ``layergroupid`` for fetching tiles and grids as you do normally ( see https://github.com/CartoDB/Windshaft/wiki/Multilayer-API). -But you'll still have to show the ``auth_token``, if required by the template -(see https://github.com/CartoDB/Windshaft-cartodb/wiki/Signed-maps) - -Instances of a signed template map will be signed with the same signature -certificate associated with the template. Such certificate would contain -a reference to the template identifier, so that it can be revoked every -time the template is updated or deleted. +But you'll still have to show the ``auth_token``, if required by the template. ### using JSONP There is also a special endpoint to be able to instanciate using JSONP (for old browsers) @@ -275,8 +256,6 @@ last_updated: "2014-01-27T17:41:03.021Z" ``` # Deleting a template map -Deletion of a template map will imply removal all instance signatures - You can delete a templated map with a DELETE to ``/template/:template_name``: ```sh diff --git a/docs/metrics.md b/docs/metrics.md index 5a10c24e..ba356a48 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -26,12 +26,11 @@ Again, each inner timer may have several inner timers. - **affectedTables**: time to check what are the affected tables for adding the cache channel, see *addCacheChannel* - **authorize**: time to authorize a request, see *authorizedByAPIKey*, *authorizedByCert*, *authorizedBySigner* - **authorizedByAPIKey**: time to authorize using an API KEY -- **authorizedByCert**: time to authorize a request by a cert, see [signed map](https://github.com/CartoDB/Windshaft-cartodb/wiki/Signed-maps) -- **authorizedBySigner**: time to authorize a request for a [signed map](https://github.com/CartoDB/Windshaft-cartodb/wiki/Signed-maps) +- **authorizedByCert**: time to authorize a template instantiation +- **authorizedBySigner**: time to authorize a request with auth_token - **findLastUpdated**: time to retrieve the last update time for a list of tables, see *affectedTables* -- **fingerPrint**: time to create a fingerprint for a signed map - **generateCacheChannel**: time to generate the headers for the cache channel based on the request, see *addCacheChannel* -- **getSignerMapKey**: time to retrieve from redis the authorized key for a signed map +- **getSignerMapKey**: time to retrieve from redis the authorized user for a template map - **getTablePrivacy**: time to retrieve from redis the privacy of a table - **getTemplate**: time to retrieve from redis the template for a map - **getUserMapKey**: time to retrieve from redis the user key for a map @@ -41,6 +40,5 @@ Again, each inner timer may have several inner timers. - **setDBAuth**: time to retrieve from redis and set db user and db password from a user - **setDBConn**: time to retrieve from redis and set db host and db name from a user - **setDBParams**: time to prepare all db params to be able to connect/query a database, see *setDBAuth* and *setDBConn* -- **signMap**: time to sign in redis layergroup for a map, see signed maps - **tablePrivacy_getUserDBName**: time to retrieve from redis the database for a user