cartodb4/dataservices-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix the rate limits documentation

Browse Source 
The service name used to store the geocoding rate limits is geocoder, not geocoding.
This commit is contained in:
Javier Goizueta 2017-04-12 13:34:16 +02:00
parent 8917a1c63f
commit 160409c8c0
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/rate_limits.md
View File

@ -83,7 +83,7 @@ The result is a JSON object with the configuration (`period` and `limit` attribu
#### Example: #### Example:
``` ```
SELECT cdb_dataservices_client.cdb_service_get_rate_limit('geocoding'); SELECT cdb_dataservices_client.cdb_service_get_rate_limit('geocoder');
cdb_service_get_rate_limit cdb_service_get_rate_limit
--------------------------------- ---------------------------------
@ -108,16 +108,18 @@ This functions doesn't return any value.
#### Example #### Example
This will configure the geocoding service rate limit for user `myusername`, a non-organization user. This will configure the geocoder service rate limit for user `myusername`, a non-organization user.
The limit will be set at 1000 requests per day. Since the user doesn't belong to any organization, The limit will be set at 1000 requests per day. Since the user doesn't belong to any organization,
`NULL` will be passed to the organization argument; otherwise the name of the user's organization should `NULL` will be passed to the organization argument; otherwise the name of the user's organization should
be provided. be provided.
Note that the name of the geocoding services is `geocoder` and not `geocoding`.
``` ```
SELECT cdb_dataservices_client.cdb_service_set_user_rate_limit( SELECT cdb_dataservices_client.cdb_service_set_user_rate_limit(
'myusername', 'myusername',
NULL, NULL,
'geocoding', 'geocoder',
'{"limit":1000,"period":86400}' '{"limit":1000,"period":86400}'
); );
@ -140,7 +142,7 @@ This functions doesn't return any value.
#### Example #### Example
This will configure the geocoding service rate limit for the `myorg` organization. This will configure the geocoder service rate limit for the `myorg` organization.
The limit will be set at 100 requests per hour. The limit will be set at 100 requests per hour.
Note that even we're setting the default configuration for the whole organization, Note that even we're setting the default configuration for the whole organization,
the name of a user of the organization must be provided for technical reasons. the name of a user of the organization must be provided for technical reasons.
@ -149,7 +151,7 @@ the name of a user of the organization must be provided for technical reasons.
SELECT cdb_dataservices_client.cdb_service_set_org_rate_limit( SELECT cdb_dataservices_client.cdb_service_set_org_rate_limit(
'myorgadmin', 'myorgadmin',
'myorg', 'myorg',
'geocoding', 'geocoder',
'{"limit":100,"period":3600}' '{"limit":100,"period":3600}'
); );
@ -172,7 +174,7 @@ This functions doesn't return any value.
#### Example #### Example
This will configure the default geocoding service rate limit for all users This will configure the default geocoder service rate limit for all users
accesing the data-services server. accesing the data-services server.
The limit will be set at 10000 requests per month. The limit will be set at 10000 requests per month.
Note that even we're setting the default configuration for the server, Note that even we're setting the default configuration for the server,
@ -183,7 +185,7 @@ must be provided for technical reasons.
SELECT cdb_dataservices_client.cdb_service_set_server_rate_limit( SELECT cdb_dataservices_client.cdb_service_set_server_rate_limit(
'myorgadmin', 'myorgadmin',
'myorg', 'myorg',
'geocoding', 'geocoder',
'{"limit":10000,"period":108000}' '{"limit":10000,"period":108000}'
); );