diff options
| author | Christian Grothoff <grothoff@gnunet.org> | 2023-05-20 18:37:03 +0200 |
|---|---|---|
| committer | Christian Grothoff <grothoff@gnunet.org> | 2023-05-20 18:37:03 +0200 |
| commit | 3756b879510857a32f79a8c3418c907e146eca5f (patch) | |
| tree | 1b8180f90660e56f0878a3f9e198f2872c022d86 | |
| parent | 8222c4c8e592e286b64756befd957df3dbaee61b (diff) | |
| download | docs-3756b879510857a32f79a8c3418c907e146eca5f.tar.gz docs-3756b879510857a32f79a8c3418c907e146eca5f.tar.bz2 docs-3756b879510857a32f79a8c3418c907e146eca5f.zip | |
move error codes into api common
| -rw-r--r-- | core/api-common.rst | 21 | ||||
| -rw-r--r-- | core/api-error.rst | 41 |
2 files changed, 21 insertions, 41 deletions
diff --git a/core/api-common.rst b/core/api-common.rst index 13c29821..ec863f86 100644 --- a/core/api-common.rst +++ b/core/api-common.rst @@ -186,6 +186,27 @@ Examples: to decide whether it will talk to the service. +----------- +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. + + .. _encodings-ref: ---------------- diff --git a/core/api-error.rst b/core/api-error.rst deleted file mode 100644 index f3bf494c..00000000 --- a/core/api-error.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. - 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. |