diff options
| author | Tomasz Mieszkowski <tomasz.mieszkowski@ext.allegro.pl> | 2014-09-05 11:32:30 +0200 |
|---|---|---|
| committer | Tomasz Mieszkowski <tomasz.mieszkowski@ext.allegro.pl> | 2014-09-05 11:32:30 +0200 |
| commit | 271876565f47da27d9a52af9e9bec705cad0cf18 (patch) | |
| tree | 4803aa59feda64558cafa125597db39628a32e29 /doc/api.rst | |
| parent | 84b33e66c0bb0bc95cb222afd138b3eacc2716de (diff) | |
| download | tipboard-271876565f47da27d9a52af9e9bec705cad0cf18.tar.gz tipboard-271876565f47da27d9a52af9e9bec705cad0cf18.tar.bz2 tipboard-271876565f47da27d9a52af9e9bec705cad0cf18.zip | |
Minor improvements in the docs ('api' and 'configuration' sections).
Diffstat (limited to 'doc/api.rst')
| -rw-r--r-- | doc/api.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/api.rst b/doc/api.rst index 50ae7e4..0979c70 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -43,7 +43,7 @@ Current API version: **v0.1** .. note:: In 99% of cases, probably only ``push`` and ``tileconfig`` will be of - interest to you. + interest to you (and maybe ``tiledata`` too). .. http:post:: /api/(api_version)/(api_key)/push @@ -126,7 +126,9 @@ Current API version: **v0.1** .. http:get:: /api/(api_version)/(api_key)/tiledata/(tile_id) - Retrieves data belonging to the tile specified by `tile_id`. May be useful for diagnostics. + Retrieves data belonging to the tile specified by `tile_id`. May be useful + in cases when you need to re-fetch some parts of your data (e.g. when + updating your team's stats) or just for diagnostics. :param api_version: version of API to be used :param api_key: your API key |