Refactor API documentation and endpoints for currency, crypto, and gold rates
- Updated endpoint names and descriptions for clarity, including renaming 'Endpoints' to 'Cron Job' and enhancing titles for better understanding. - Introduced new endpoints for fetching all rates, current currency rates, gold rates, and crypto rates, improving the API's structure and usability. - Enhanced response messages to provide comprehensive updates for all currency, crypto, and gold rates, ensuring consistency and clarity. - Improved metadata and organization within the API documentation for better navigation and user experience. These changes collectively enhance the clarity, usability, and functionality of the API in the Truncgil Finance application.
This commit is contained in:
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,94 @@
|
||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||
|
||||
name: '🪙 Gold'
|
||||
description: ''
|
||||
endpoints:
|
||||
-
|
||||
httpMethods:
|
||||
- GET
|
||||
uri: api/gold-rates
|
||||
metadata:
|
||||
groupName: '🪙 Gold'
|
||||
groupDescription: ''
|
||||
subgroup: 'Fetch Rates'
|
||||
subgroupDescription: ''
|
||||
title: 'Get current gold rates.'
|
||||
description: ''
|
||||
authenticated: false
|
||||
custom: []
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters: []
|
||||
cleanUrlParameters: []
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
status: 200
|
||||
content: '{"Meta_Data":{"Minutes_Ago":-0.02,"Current_Date":"2025-01-21 22:46:25","Update_Date":"2025-01-21 22:46:24"},"Rates":{"GRA":{"Selling":3140.98,"Type":"Gold","Name":"GRAMALTIN","Change":1.34,"Buying":3140.64},"GUM":{"Selling":35.28,"Type":"Gold","Name":"GUMUS","Change":0.9,"Buying":35.23},"BRE":{"Selling":0,"Type":"Gold","Name":"BRENT","Change":-0.5},"ONS":{"Buying":0,"Type":"Gold","Name":"ONS","Selling":0,"Change":1.21},"HAS":{"Buying":3125.34,"Type":"Gold","Name":"GRAMHASALTIN","Selling":3125.77,"Change":1.36},"CEY":{"Buying":4996.08,"Type":"Gold","Name":"CEYREKALTIN","Selling":5109.73,"Change":0.73},"YAR":{"Buying":9960.93,"Type":"Gold","Name":"YARIMALTIN","Selling":10219.46,"Change":0.73},"TAM":{"Buying":19984.31,"Type":"Gold","Name":"TAMALTIN","Selling":20376.41,"Change":0.73},"CUM":{"Buying":20709,"Type":"Gold","Name":"CUMHURIYETALTINI","Selling":21022,"Change":0.77},"ATA":{"Buying":20608.82,"Type":"Gold","Name":"ATAALTIN","Selling":21126.46,"Change":0.73},"ODA":{"Buying":1779.85,"Type":"Gold","Name":"14AYARALTIN","Selling":1781.37,"Change":0.73},"OSA":{"Buying":2279.46,"Type":"Gold","Name":"18AYARALTIN","Selling":2281.41,"Change":0.73},"YIA":{"Buying":2847.76,"Type":"Gold","Name":"22AYARBILEZIK","Selling":2850.2,"Change":0.73},"IKI":{"Buying":49960.78,"Type":"Gold","Name":"IKIBUCUKALTIN","Selling":50753.51,"Change":0.73},"BES":{"Buying":101170.59,"Type":"Gold","Name":"BESLIALTIN","Selling":103132.13,"Change":0.73},"GRE":{"Buying":49960.78,"Type":"Gold","Name":"GREMSEALTIN","Selling":51097.28,"Change":0.73},"RES":{"Buying":20608.82,"Type":"Gold","Name":"RESATALTIN","Selling":21126.46,"Change":0.73},"HAM":{"Buying":20608.82,"Type":"Gold","Name":"HAMITALTIN","Selling":21126.46,"Change":0.73},"GPL":{"Buying":1081.39,"Type":"Gold","Name":"GRAMPLATIN","Selling":1085.18,"Change":-0.4}}}'
|
||||
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
|
||||
uri: 'api/gold-rates/{goldName}'
|
||||
metadata:
|
||||
groupName: '🪙 Gold'
|
||||
groupDescription: ''
|
||||
subgroup: 'Fetch Rates'
|
||||
subgroupDescription: ''
|
||||
title: 'Get gold rate by name.'
|
||||
description: ''
|
||||
authenticated: false
|
||||
custom: []
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters:
|
||||
goldName:
|
||||
name: goldName
|
||||
description: ''
|
||||
required: true
|
||||
example: porro
|
||||
type: string
|
||||
enumValues: []
|
||||
exampleWasSpecified: false
|
||||
nullable: false
|
||||
custom: []
|
||||
cleanUrlParameters:
|
||||
goldName: porro
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
status: 404
|
||||
content: '{"error":"Currency not found"}'
|
||||
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: []
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,83 @@
|
||||
## Autogenerated by Scribe. DO NOT MODIFY.
|
||||
|
||||
name: Time
|
||||
description: ''
|
||||
endpoints:
|
||||
-
|
||||
httpMethods:
|
||||
- GET
|
||||
uri: api/server-time
|
||||
metadata:
|
||||
groupName: Time
|
||||
groupDescription: ''
|
||||
subgroup: 'Server Info'
|
||||
subgroupDescription: ''
|
||||
title: 'Get current server time.'
|
||||
description: ''
|
||||
authenticated: false
|
||||
custom: []
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters: []
|
||||
cleanUrlParameters: []
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
status: 200
|
||||
content: '{"server_time":"22:46:25"}'
|
||||
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
|
||||
uri: api/server-date
|
||||
metadata:
|
||||
groupName: Time
|
||||
groupDescription: ''
|
||||
subgroup: 'Server Info'
|
||||
subgroupDescription: ''
|
||||
title: 'Get current server date.'
|
||||
description: ''
|
||||
authenticated: false
|
||||
custom: []
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters: []
|
||||
cleanUrlParameters: []
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
status: 200
|
||||
content: '{"server_date":"2025-01-21"}'
|
||||
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: []
|
||||
+4
-388
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,92 @@
|
||||
name: '🪙 Gold'
|
||||
description: ''
|
||||
endpoints:
|
||||
-
|
||||
httpMethods:
|
||||
- GET
|
||||
uri: api/gold-rates
|
||||
metadata:
|
||||
groupName: '🪙 Gold'
|
||||
groupDescription: ''
|
||||
subgroup: 'Fetch Rates'
|
||||
subgroupDescription: ''
|
||||
title: 'Get current gold rates.'
|
||||
description: ''
|
||||
authenticated: false
|
||||
custom: []
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters: []
|
||||
cleanUrlParameters: []
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
status: 200
|
||||
content: '{"Meta_Data":{"Minutes_Ago":-0.02,"Current_Date":"2025-01-21 22:46:25","Update_Date":"2025-01-21 22:46:24"},"Rates":{"GRA":{"Selling":3140.98,"Type":"Gold","Name":"GRAMALTIN","Change":1.34,"Buying":3140.64},"GUM":{"Selling":35.28,"Type":"Gold","Name":"GUMUS","Change":0.9,"Buying":35.23},"BRE":{"Selling":0,"Type":"Gold","Name":"BRENT","Change":-0.5},"ONS":{"Buying":0,"Type":"Gold","Name":"ONS","Selling":0,"Change":1.21},"HAS":{"Buying":3125.34,"Type":"Gold","Name":"GRAMHASALTIN","Selling":3125.77,"Change":1.36},"CEY":{"Buying":4996.08,"Type":"Gold","Name":"CEYREKALTIN","Selling":5109.73,"Change":0.73},"YAR":{"Buying":9960.93,"Type":"Gold","Name":"YARIMALTIN","Selling":10219.46,"Change":0.73},"TAM":{"Buying":19984.31,"Type":"Gold","Name":"TAMALTIN","Selling":20376.41,"Change":0.73},"CUM":{"Buying":20709,"Type":"Gold","Name":"CUMHURIYETALTINI","Selling":21022,"Change":0.77},"ATA":{"Buying":20608.82,"Type":"Gold","Name":"ATAALTIN","Selling":21126.46,"Change":0.73},"ODA":{"Buying":1779.85,"Type":"Gold","Name":"14AYARALTIN","Selling":1781.37,"Change":0.73},"OSA":{"Buying":2279.46,"Type":"Gold","Name":"18AYARALTIN","Selling":2281.41,"Change":0.73},"YIA":{"Buying":2847.76,"Type":"Gold","Name":"22AYARBILEZIK","Selling":2850.2,"Change":0.73},"IKI":{"Buying":49960.78,"Type":"Gold","Name":"IKIBUCUKALTIN","Selling":50753.51,"Change":0.73},"BES":{"Buying":101170.59,"Type":"Gold","Name":"BESLIALTIN","Selling":103132.13,"Change":0.73},"GRE":{"Buying":49960.78,"Type":"Gold","Name":"GREMSEALTIN","Selling":51097.28,"Change":0.73},"RES":{"Buying":20608.82,"Type":"Gold","Name":"RESATALTIN","Selling":21126.46,"Change":0.73},"HAM":{"Buying":20608.82,"Type":"Gold","Name":"HAMITALTIN","Selling":21126.46,"Change":0.73},"GPL":{"Buying":1081.39,"Type":"Gold","Name":"GRAMPLATIN","Selling":1085.18,"Change":-0.4}}}'
|
||||
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
|
||||
uri: 'api/gold-rates/{goldName}'
|
||||
metadata:
|
||||
groupName: '🪙 Gold'
|
||||
groupDescription: ''
|
||||
subgroup: 'Fetch Rates'
|
||||
subgroupDescription: ''
|
||||
title: 'Get gold rate by name.'
|
||||
description: ''
|
||||
authenticated: false
|
||||
custom: []
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters:
|
||||
goldName:
|
||||
name: goldName
|
||||
description: ''
|
||||
required: true
|
||||
example: porro
|
||||
type: string
|
||||
enumValues: []
|
||||
exampleWasSpecified: false
|
||||
nullable: false
|
||||
custom: []
|
||||
cleanUrlParameters:
|
||||
goldName: porro
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
status: 404
|
||||
content: '{"error":"Currency not found"}'
|
||||
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: []
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,81 @@
|
||||
name: Time
|
||||
description: ''
|
||||
endpoints:
|
||||
-
|
||||
httpMethods:
|
||||
- GET
|
||||
uri: api/server-time
|
||||
metadata:
|
||||
groupName: Time
|
||||
groupDescription: ''
|
||||
subgroup: 'Server Info'
|
||||
subgroupDescription: ''
|
||||
title: 'Get current server time.'
|
||||
description: ''
|
||||
authenticated: false
|
||||
custom: []
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters: []
|
||||
cleanUrlParameters: []
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
status: 200
|
||||
content: '{"server_time":"22:46:25"}'
|
||||
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
|
||||
uri: api/server-date
|
||||
metadata:
|
||||
groupName: Time
|
||||
groupDescription: ''
|
||||
subgroup: 'Server Info'
|
||||
subgroupDescription: ''
|
||||
title: 'Get current server date.'
|
||||
description: ''
|
||||
authenticated: false
|
||||
custom: []
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
Accept: application/json
|
||||
urlParameters: []
|
||||
cleanUrlParameters: []
|
||||
queryParameters: []
|
||||
cleanQueryParameters: []
|
||||
bodyParameters: []
|
||||
cleanBodyParameters: []
|
||||
fileParameters: []
|
||||
responses:
|
||||
-
|
||||
status: 200
|
||||
content: '{"server_date":"2025-01-21"}'
|
||||
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: []
|
||||
Reference in New Issue
Block a user