commit 16ecd3fd2c8d38ffc34384749c625502458374ba
parent 5d39f3347dc603ebf49f6a37b6bbd309470fbd20
Author: Christian Grothoff <christian@grothoff.org>
Date: Sat, 4 Apr 2026 10:41:19 +0200
fix documentation of GET AML generic HTTP status codes
Diffstat:
5 files changed, 87 insertions(+), 32 deletions(-)
diff --git a/core/exchange/get-aml-OFFICER_PUB-attributes-H_NORMALIZED_PAYTO.rst b/core/exchange/get-aml-OFFICER_PUB-attributes-H_NORMALIZED_PAYTO.rst
@@ -30,29 +30,37 @@
**Response:**
:http:statuscode:`200 OK`:
- The responds will be an `KycAttributes` message.
+ The responds will be an `KycAttributesResponse` message.
:http:statuscode:`204 No content`:
There are no matching KYC attributes.
- :http:statuscode:`403 Forbidden`:
- The signature is invalid.
- :http:statuscode:`404 Not found`:
- The designated AML account is not known.
:http:statuscode:`400 Bad Request`:
- The ``$H_NORMALIZED_PAYTO`` path segment is malformed.
- This response comes with a standard `ErrorDetail` response with
- a code of ``TALER_EC_GENERIC_PATH_SEGMENT_MALFORMED``.
+ The request is malformed. Cases include:
+ - The ``$H_NORMALIZED_PAYTO`` or ``H_OFFICER_PUB`` path segment
+ is malformed.
+ This response comes with a standard `ErrorDetail` response with
+ a code of ``TALER_EC_GENERIC_PATH_SEGMENT_MALFORMED``.
+ - The required HTTP header with the signature is missing. Returned with
+ ``TALER_EC_GENERIC_HTTP_HEADERS_MALFORMED``.
+ :http:statuscode:`403 Forbidden`:
+ Two cases:
+ - The signature is invalid. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_GET_SIGNATURE_INVALID``.
+ - The specific officer is unknown or disabled. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_ACCESS_DENIED``.
:http:statuscode:`406 Not Acceptable`:
The requested MIME type for the response is not supported.
- :http:statuscode:`409 Conflict`:
- The designated AML account is not enabled.
+ This is returned with an empty body, so no error code.
+ :http:statuscode:`500 Internal server error`:
+ The server had an internal problem handling the request.
+ The error code is usually a ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
:http:statuscode:`501 Not implemented`:
The requested functionality is not implemented.
Usually returned if the PDF generator is not available
at this backend and the requested format was application/pdf.
- .. ts:def:: KycAttributes
+ .. ts:def:: KycAttributesResponse
- interface KycAttributes {
+ interface KycAttributesResponse {
// Matching KYC attribute history of the account.
details: KycAttributeCollectionEvent[];
diff --git a/core/exchange/get-aml-OFFICER_PUB-decisions.rst b/core/exchange/get-aml-OFFICER_PUB-decisions.rst
@@ -38,12 +38,22 @@
The response will be an `AmlDecisionsResponse` message.
:http:statuscode:`204 No content`:
There are no matching AML records.
+ :http:statuscode:`400 Bad Request`:
+ The request is malformed. Cases include:
+ - The ``$H_OFFICER_PUB`` path segment is malformed.
+ This response comes with a standard `ErrorDetail` response with
+ a code of ``TALER_EC_GENERIC_PATH_SEGMENT_MALFORMED``.
+ - The required HTTP header with the signature is missing. Returned with
+ ``TALER_EC_GENERIC_HTTP_HEADERS_MALFORMED``.
:http:statuscode:`403 Forbidden`:
- The signature is invalid.
- :http:statuscode:`404 Not found`:
- The designated AML account is not known.
- :http:statuscode:`409 Conflict`:
- The designated AML account is not enabled.
+ Two cases:
+ - The signature is invalid. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_GET_SIGNATURE_INVALID``.
+ - The specific officer is unknown or disabled. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_ACCESS_DENIED``.
+ :http:statuscode:`500 Internal server error`:
+ The server had an internal problem handling the request.
+ The error code is usually a ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
**Details:**
diff --git a/core/exchange/get-aml-OFFICER_PUB-kyc-statistics-NAMES.rst b/core/exchange/get-aml-OFFICER_PUB-kyc-statistics-NAMES.rst
@@ -35,14 +35,26 @@
The responds will be an `AmlStatisticsResponse` message.
:http:statuscode:`204 No content`:
All the event counters are zero.
- :http:statuscode:`404 Not found`:
- The endpoint is unknown (e.g. extra path segments).
- This response comes with a standard `ErrorDetail` response with
- a code of ``TALER_EC_GENERIC_ENDPOINT_UNKNOWN``.
+ :http:statuscode:`400 Bad Request`:
+ The request is malformed. Cases include:
+ - The ``$H_OFFICER_PUB`` path segment is malformed.
+ This response comes with a standard `ErrorDetail` response with
+ a code of ``TALER_EC_GENERIC_PATH_SEGMENT_MALFORMED``.
+ - The required HTTP header with the signature is missing. Returned with
+ ``TALER_EC_GENERIC_HTTP_HEADERS_MALFORMED``.
+ :http:statuscode:`403 Forbidden`:
+ Two cases:
+ - The signature is invalid. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_GET_SIGNATURE_INVALID``.
+ - The specific officer is unknown or disabled. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_ACCESS_DENIED``.
:http:statuscode:`414 URI Too Long`:
The statistics names string in the URL is too long.
This response comes with a standard `ErrorDetail` response with
a code of ``TALER_EC_GENERIC_URI_TOO_LONG``.
+ :http:statuscode:`500 Internal server error`:
+ The server had an internal problem handling the request.
+ The error code is usually a ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
**Details:**
diff --git a/core/exchange/get-aml-OFFICER_PUB-legitimizations.rst b/core/exchange/get-aml-OFFICER_PUB-legitimizations.rst
@@ -36,19 +36,31 @@
:http:statuscode:`200 Ok`:
Information about possible measures is returned in a
- `LegitimizationMeasuresList` object.
+ `LegitimizationMeasuresListResponse` object.
:http:statuscode:`204 No content`:
There are no matching legitimization measures.
- :http:statuscode:`404 Not found`:
- The endpoint is unknown (e.g. extra path segments).
- This response comes with a standard `ErrorDetail` response with
- a code of ``TALER_EC_GENERIC_ENDPOINT_UNKNOWN``.
+ :http:statuscode:`400 Bad Request`:
+ The request is malformed. Cases include:
+ - The ``$H_OFFICER_PUB`` path segment is malformed.
+ This response comes with a standard `ErrorDetail` response with
+ a code of ``TALER_EC_GENERIC_PATH_SEGMENT_MALFORMED``.
+ - The required HTTP header with the signature is missing. Returned with
+ ``TALER_EC_GENERIC_HTTP_HEADERS_MALFORMED``.
+ :http:statuscode:`403 Forbidden`:
+ Two cases:
+ - The signature is invalid. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_GET_SIGNATURE_INVALID``.
+ - The specific officer is unknown or disabled. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_ACCESS_DENIED``.
+ :http:statuscode:`500 Internal server error`:
+ The server had an internal problem handling the request.
+ The error code is usually a ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
**Details:**
- .. ts:def:: LegitimizationMeasuresList
+ .. ts:def:: LegitimizationMeasuresListResponse
- interface LegitimizationMeasuresList {
+ interface LegitimizationMeasuresListResponse {
// Legitimization measures.
measures: LegitimizationMeasureDetails[];
diff --git a/core/exchange/get-aml-OFFICER_PUB-measures.rst b/core/exchange/get-aml-OFFICER_PUB-measures.rst
@@ -21,10 +21,23 @@
:http:statuscode:`200 Ok`:
Information about possible measures is returned in a
`AvailableMeasureSummary` object.
- :http:statuscode:`404 Not found`:
- The endpoint is unknown (e.g. extra path segments).
- This response comes with a standard `ErrorDetail` response with
- a code of ``TALER_EC_GENERIC_ENDPOINT_UNKNOWN``.
+ :http:statuscode:`400 Bad Request`:
+ The request is malformed. Cases include:
+ - The ``$H_OFFICER_PUB`` path segment is malformed.
+ This response comes with a standard `ErrorDetail` response with
+ a code of ``TALER_EC_GENERIC_PATH_SEGMENT_MALFORMED``.
+ - The required HTTP header with the signature is missing. Returned with
+ ``TALER_EC_GENERIC_HTTP_HEADERS_MALFORMED``.
+ :http:statuscode:`403 Forbidden`:
+ Two cases:
+ - The signature is invalid. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_GET_SIGNATURE_INVALID``.
+ - The specific officer is unknown or disabled. Returned with a code of
+ ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_ACCESS_DENIED``.
+ :http:statuscode:`500 Internal server error`:
+ The server had an internal problem handling the request.
+ The error code is usually a ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
+
**Details:**
