Redume/Kekkai
1
0
Fork 0
mirror of https://github.com/Redume/Kekkai.git synced 2025-02-23 12:43:12 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Specifies which arguments are mandatory

Browse source
This commit is contained in:
Данил 2024-12-23 12:24:09 +03:00
parent 2b891ef592
commit 4345a2d856
2 changed files with 33 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/endpoints/create-chart.md
View file

@ -42,15 +42,17 @@ Creating a currency rate chart.
### Query params ### Query params
| Parameter | Description | | Parameter | Description |
|---------------|-------------------------------------------------------------------------| |----------------|-------------------------------------------------------------------------|
| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place | | `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 | | `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed |
### URL params ### URL params
| Parameter | Description | | Parameter | Description |
|---------------|-------------------------------------------------------------------------| |---------------|-------------------------------------------------------------------------|
| `period` | Available parameters: `week`, `month`, `quarter`, `year` | | `period` | Available parameters: `week`, `month`, `quarter`, `year` |
`*` - Required arguments
### Response ### Response
!!! info "Output" !!! info "Output"
```json ```json
@ -107,11 +109,13 @@ Creating a currency rate chart.
### Query params ### Query params
| Parameter | Description | | Parameter | Description |
|---------------|-------------------------------------------------------------------------| |----------------|-------------------------------------------------------------------------|
| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place | | `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 | | `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` | | `start_date`* | Start date of the period in the format `YYYYY-DD-MM` |
| `end_date` | Period end date in the format `YYYYY-DD-MM` | | `end_date`* | Period end date in the format `YYYYY-DD-MM` |
`*` - Required arguments
### Response ### Response
!!! info "Output" !!! info "Output"
@ -128,3 +132,5 @@ Example: ``.../RUB_USD_20241108_DQVDN7.png``
- `RUB_USD` - Name of currencies. - `RUB_USD` - Name of currencies.
- `20241108` - Schedule request date in `YYYMMDD` format. - `20241108` - Schedule request date in `YYYMMDD` format.
- `DQVDN7` - Random file character identifier. - `DQVDN7` - Random file character identifier.
All charts are in the charts folder, which is in the root directory (`./kekkai/chart`)

23
docs/endpoints/get-rate.md
View file

@ -47,10 +47,13 @@ Currencies are identified by standard three-letter `ISO 4217` currency codes.
### Query Parameters ### Query Parameters
| Parameter | Description | | Parameter | Description |
|---------------|-------------------------------------------------------------------------| |-----------------|------------------------------------------------------------------------|
| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place | | `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 | | `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed |
| `date` | Currency rate date in the format `YYYYY-DD-MM` | | `date`* | Currency rate date in the format `YYYYY-DD-MM` |
| `conv_amount` | Multiplier for number conversion (Optional)
`*` - Required arguments
### Response ### Response
!!! info "Output" !!! info "Output"
@ -115,11 +118,13 @@ Getting the list of the array with currency rate for a certain period of time.
### Query params ### Query params
| Parameter | Description | | Parameter | Description |
|---------------|-------------------------------------------------------------------------| |------------------|-------------------------------------------------------------------------|
| `from_currency` | `ISO 4217` code of the currency from which the conversion takes place | | `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 | | `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` | | `start_date`* | Start date of the period in the format `YYYYY-DD-MM` |
| `end_date` | Period end date in the format `YYYYY-DD-MM` | | `end_date`* | Period end date in the format `YYYYY-DD-MM` |
`*` - Required arguments
### Response ### Response
!!! info "Output" !!! info "Output"