..  _sorting:

=======
Sorting
=======

The ``order`` section configures which columns can be used for sorting and the
default sort order.

Configuration
=============

..  code-block:: php

    'order' => [
        'allowed' => ['title', 'uid'],       // columns allowed for sorting
        'default' => ['uid' => 'asc'],       // fallback when no order is requested
    ],

.. list-table::
   :header-rows: 1
   :widths: 20 80

   * - Key
     - Description
   * - ``allowed``
     - Array of column names that the client is permitted to sort by.
   * - ``default``
     - Associative array of ``column => direction`` pairs used when the client
       does not provide an ``order`` parameter. Direction can be ``asc`` or
       ``desc``.

Usage
=====

Sorting is controlled via the ``order`` query parameter:

.. code-block:: text

    GET /_api/articles?order[title]=asc
    GET /_api/articles?order[uid]=desc

Only columns listed in ``allowed`` are accepted. If the client requests an
unsupported column, the default order is used instead.