From 4345a2d8562f434694e95cb0b2de071fe42ee441 Mon Sep 17 00:00:00 2001 From: Redume Date: Mon, 23 Dec 2024 12:24:09 +0300 Subject: [PATCH] docs: Specifies which arguments are mandatory --- docs/endpoints/create-chart.md | 28 +++++++++++++++++----------- docs/endpoints/get-rate.md | 27 ++++++++++++++++----------- 2 files changed, 33 insertions(+), 22 deletions(-) diff --git a/docs/endpoints/create-chart.md b/docs/endpoints/create-chart.md index acfc118..1912746 100644 --- a/docs/endpoints/create-chart.md +++ b/docs/endpoints/create-chart.md @@ -41,16 +41,18 @@ Creating a currency rate chart. ``` ### Query params -| Parameter | Description | -|---------------|-------------------------------------------------------------------------| -| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency` | `ISO 4217` code of the currency to which the conversion is performed | +| Parameter | Description | +|----------------|-------------------------------------------------------------------------| +| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | +| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | ### URL params | Parameter | Description | |---------------|-------------------------------------------------------------------------| | `period` | Available parameters: `week`, `month`, `quarter`, `year` | +`*` - Required arguments + ### Response !!! info "Output" ```json @@ -106,12 +108,14 @@ Creating a currency rate chart. ``` ### Query params -| Parameter | Description | -|---------------|-------------------------------------------------------------------------| -| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency` | `ISO 4217` code of the currency to which the conversion is performed | -| `start_date` | Start date of the period in the format `YYYYY-DD-MM` | -| `end_date` | Period end date in the format `YYYYY-DD-MM` | +| Parameter | Description | +|----------------|-------------------------------------------------------------------------| +| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | +| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | +| `start_date`* | Start date of the period in the format `YYYYY-DD-MM` | +| `end_date`* | Period end date in the format `YYYYY-DD-MM` | + +`*` - Required arguments ### Response !!! info "Output" @@ -127,4 +131,6 @@ Example: ``.../RUB_USD_20241108_DQVDN7.png`` - `RUB_USD` - Name of currencies. - `20241108` - Schedule request date in `YYYMMDD` format. -- `DQVDN7` - Random file character identifier. \ No newline at end of file +- `DQVDN7` - Random file character identifier. + +All charts are in the charts folder, which is in the root directory (`./kekkai/chart`) \ No newline at end of file diff --git a/docs/endpoints/get-rate.md b/docs/endpoints/get-rate.md index 30df6ce..cdaa431 100644 --- a/docs/endpoints/get-rate.md +++ b/docs/endpoints/get-rate.md @@ -46,11 +46,14 @@ Currencies are identified by standard three-letter `ISO 4217` currency codes. ``` ### Query Parameters -| Parameter | Description | -|---------------|-------------------------------------------------------------------------| -| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency` | `ISO 4217` code of the currency to which the conversion is performed | -| `date` | Currency rate date in the format `YYYYY-DD-MM` | +| Parameter | Description | +|-----------------|------------------------------------------------------------------------| +| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | +| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | +| `date`* | Currency rate date in the format `YYYYY-DD-MM` | +| `conv_amount` | Multiplier for number conversion (Optional) + +`*` - Required arguments ### Response !!! info "Output" @@ -114,12 +117,14 @@ Getting the list of the array with currency rate for a certain period of time. ``` ### Query params -| Parameter | Description | -|---------------|-------------------------------------------------------------------------| -| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency` | `ISO 4217` code of the currency to which the conversion is performed | -| `start_date` | Start date of the period in the format `YYYYY-DD-MM` | -| `end_date` | Period end date in the format `YYYYY-DD-MM` | +| Parameter | Description | +|------------------|-------------------------------------------------------------------------| +| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | +| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | +| `start_date`* | Start date of the period in the format `YYYYY-DD-MM` | +| `end_date`* | Period end date in the format `YYYYY-DD-MM` | + +`*` - Required arguments ### Response !!! info "Output"