summaryrefslogtreecommitdiffstatshomepage
path: root/docs/advanced/api.rst
blob: f5e0e47f408b24d4d6e7d116b1b8c58f73484a51 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
GraphQL API & Versioning
========================

**hircine** exposes the `GraphQL <https://graphql.org>`_ endpoint on `/graphql
</graphql>`_. When accessing this documentation on a running instance, clicking
that link will open an interactive GraphQL IDE with a built-in documentation
explorer.

Versioning
----------

**hircine** uses `Semantic Versioning <https://semver.org>`_. The *public API*
consists of both the frontend (command-line interface and web application) and
the backend (GraphQL API and plugin infrastructure).

Breaking changes
----------------

.. _api-breaking-0.4.0:

0.4.0
^^^^^

- With the addition of filtering on association counts in
  :commit:`9c460c6db7e6a4e7f8ed3e8d93032c7ef070efee`, the old ``empty`` field on
  ``AssociationFilter`` is now obsolete. Instead use the ``count`` field and
  match on a ``value`` of ``0`` with the ``EQUAL`` operator (which is the
  default).