Reckless-Satoshi/robosats
1
1
Fork 0
mirror of https://github.com/Reckless-Satoshi/robosats.git synced 2024-08-16 23:30:29 +03:00
Code Issues Projects Releases Wiki Activity

chore(api): update api schema

Browse Source
This commit is contained in:
Reckless_Satoshi 2024-04-21 22:24:05 +01:00
parent f0385f8040
commit 707f76832b
No known key found for this signature in database
GPG Key ID: 9C4585B561315571
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/assets/schemas/api-latest.yaml
View File

@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: RoboSats REST API
version: 0.5.4
version: 0.6.0
x-logo:
url: https://raw.githubusercontent.com/Reckless-Satoshi/robosats/main/frontend/static/assets/images/robosats-0.1.1-banner.png
backgroundColor: '#FFFFFF'
@ -1077,6 +1077,7 @@ components:
status:
allOf:
- $ref: '#/components/schemas/StatusEnum'
default: 0
minimum: 0
maximum: 32767
created_at:
@ -1100,6 +1101,7 @@ components:
nullable: true
has_range:
type: boolean
default: false
min_amount:
type: string
format: decimal
@ -1112,14 +1114,17 @@ components:
nullable: true
payment_method:
type: string
default: not specified
maxLength: 70
is_explicit:
type: boolean
default: false
premium:
type: string
format: decimal
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
nullable: true
default: '0.00'
satoshis:
type: integer
maximum: 5000000
@ -1135,10 +1140,12 @@ components:
type: integer
maximum: 28800
minimum: 1800
default: 10799
bond_size:
type: string
format: decimal
pattern: ^-?\d{0,2}(?:\.\d{0,2})?$
default: '3.00'
latitude:
type: string
format: decimal
@ -1205,6 +1212,7 @@ components:
format: decimal
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
nullable: true
default: '0.00'
satoshis:
type: integer
maximum: 5000000
@ -1214,14 +1222,17 @@ components:
type: integer
maximum: 86400
minimum: 597.6
default: 86399
escrow_duration:
type: integer
maximum: 28800
minimum: 1800
default: 10799
bond_size:
type: string
format: decimal
pattern: ^-?\d{0,2}(?:\.\d{0,2})?$
default: '3.00'
latitude:
type: string
format: decimal
@ -1261,6 +1272,7 @@ components:
status:
allOf:
- $ref: '#/components/schemas/StatusEnum'
default: 0
minimum: 0
maximum: 32767
created_at:
@ -1284,6 +1296,7 @@ components:
nullable: true
has_range:
type: boolean
default: false
min_amount:
type: string
format: decimal
@ -1296,9 +1309,11 @@ components:
nullable: true
payment_method:
type: string
default: not specified
maxLength: 70
is_explicit:
type: boolean
default: false
premium:
type: string
description: Premium over the CEX price set by the maker
@ -1324,6 +1339,7 @@ components:
type: integer
maximum: 28800
minimum: 1800
default: 10799
total_secs_exp:
type: integer
description: Duration of time (in seconds) to expire, according to the current
@ -1495,10 +1511,12 @@ components:
type: integer
maximum: 86400
minimum: 597.6
default: 86399
bond_size:
type: string
format: decimal
pattern: ^-?\d{0,2}(?:\.\d{0,2})?$
default: '3.00'
trade_fee_percent:
type: integer
description: The fee for the trade (fees differ for maker and taker)
@ -1580,6 +1598,7 @@ components:
nullable: true
has_range:
type: boolean
default: false
min_amount:
type: string
format: decimal
@ -1592,14 +1611,17 @@ components:
nullable: true
payment_method:
type: string
default: not specified
maxLength: 70
is_explicit:
type: boolean
default: false
premium:
type: string
format: decimal
pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
nullable: true
default: '0.00'
satoshis:
type: integer
maximum: 5000000
@ -1623,6 +1645,7 @@ components:
type: integer
maximum: 28800
minimum: 1800
default: 10799
satoshis_now:
type: integer
description: The amount of sats to be traded at the present moment (not
@ -1631,6 +1654,7 @@ components:
type: string
format: decimal
pattern: ^-?\d{0,2}(?:\.\d{0,2})?$
default: '3.00'
latitude:
type: string
format: decimal
@ -1867,6 +1891,7 @@ components:
fee:
type: string
format: decimal
default: '0.0000'
TypeEnum:
enum:
- 0