Skip to content

Commit

Permalink
API endpoint description (in the README)
Browse files Browse the repository at this point in the history
  • Loading branch information
Julius Osokinas committed Feb 28, 2016
1 parent 948be8f commit ad1941a
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,29 @@ Check code coverage:
pip install coverage
coverage run --source=geokey_webresources manage.py test geokey_webresources
coverage report -m --omit=*/tests/*,*/migrations/*
API
---

**Get all web resources of a project**

.. code-block:: console
GET /api/projects/:project_id/webresources/
Response:

.. code-block:: console
[
{
"id": 46,
"status": "active"
"name": "Public Houses"
"description": "All public houses in London."
"data_format": "KML"
"url": "http://london.co.uk/public-houses.kml"
"colour": "#000000"
"symbol": null
}
]

0 comments on commit ad1941a

Please sign in to comment.