v1 (stable)
===========

This section documents the endpoints of the stable version ``v1`` of the HTTP API of
|kadi|. This version also marks the current default API version, whenever no explicit
version is requested.

Records
-------

The following subsections describe all endpoints related to records, grouped by HTTP
method. To get more detailed information about the contents of the requested/returned
representation of resources related to records, see also :class:`.Record`, especially
:attr:`.Record.extras`, :class:`.RecordLink`, :class:`.File` and :class:`.Upload`. Note
that for tags (:class:`.Tag`) and licenses (:class:`.License`), only their names are
relevant for the API. For possible license and role values, see also the
:ref:`Miscellaneous <httpapi-endpoints-v1-misc>` endpoints.

GET
~~~

.. openapi:: v1
    :tags: records
    :methods: get

POST
~~~~

.. openapi:: v1
    :tags: records
    :methods: post

PATCH
~~~~~

.. openapi:: v1
    :tags: records
    :methods: patch

PUT
~~~

.. openapi:: v1
    :tags: records
    :methods: put

DELETE
~~~~~~

.. openapi:: v1
    :tags: records
    :methods: delete

Collections
-----------

The following subsections describe all endpoints related to collections, grouped by HTTP
method. To get more detailed information about the contents of the requested/returned
representation of resources related to collections, see also :class:`.Collection`. Note
that for tags (:class:`.Tag`), only their names are relevant for the API. For possible
role values, see also the :ref:`Miscellaneous <httpapi-endpoints-v1-misc>` endpoints.

GET
~~~

.. openapi:: v1
    :tags: collections
    :methods: get

POST
~~~~

.. openapi:: v1
    :tags: collections
    :methods: post

PATCH
~~~~~

.. openapi:: v1
    :tags: collections
    :methods: patch

DELETE
~~~~~~

.. openapi:: v1
    :tags: collections
    :methods: delete

Templates
---------

The following subsections describe all endpoints related to templates, grouped by HTTP
method. To get more detailed information about the contents of the requested/returned
representation of resources related to templates, see also :class:`.Template`,
especially :attr:`.Template.data`. For possible role values, see also the
:ref:`Miscellaneous <httpapi-endpoints-v1-misc>` endpoints.

GET
~~~

.. openapi:: v1
    :tags: templates
    :methods: get

POST
~~~~

.. openapi:: v1
    :tags: templates
    :methods: post

PATCH
~~~~~

.. openapi:: v1
    :tags: templates
    :methods: patch

DELETE
~~~~~~

.. openapi:: v1
    :tags: templates
    :methods: delete

Users
-----

The following subsections describe all endpoints related to users, grouped by HTTP
method. To get more detailed information about some the contents of the
requested/returned representation of resources related to users, see also :class:`.User`
and the different :class:`.Identity` classes.

GET
~~~

.. openapi:: v1
    :tags: users
    :methods: get

Groups
------

The following subsections describe all endpoints related to groups, grouped by HTTP
method. To get more detailed information about the contents of the requested/returned
representation of resources related to groups, see also :class:`.Group`. For possible
role values, see also the :ref:`Miscellaneous <httpapi-endpoints-v1-misc>` endpoints.

GET
~~~

.. openapi:: v1
    :tags: groups
    :methods: get

POST
~~~~

.. openapi:: v1
    :tags: groups
    :methods: post

PATCH
~~~~~

.. openapi:: v1
    :tags: groups
    :methods: patch

DELETE
~~~~~~

.. openapi:: v1
    :tags: groups
    :methods: delete

.. _httpapi-endpoints-v1-misc:

Miscellaneous
-------------

The following subsections describe all miscellaneous endpoints, grouped by HTTP method.
To get more detailed information about the contents of the requested/returned
representation of resources, see also :class:`.License`, :class:`.Role` and
:class:`.Tag`.

GET
~~~

.. openapi:: v1
    :tags: misc
    :methods: get