commit b644344b68871153b5b7beac42456da05c4065e0
parent 091179afc13caa62f4e701187a18cd8d62df8e86
Author: Antoine A <>
Date: Wed, 14 May 2025 18:15:38 +0200
[dd:libeufin-conversion-rate-group] rename group to class
Diffstat:
1 file changed, 28 insertions(+), 28 deletions(-)
diff --git a/design-documents/063-libeufin-conversion-rate-group.rst b/design-documents/063-libeufin-conversion-rate-group.rst
@@ -1,4 +1,4 @@
-DD 63: LibEufin Conversion Rate Group
+DD 63: LibEufin Conversion Rate Class
#####################################
Summary
@@ -45,15 +45,15 @@ The current global conversion rate schema is:
cashout_rounding_mode: "zero" | "up" | "nearest";
}
-This would become the ``default`` group, that will be used by all created users. The administrator would be able to create new groups that override some of the default properties:
+This would become the ``default`` class, that will be used by all created users. The administrator would be able to create new classes that override some of the default properties:
-.. ts:def:: ConversionRateGroupRequest
+.. ts:def:: ConversionRateClassRequest
- interface ConversionRateGroupRequest {
- // The name of this group
+ interface ConversionRateClassRequest {
+ // The name of this class
name: string;
- // A description of the group
+ // A description of the class
description?: string;
// Minimum fiat amount authorised for cashin before conversion
@@ -87,19 +87,19 @@ This would become the ``default`` group, that will be used by all created users.
cashout_rounding_mode?: "zero" | "up" | "nearest";
}
-.. ts:def:: ConversionRateGroup
+.. ts:def:: ConversionRateClass
- interface ConversionRateGroup {
- // The name of this group
+ interface ConversionRateClass {
+ // The name of this class
name: string;
- // A description of the group
+ // A description of the class
description?: string;
- // Group unique ID
+ // Class unique ID
row_id: Integer;
- // Number of users affected to this group
+ // Number of users affected to this class
num_users: Integer;
// Applied conversion rate
@@ -136,14 +136,14 @@ This would become the ``default`` group, that will be used by all created users.
cashout_rounding_mode?: "zero" | "up" | "nearest";
}
-.. ts:def:: ConversionRateGroups
+.. ts:def:: ConversionRateClasses
- interface ConversionRateGroups {
+ interface ConversionRateClasses {
default: ConversionRate;
- groups: ConversionRateGroup[];
+ classes: ConversionRateClass[];
}
-When we run the conversion logic we take values from the user group and fallback to the default values when they are null. If the ratio is zero it disable the conversion.
+When we run the conversion logic we take values from the user class and fallback to the default values when they are null. If the ratio is zero it disable the conversion.
Taler Conversion Info API
-------------------------
@@ -157,19 +157,19 @@ TODO: How hard is it to migrate to this in the wallets ?
Taler Core Bank API
-------------------
-We migrate ``POST /conversion-rate`` here to set the default conversion rate group value.
+We migrate ``POST /conversion-rate`` here to set the default conversion rate class value.
-We add new admin only conversion rate group management endpoints:
+We add new admin only conversion rate class management endpoints:
-POST /conversion-rate-group
-GET /conversion-rate-group
-GET /conversion-rate-group/$GROUP-ID
-PATCH /conversion-rate-group/$GROUP-ID
-DELETE /conversion-rate-group/$GROUP-ID
+POST /conversion-rate-class
+GET /conversion-rate-class
+GET /conversion-rate-class/$CLASS-ID
+PATCH /conversion-rate-class/$CLASS-ID
+DELETE /conversion-rate-class/$CLASS-ID
-add /conversion-rate-group/$GROUP-ID/conversion-info/*
+add /conversion-rate-class/$CLASS-ID/conversion-info/*
-We add admin only ``conversion_rate_group_id`` `Integer` optional field to POST /accounts and PATCH /accounts/$USERNAME.
+We add admin only ``conversion_rate_class`` `Integer` optional field to POST /accounts and PATCH /accounts/$USERNAME.
-We add ``conversion_rate_group_id`` `Integer` optional field and query filter to GET /accounts
-We add ``conversion_rate_group`` `ConversionRateGroup` field of GET /accounts/$USERNAME
-\ No newline at end of file
+We add ``conversion_rate_class`` `Integer` optional field and query filter to GET /accounts
+We add ``conversion_rate_class`` `ConversionRateClass` field of GET /accounts/$USERNAME
+\ No newline at end of file
