..
    This file is part of Invenio.
    Copyright (C) 2015-2018 CERN.

    Invenio is free software; you can redistribute it and/or modify it
    under the terms of the MIT License; see LICENSE file for more details.

API Docs
========

.. automodule:: invenio_records_rest.ext
   :members:

Facets
------

.. automodule:: invenio_records_rest.facets
   :members:

Sorter
------

.. automodule:: invenio_records_rest.sorter
   :members:

Links
-----

.. automodule:: invenio_records_rest.links
   :members:

Query
-----

.. automodule:: invenio_records_rest.query
   :members:

Serializers
-----------

.. automodule:: invenio_records_rest.serializers
   :members:

Mixins
~~~~~~

.. automodule:: invenio_records_rest.serializers.base
   :members:

Citeproc
~~~~~~~~

.. automodule:: invenio_records_rest.serializers.citeproc
   :members:

DataCite
~~~~~~~~

.. automodule:: invenio_records_rest.serializers.datacite
   :members:

DublinCore
~~~~~~~~~~

.. automodule:: invenio_records_rest.serializers.dc
   :members:

JSON
~~~~

.. automodule:: invenio_records_rest.serializers.json
   :members:

JSON-LD
~~~~~~~

.. automodule:: invenio_records_rest.serializers.jsonld
   :members:

Marshmallow
~~~~~~~~~~~

.. automodule:: invenio_records_rest.serializers.marshmallow
   :members:

CSV
~~~

.. automodule:: invenio_records_rest.serializers.csv
   :members:

Response
~~~~~~~~

.. automodule:: invenio_records_rest.serializers.response
   :members:

Loaders
-------

.. automodule:: invenio_records_rest.loaders
   :members:

Marshmallow
~~~~~~~~~~~

.. automodule:: invenio_records_rest.loaders.marshmallow
   :members:

Schemas
-------

.. automodule:: invenio_records_rest.schemas
   :members:

Fields
~~~~~~
.. automodule:: invenio_records_rest.schemas.fields
   :members:


Utils
-----

.. automodule:: invenio_records_rest.utils
   :members:

Errors
------

.. automodule:: invenio_records_rest.errors
   :members:

Views
-----

.. automodule:: invenio_records_rest.views
   :members:
   :exclude-members: need_record_permission verify_record_permission

Permissions
-----------

Permissions are handled by the decorator
:py:meth:`invenio_records_rest.views.need_record_permission`, which is used in
the record's REST resources.

Each resource method is checking the permissions through this decorator, with
``read_permission_factory``, ``create_permission_factory``,
``update_permission_factory`` and ``delete_permission_factory`` as argument,
where the implementation of each can be configured for each REST
endpoint with :data:`invenio_records_rest.config.RECORDS_REST_ENDPOINTS`
(using ``{read,create,update,delete}_permission_factory_imp`` keys).

For reference on each resource method and the default permission factory,
refer to the methods' docstrings in the Views section above.