smeb_y/0g-chain
1
0
Fork 0
mirror of https://github.com/0glabs/0g-chain.git synced 2024-12-27 16:55:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update swagger (#690)

Browse Source
This commit is contained in:
Denali Marsh 2020-10-16 16:10:58 +02:00 committed by GitHub
parent 74bbb6a0d7
commit 20280c7247
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
swagger-ui/swagger.yaml
View File

@ -446,7 +446,7 @@
description: Collateral type description: Collateral type
required: true required: true
type: string type: string
x-example: xrp-a x-example: xrpb-a
- description: deposit cdp post parameters - description: deposit cdp post parameters
name: post_deposit_req name: post_deposit_req
in: body in: body
@ -494,7 +494,7 @@
description: Collateral type description: Collateral type
required: true required: true
type: string type: string
x-example: xrp-a x-example: xrpb-a
- description: withdraw cdp post parameters - description: withdraw cdp post parameters
name: post_withdraw_req name: post_withdraw_req
in: body in: body
@ -542,7 +542,7 @@
description: Collateral type description: Collateral type
required: true required: true
type: string type: string
x-example: xrp-a x-example: xrpb-a
- description: draw cdp post parameters - description: draw cdp post parameters
name: post_draw_req name: post_draw_req
in: body in: body
@ -588,7 +588,7 @@
description: Collateral type description: Collateral type
required: true required: true
type: string type: string
x-example: xrp-a x-example: xrpb-a
- description: repay cdp post parameters - description: repay cdp post parameters
name: post_repay_req name: post_repay_req
in: body in: body
@ -715,7 +715,7 @@
description: Collateral type description: Collateral type
required: true required: true
type: string type: string
x-example: xrp-a x-example: xrpb-a
responses: responses:
200: 200:
description: CDP associated with owner description: CDP associated with owner
@ -723,7 +723,7 @@
$ref: '#/definitions/CdpResponse' $ref: '#/definitions/CdpResponse'
500: 500:
description: Server internal error description: Server internal error
/cdp/cdps/denom/{collateral-type}: /cdp/cdps/collateralType/{collateral-type}:
get: get:
summary: Get all cdps with collateral type equal to the input collateral type summary: Get all cdps with collateral type equal to the input collateral type
tags: tags:
@ -736,7 +736,7 @@
description: Collateral Type description: Collateral Type
required: true required: true
type: string type: string
x-example: xrp-a x-example: xrpb-a
responses: responses:
200: 200:
description: All CDPs with the input collateral type description: All CDPs with the input collateral type
@ -766,7 +766,7 @@
description: Collateral type description: Collateral type
required: true required: true
type: string type: string
x-example: xrp-a x-example: xrpb-a
- in: path - in: path
name: ratio name: ratio
description: Collateralization ratio description: Collateralization ratio
@ -808,7 +808,7 @@
description: Collateral type description: Collateral type
required: true required: true
type: string type: string
x-example: xrp-a x-example: xrpb-a
responses: responses:
200: 200:
description: Deposits associated with the cdp description: Deposits associated with the cdp
@ -824,7 +824,7 @@
$ref: '#/definitions/CdpDepositResponse' $ref: '#/definitions/CdpDepositResponse'
500: 500:
description: Server internal error description: Server internal error
/cdp/savings-rate-dist: /cdp/savingsRateDist:
get: get:
summary: Get the total savings rate distributed by the cdp module summary: Get the total savings rate distributed by the cdp module
tags: tags:
@ -844,6 +844,26 @@
example: "5000000000000" example: "5000000000000"
500: 500:
description: Server internal error description: Server internal error
/cdp/savingsRateDistTime:
get:
summary: Get the most recent savings rate distribution time
tags:
- CDP
produces:
- application/json
responses:
200:
description: The most recent savings rate distribution time
properties:
height:
type: string
example: "100"
result:
savings_rate_distributed:
type: string
example: "2020-10-14T14:00:06.955036063Z"
500:
description: Server internal error
/cdp/cdps: /cdp/cdps:
get: get:
summary: Query all active cdps summary: Query all active cdps
@ -863,7 +883,7 @@
description: Collateral type description: Collateral type
required: false required: false
type: string type: string
x-example: xrp-a x-example: xrpb-a
- in: query - in: query
name: id name: id
description: CDP ID description: CDP ID
@ -3971,7 +3991,7 @@
example: '555555' example: '555555'
CollateralType: CollateralType:
type: string type: string
example: xrp-a example: xrpb-a
CoinCollateral: CoinCollateral:
type: object type: object
properties: properties:
@ -4421,7 +4441,7 @@
$ref: '#/definitions/CoinCollateral' $ref: '#/definitions/CoinCollateral'
type: type:
type: string type: string
example: "xrp-a" example: "xrpb-a"
principal: principal:
$ref: '#/definitions/CoinPrincipal' $ref: '#/definitions/CoinPrincipal'
accumulated_fees: accumulated_fees: