Skip to content

Commit

Permalink
Merge branch '255-update-api-docs' of github.com:okfn/ckan into 255-u…
Browse files Browse the repository at this point in the history
…pdate-api-docs
  • Loading branch information
domoritz committed Feb 11, 2013
2 parents e051bfd + d8717b3 commit 936c6da
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
19 changes: 10 additions & 9 deletions doc/datastore-api.rst
Expand Up @@ -3,20 +3,21 @@ The DataStore API
=================

The DataStore API allows tabular data to be stored inside CKAN quickly and
easily. Making a DataStore API request is the same as making an Action API
request: you post a JSON dictionary in an HTTP POST request to an API URL, and
the API also returns its response in a JSON dictionary. See the
:ref:`action-api` for details.
easily. Each resource in a CKAN instance can have an associated DataStore
table. The API for using the DataStore is outlined below.

Making a DataStore API Request
==============================

Making a DataStore API request is the same as making an Action API request: you
post a JSON dictionary in an HTTP POST request to an API URL, and the API also
returns its response in a JSON dictionary. See the :ref:`action-api` for
details.

Each resource in a CKAN instance can have an associated DataStore 'table'. The
basic API for accessing the DataStore is outlined below.

API Reference
=============

The datastore related API actions are accessed via CKAN's :ref:`action-api`. When POSTing
requests, parameters should be provided as JSON objects.

.. note:: Lists can always be expressed in different ways. It is possible to use lists, comma separated strings or single items. These are valid lists: ``['foo', 'bar']``, ``'foo, bar'``, ``"foo", "bar"`` and ``'foo'``. Additionally, there are several ways to define a boolean value. ``True``, ``on`` and ``1`` are all vaid boolean values.

.. note:: The table structure of the DataStore is explained in :ref:`db_internals`.
Expand Down
9 changes: 5 additions & 4 deletions doc/install-from-source.rst
Expand Up @@ -7,13 +7,13 @@ This section describes how to install CKAN from source. Although
CKAN from source works with Ubuntu 10.04, with other versions of Ubuntu (e.g.
12.04) and with other operating systems (e.g. RedHat, Fedora, CentOS, OS X). If
you install CKAN from source on your own operating system, please share your
experiences on our wiki: http://wiki.ckan.org/Install
experiences on our `How to Install CKAN <https://github.com/okfn/ckan/wiki/How-to-Install-CKAN>`_
wiki page.

From source is also the right installation method for developers who want to
work on CKAN.

If you run into problems, see :doc:`common-error-messages` or contact `the
ckan-dev mailing list <http://lists.okfn.org/mailman/listinfo/ckan-dev>`_.
If you run into problems, see :doc:`common-error-messages`.

1. Install the required packages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -25,7 +25,8 @@ required packages with this command::

If you're not using a Debian-based operating system, find the best way to
install the following packages on your operating system (see
http://wiki.ckan.org/Install for help):
our `How to Install CKAN <https://github.com/okfn/ckan/wiki/How-to-Install-CKAN>`_
wiki page for help):

===================== ===============================================
Package Description
Expand Down

0 comments on commit 936c6da

Please sign in to comment.