From 48da9891dc3f741edcb38cb35ac3f3dde2daed75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=9Cmit=20Tun=C3=A7?= Date: Fri, 17 Jan 2025 21:46:08 +0300 Subject: [PATCH] Refactor Truncgil Finance documentation and endpoints - Updated the introduction in `intro.md` to provide a clearer overview of the application and its features. - Added new API endpoints in `00.yaml` for retrieving today's currency rates and specific currency rates by name, enhancing the API's functionality. - Removed outdated documentation files including `collection.json`, `index.html`, `openapi.yaml`, and associated CSS and JS files to streamline the project structure. - Updated the `.filehashes` to reflect changes in the documentation files. This commit improves the clarity and usability of the Truncgil Finance API documentation and expands its capabilities. --- .scribe/.filehashes | 2 +- .scribe/endpoints.cache/00.yaml | 89 ++ .scribe/endpoints/00.yaml | 89 ++ .scribe/intro.md | 10 +- public/docs/collection.json | 76 -- public/docs/css/theme-default.print.css | 393 ------- public/docs/css/theme-default.style.css | 1090 ------------------ public/docs/images/navbar.png | Bin 96 -> 0 bytes public/docs/index.html | 656 ----------- public/docs/js/theme-default-4.39.0.js | 149 --- public/docs/js/tryitout-4.39.0.js | 289 ----- public/docs/openapi.yaml | 1395 ----------------------- 12 files changed, 187 insertions(+), 4051 deletions(-) delete mode 100644 public/docs/collection.json delete mode 100644 public/docs/css/theme-default.print.css delete mode 100644 public/docs/css/theme-default.style.css delete mode 100644 public/docs/images/navbar.png delete mode 100644 public/docs/index.html delete mode 100644 public/docs/js/theme-default-4.39.0.js delete mode 100644 public/docs/js/tryitout-4.39.0.js delete mode 100644 public/docs/openapi.yaml diff --git a/.scribe/.filehashes b/.scribe/.filehashes index e9f0dee..2734976 100644 --- a/.scribe/.filehashes +++ b/.scribe/.filehashes @@ -1,4 +1,4 @@ # GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE. # Scribe uses this file to know when you change something manually in your docs. -.scribe/intro.md=36e08690cc623bbddd8746db5fae918f +.scribe/intro.md=5ba4520f0a0f744a7aceda778b683bb0 .scribe/auth.md=9bee2b1ef8a238b2e58613fa636d5f39 \ No newline at end of file diff --git a/.scribe/endpoints.cache/00.yaml b/.scribe/endpoints.cache/00.yaml index 2cc4e37..2969008 100644 --- a/.scribe/endpoints.cache/00.yaml +++ b/.scribe/endpoints.cache/00.yaml @@ -3,6 +3,45 @@ name: Endpoints description: '' endpoints: + - + httpMethods: + - GET + uri: api/today.json + metadata: + groupName: Endpoints + groupDescription: '' + subgroup: '' + subgroupDescription: '' + title: '' + description: '' + authenticated: false + custom: [] + headers: + Content-Type: application/json + Accept: application/json + urlParameters: [] + cleanUrlParameters: [] + queryParameters: [] + cleanQueryParameters: [] + bodyParameters: [] + cleanBodyParameters: [] + fileParameters: [] + responses: + - + status: 200 + content: '{"Update_Date":"2025-01-17 18:33:23","gram-altin":{"Type":"Currency","Change":"0.24"},"USD":{"Type":"Currency","Change":"0.39","Buying":"35.5568","Selling":"35.5729"},"EUR":{"Type":"Currency","Change":"-0.10","Buying":"36.5659","Selling":"36.5827"},"GBP":{"Type":"Currency","Change":"-0.26","Buying":"43.2899","Selling":"43.3139"},"XU100":{"Type":"Currency","Change":"1.13"},"bitcoin":{"Type":"Currency","Change":"5.18"},"gumus":{"Type":"Currency","Change":"-1.15"},"BRENT":{"Type":"Currency","Change":"-0.40"},"CHF":{"Buying":"38.8684","Type":"Currency","Selling":"38.8987","Change":"0.00"},"CAD":{"Buying":"24.6017","Type":"Currency","Selling":"24.6179","Change":"0.01"},"RUB":{"Buying":"0.3469","Type":"Currency","Selling":"0.3471","Change":"1.49"},"AED":{"Buying":"9.6803","Type":"Currency","Selling":"9.6855","Change":"0.39"},"AUD":{"Buying":"22.0523","Type":"Currency","Selling":"22.0694","Change":"0.29"},"DKK":{"Buying":"4.9006","Type":"Currency","Selling":"4.9039","Change":"0.23"},"SEK":{"Buying":"3.1793","Type":"Currency","Selling":"3.1830","Change":"0.13"},"NOK":{"Buying":"3.1085","Type":"Currency","Selling":"3.1113","Change":"-0.25"},"JPY":{"Buying":0.2275,"Type":"Currency","Selling":0.2279,"Change":-0.005699999999999999},"KWD":{"Buying":"115.0539","Type":"Currency","Selling":"115.4686","Change":"0.30"},"ZAR":{"Buying":"1.8980","Type":"Currency","Selling":"1.8998","Change":"0.94"},"BHD":{"Buying":"94.3401","Type":"Currency","Selling":"94.3829","Change":"0.40"},"LYD":{"Buying":"7.1896","Type":"Currency","Selling":"7.1928","Change":"-1.15"},"SAR":{"Buying":"9.4641","Type":"Currency","Selling":"9.4934","Change":"0.39"},"IQD":{"Buying":"0.0271","Type":"Currency","Selling":"0.0272","Change":"0.39"},"ILS":{"Buying":"9.9769","Type":"Currency","Selling":"9.9815","Change":"1.93"},"IRR":{"Buying":"0.0008","Type":"Currency","Selling":"0.0008","Change":"0.00"},"INR":{"Buying":"0.4106","Type":"Currency","Selling":"0.4108","Change":"0.41"},"MXN":{"Buying":"1.7147","Type":"Currency","Selling":"1.7154","Change":"0.90"},"HUF":{"Buying":"0.0886","Type":"Currency","Selling":"0.0886","Change":"0.21"},"NZD":{"Buying":"19.8808","Type":"Currency","Selling":"19.8898","Change":"0.13"},"BRL":{"Buying":"5.8608","Type":"Currency","Selling":"5.8634","Change":"0.19"},"IDR":{"Buying":"0.0022","Type":"Currency","Selling":"0.0022","Change":"0.42"},"CZK":{"Buying":"1.4472","Type":"Currency","Selling":"1.4479","Change":"0.33"},"PLN":{"Buying":"8.5816","Type":"Currency","Selling":"8.5854","Change":"0.35"},"RON":{"Buying":"7.3452","Type":"Currency","Selling":"7.3548","Change":"0.22"},"CNY":{"Buying":"4.8533","Type":"Currency","Selling":"4.8568","Change":"0.49"},"ARS":{"Buying":"0.0341","Type":"Currency","Selling":"0.0341","Change":"0.34"},"ALL":{"Buying":"0.3728","Type":"Currency","Selling":"0.3730","Change":"0.47"},"AZN":{"Buying":"20.9158","Type":"Currency","Selling":"20.9252","Change":"0.39"},"BAM":{"Buying":"18.7299","Type":"Currency","Selling":"18.7384","Change":"-6.31"},"CLP":{"Buying":"0.0353","Type":"Currency","Selling":"0.0353","Change":"0.95"},"COP":{"Buying":"0.0082","Type":"Currency","Selling":"0.0082","Change":"0.47"},"CRC":{"Buying":"0.0709","Type":"Currency","Selling":"0.0709","Change":"0.55"},"DZD":{"Buying":"0.2616","Type":"Currency","Selling":"0.2617","Change":"0.60"},"EGP":{"Buying":"0.7054","Type":"Currency","Selling":"0.7058","Change":"0.38"},"HKD":{"Buying":"4.5675","Type":"Currency","Selling":"4.5695","Change":"0.42"},"ISK":{"Buying":"0.2513","Type":"Currency","Selling":"0.2515","Change":"-0.04"},"JOD":{"Buying":"50.1436","Type":"Currency","Selling":"50.1663","Change":"0.42"},"KRW":{"Buying":"0.0244","Type":"Currency","Selling":"0.0244","Change":"0.39"},"KZT":{"Buying":"0.0670","Type":"Currency","Selling":"0.0670","Change":"0.35"},"LBP":{"Buying":"0.0004","Type":"Currency","Selling":"0.0004","Change":"0.44"},"LKR":{"Buying":"0.1199","Type":"Currency","Selling":"0.1200","Change":"0.38"},"MAD":{"Buying":"3.5377","Type":"Currency","Selling":"3.5393","Change":"0.37"},"MDL":{"Buying":"1.8828","Type":"Currency","Selling":"1.8837","Change":"-0.21"},"MKD":{"Buying":"0.5944","Type":"Currency","Selling":"0.5947","Change":"0.27"},"MYR":{"Buying":"7.8910","Type":"Currency","Selling":"7.8946","Change":"0.31"},"OMR":{"Buying":"92.3577","Type":"Currency","Selling":"92.3995","Change":"0.39"},"PEN":{"Buying":"9.4641","Type":"Currency","Selling":"9.4684","Change":"0.41"},"PHP":{"Buying":"0.6083","Type":"Currency","Selling":"0.6086","Change":"0.63"},"PKR":{"Buying":"0.1274","Type":"Currency","Selling":"0.1277","Change":"0.39"},"QAR":{"Buying":"9.7614","Type":"Currency","Selling":"9.7771","Change":"0.39"},"RSD":{"Buying":"0.3119","Type":"Currency","Selling":"0.3128","Change":"-0.06"},"SGD":{"Buying":"25.9937","Type":"Currency","Selling":"26.0055","Change":"0.31"},"SYP":{"Buying":"0.0027","Type":"Currency","Selling":"0.0027","Change":"0.39"},"THB":{"Buying":"1.0319","Type":"Currency","Selling":"1.0323","Change":"0.72"},"TWD":{"Buying":"1.0808","Type":"Currency","Selling":"1.0812","Change":"0.51"},"UAH":{"Buying":"0.8428","Type":"Currency","Selling":"0.8432","Change":"0.23"},"UYU":{"Buying":"0.8068","Type":"Currency","Selling":"0.8072","Change":"0.23"},"GEL":{"Buying":"12.5200","Type":"Currency","Selling":"12.5257","Change":"-3.50"},"TND":{"Buying":"11.0700","Type":"Currency","Selling":"11.0750","Change":"0.39"},"BGN":{"Buying":"18.6226","Type":"Currency","Selling":"18.7779","Change":"-0.10"}}' + headers: + cache-control: 'no-cache, private' + content-type: application/json + access-control-allow-origin: '*' + description: null + custom: [] + responseFields: [] + auth: [] + controller: null + method: null + route: null + custom: [] - httpMethods: - GET @@ -42,3 +81,53 @@ endpoints: method: null route: null custom: [] + - + httpMethods: + - GET + uri: 'api/currency-rates/{currencyName}' + metadata: + groupName: Endpoints + groupDescription: '' + subgroup: '' + subgroupDescription: '' + title: '' + description: '' + authenticated: false + custom: [] + headers: + Content-Type: application/json + Accept: application/json + urlParameters: + currencyName: + name: currencyName + description: '' + required: true + example: et + type: string + enumValues: [] + exampleWasSpecified: false + nullable: false + custom: [] + cleanUrlParameters: + currencyName: et + queryParameters: [] + cleanQueryParameters: [] + bodyParameters: [] + cleanBodyParameters: [] + fileParameters: [] + responses: + - + status: 404 + content: '{"error":"Para birimi bulunamad\u0131"}' + headers: + cache-control: 'no-cache, private' + content-type: application/json + access-control-allow-origin: '*' + description: null + custom: [] + responseFields: [] + auth: [] + controller: null + method: null + route: null + custom: [] diff --git a/.scribe/endpoints/00.yaml b/.scribe/endpoints/00.yaml index af22544..5bc6016 100644 --- a/.scribe/endpoints/00.yaml +++ b/.scribe/endpoints/00.yaml @@ -1,6 +1,45 @@ name: Endpoints description: '' endpoints: + - + httpMethods: + - GET + uri: api/today.json + metadata: + groupName: Endpoints + groupDescription: '' + subgroup: '' + subgroupDescription: '' + title: '' + description: '' + authenticated: false + custom: [] + headers: + Content-Type: application/json + Accept: application/json + urlParameters: [] + cleanUrlParameters: [] + queryParameters: [] + cleanQueryParameters: [] + bodyParameters: [] + cleanBodyParameters: [] + fileParameters: [] + responses: + - + status: 200 + content: '{"Update_Date":"2025-01-17 18:33:23","gram-altin":{"Type":"Currency","Change":"0.24"},"USD":{"Type":"Currency","Change":"0.39","Buying":"35.5568","Selling":"35.5729"},"EUR":{"Type":"Currency","Change":"-0.10","Buying":"36.5659","Selling":"36.5827"},"GBP":{"Type":"Currency","Change":"-0.26","Buying":"43.2899","Selling":"43.3139"},"XU100":{"Type":"Currency","Change":"1.13"},"bitcoin":{"Type":"Currency","Change":"5.18"},"gumus":{"Type":"Currency","Change":"-1.15"},"BRENT":{"Type":"Currency","Change":"-0.40"},"CHF":{"Buying":"38.8684","Type":"Currency","Selling":"38.8987","Change":"0.00"},"CAD":{"Buying":"24.6017","Type":"Currency","Selling":"24.6179","Change":"0.01"},"RUB":{"Buying":"0.3469","Type":"Currency","Selling":"0.3471","Change":"1.49"},"AED":{"Buying":"9.6803","Type":"Currency","Selling":"9.6855","Change":"0.39"},"AUD":{"Buying":"22.0523","Type":"Currency","Selling":"22.0694","Change":"0.29"},"DKK":{"Buying":"4.9006","Type":"Currency","Selling":"4.9039","Change":"0.23"},"SEK":{"Buying":"3.1793","Type":"Currency","Selling":"3.1830","Change":"0.13"},"NOK":{"Buying":"3.1085","Type":"Currency","Selling":"3.1113","Change":"-0.25"},"JPY":{"Buying":0.2275,"Type":"Currency","Selling":0.2279,"Change":-0.005699999999999999},"KWD":{"Buying":"115.0539","Type":"Currency","Selling":"115.4686","Change":"0.30"},"ZAR":{"Buying":"1.8980","Type":"Currency","Selling":"1.8998","Change":"0.94"},"BHD":{"Buying":"94.3401","Type":"Currency","Selling":"94.3829","Change":"0.40"},"LYD":{"Buying":"7.1896","Type":"Currency","Selling":"7.1928","Change":"-1.15"},"SAR":{"Buying":"9.4641","Type":"Currency","Selling":"9.4934","Change":"0.39"},"IQD":{"Buying":"0.0271","Type":"Currency","Selling":"0.0272","Change":"0.39"},"ILS":{"Buying":"9.9769","Type":"Currency","Selling":"9.9815","Change":"1.93"},"IRR":{"Buying":"0.0008","Type":"Currency","Selling":"0.0008","Change":"0.00"},"INR":{"Buying":"0.4106","Type":"Currency","Selling":"0.4108","Change":"0.41"},"MXN":{"Buying":"1.7147","Type":"Currency","Selling":"1.7154","Change":"0.90"},"HUF":{"Buying":"0.0886","Type":"Currency","Selling":"0.0886","Change":"0.21"},"NZD":{"Buying":"19.8808","Type":"Currency","Selling":"19.8898","Change":"0.13"},"BRL":{"Buying":"5.8608","Type":"Currency","Selling":"5.8634","Change":"0.19"},"IDR":{"Buying":"0.0022","Type":"Currency","Selling":"0.0022","Change":"0.42"},"CZK":{"Buying":"1.4472","Type":"Currency","Selling":"1.4479","Change":"0.33"},"PLN":{"Buying":"8.5816","Type":"Currency","Selling":"8.5854","Change":"0.35"},"RON":{"Buying":"7.3452","Type":"Currency","Selling":"7.3548","Change":"0.22"},"CNY":{"Buying":"4.8533","Type":"Currency","Selling":"4.8568","Change":"0.49"},"ARS":{"Buying":"0.0341","Type":"Currency","Selling":"0.0341","Change":"0.34"},"ALL":{"Buying":"0.3728","Type":"Currency","Selling":"0.3730","Change":"0.47"},"AZN":{"Buying":"20.9158","Type":"Currency","Selling":"20.9252","Change":"0.39"},"BAM":{"Buying":"18.7299","Type":"Currency","Selling":"18.7384","Change":"-6.31"},"CLP":{"Buying":"0.0353","Type":"Currency","Selling":"0.0353","Change":"0.95"},"COP":{"Buying":"0.0082","Type":"Currency","Selling":"0.0082","Change":"0.47"},"CRC":{"Buying":"0.0709","Type":"Currency","Selling":"0.0709","Change":"0.55"},"DZD":{"Buying":"0.2616","Type":"Currency","Selling":"0.2617","Change":"0.60"},"EGP":{"Buying":"0.7054","Type":"Currency","Selling":"0.7058","Change":"0.38"},"HKD":{"Buying":"4.5675","Type":"Currency","Selling":"4.5695","Change":"0.42"},"ISK":{"Buying":"0.2513","Type":"Currency","Selling":"0.2515","Change":"-0.04"},"JOD":{"Buying":"50.1436","Type":"Currency","Selling":"50.1663","Change":"0.42"},"KRW":{"Buying":"0.0244","Type":"Currency","Selling":"0.0244","Change":"0.39"},"KZT":{"Buying":"0.0670","Type":"Currency","Selling":"0.0670","Change":"0.35"},"LBP":{"Buying":"0.0004","Type":"Currency","Selling":"0.0004","Change":"0.44"},"LKR":{"Buying":"0.1199","Type":"Currency","Selling":"0.1200","Change":"0.38"},"MAD":{"Buying":"3.5377","Type":"Currency","Selling":"3.5393","Change":"0.37"},"MDL":{"Buying":"1.8828","Type":"Currency","Selling":"1.8837","Change":"-0.21"},"MKD":{"Buying":"0.5944","Type":"Currency","Selling":"0.5947","Change":"0.27"},"MYR":{"Buying":"7.8910","Type":"Currency","Selling":"7.8946","Change":"0.31"},"OMR":{"Buying":"92.3577","Type":"Currency","Selling":"92.3995","Change":"0.39"},"PEN":{"Buying":"9.4641","Type":"Currency","Selling":"9.4684","Change":"0.41"},"PHP":{"Buying":"0.6083","Type":"Currency","Selling":"0.6086","Change":"0.63"},"PKR":{"Buying":"0.1274","Type":"Currency","Selling":"0.1277","Change":"0.39"},"QAR":{"Buying":"9.7614","Type":"Currency","Selling":"9.7771","Change":"0.39"},"RSD":{"Buying":"0.3119","Type":"Currency","Selling":"0.3128","Change":"-0.06"},"SGD":{"Buying":"25.9937","Type":"Currency","Selling":"26.0055","Change":"0.31"},"SYP":{"Buying":"0.0027","Type":"Currency","Selling":"0.0027","Change":"0.39"},"THB":{"Buying":"1.0319","Type":"Currency","Selling":"1.0323","Change":"0.72"},"TWD":{"Buying":"1.0808","Type":"Currency","Selling":"1.0812","Change":"0.51"},"UAH":{"Buying":"0.8428","Type":"Currency","Selling":"0.8432","Change":"0.23"},"UYU":{"Buying":"0.8068","Type":"Currency","Selling":"0.8072","Change":"0.23"},"GEL":{"Buying":"12.5200","Type":"Currency","Selling":"12.5257","Change":"-3.50"},"TND":{"Buying":"11.0700","Type":"Currency","Selling":"11.0750","Change":"0.39"},"BGN":{"Buying":"18.6226","Type":"Currency","Selling":"18.7779","Change":"-0.10"}}' + headers: + cache-control: 'no-cache, private' + content-type: application/json + access-control-allow-origin: '*' + description: null + custom: [] + responseFields: [] + auth: [] + controller: null + method: null + route: null + custom: [] - httpMethods: - GET @@ -40,3 +79,53 @@ endpoints: method: null route: null custom: [] + - + httpMethods: + - GET + uri: 'api/currency-rates/{currencyName}' + metadata: + groupName: Endpoints + groupDescription: '' + subgroup: '' + subgroupDescription: '' + title: '' + description: '' + authenticated: false + custom: [] + headers: + Content-Type: application/json + Accept: application/json + urlParameters: + currencyName: + name: currencyName + description: '' + required: true + example: et + type: string + enumValues: [] + exampleWasSpecified: false + nullable: false + custom: [] + cleanUrlParameters: + currencyName: et + queryParameters: [] + cleanQueryParameters: [] + bodyParameters: [] + cleanBodyParameters: [] + fileParameters: [] + responses: + - + status: 404 + content: '{"error":"Para birimi bulunamad\u0131"}' + headers: + cache-control: 'no-cache, private' + content-type: application/json + access-control-allow-origin: '*' + description: null + custom: [] + responseFields: [] + auth: [] + controller: null + method: null + route: null + custom: [] diff --git a/.scribe/intro.md b/.scribe/intro.md index 71e0f9f..7fb9667 100644 --- a/.scribe/intro.md +++ b/.scribe/intro.md @@ -1,6 +1,6 @@ -# Truncgil Finance - +# Introduction +Daily Financial Data: Provides access to real-time financial data updated through the Truncgil API, allowing users to track the daily performance of currency exchange rates and cryptocurrencies.