Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: BaseRequest order and add some missing description #13

Merged
merged 1 commit into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions shared/base.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,9 @@ components:

CurrencyAmount:
$id: CurrencyAmount
description: >
A CurrencyAmount is an object specifying a currency, a quantity of that currency, and the
counterparty (issuer) on the trustline that holds the value. For XRP, there is no counterparty.
oneOf:
- type: string
description: 'The amount of XRP (drops), represented as a string.'
Expand All @@ -202,6 +205,7 @@ components:
TokenAmount:
$id: TokenAmount
type: object
description: Specifies an amount of a (fungible) token.
properties:
currency:
type: string
Expand Down
2 changes: 1 addition & 1 deletion shared/requests/account_channels.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ components:
Returns an AccountChannelsResponse.
type: object
allOf:
- $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest'
- $ref: '../base.yaml#/components/schemas/BaseRequest'
- $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest'
properties:
account:
type: string
Expand Down
3 changes: 2 additions & 1 deletion shared/requests/account_info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ components:
Returns an AccountInfoResponse
type: object
allOf:
- $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest'
- $ref: '../base.yaml#/components/schemas/BaseRequest'
- $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest'
properties:
account:
type: string
Expand All @@ -26,6 +26,7 @@ components:

AccountRoot:
type: object
description: An AccountRoot ledger entry type describes a single account, its settings, and XRP balance.
properties:
Account:
type: string
Expand Down
2 changes: 1 addition & 1 deletion shared/requests/account_lines.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ components:
Returns an AccountLinesResponse
type: object
allOf:
- $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest'
- $ref: '../base.yaml#/components/schemas/BaseRequest'
- $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest'
properties:
account:
type: string
Expand Down
2 changes: 1 addition & 1 deletion shared/requests/ledger_entry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ components:
description: The ledger_entry method returns a single ledger entry from the XRP Ledger in its raw format. All information retrieved is relative to a particular version of the ledger.
type: object
allOf:
- $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest'
pdp2121 marked this conversation as resolved.
Show resolved Hide resolved
- $ref: '../base.yaml#/components/schemas/BaseRequest'
- $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest'
- $ref: '#/components/schemas/BaseLedgerEntryRequest'
- $ref: '#/components/schemas/LedgerEntryRequestOptions'

Expand Down
1 change: 1 addition & 0 deletions shared/transactions/payment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ components:

PathStep:
$id: PathStep
description: A PathStep represents an individual step along a Path.
type: object
properties:
account:
Expand Down
Loading