summaryrefslogtreecommitdiff
path: root/core/api-error.rst
blob: f3bf494cca50b1b9f05ade04dd9eb6b603cbb988 (plain)
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
29
30
31
32
33
34
35
36
37
38
39
40
41
..
  This file is part of GNU TALER.

  Copyright (C) 2014-2023 Taler Systems SA

  TALER is free software; you can redistribute it and/or modify it under the
  terms of the GNU Affero General Public License as published by the Free Software
  Foundation; either version 2.1, or (at your option) any later version.

  TALER is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License along with
  TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>

  @author Marcello Stanisci
  @author Christian Grothoff

.. _error-codes:
.. _TALER_ErrorCode:

-----------
Error Codes
-----------

All error codes used in GNU Taler are defined in
`GANA <https://git.gnunet.org/gana.git/tree/gnu-taler-error-codes/>`__.

This centralized registry also contains generators that create enumerations
and mappings from error codes to HTTP status codes and human-readable error
messages for various programming languages.

All error codes have numeric values below 100 or above 1000, so as to never be
confused with HTTP status codes.  A value of 0 is reserved for "no error" or
"success".

In C, the respective enumeration is the ``enum TALER_ErrorCode``.

Developers may have to re-run ``bootstrap`` and/or update their Git
submodules to ensure that they have the lastest GANA registry.