API spec: First revision of multi-asset changes #2446
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rvl
added
the
ADDING FEATURE
rvl
force-pushed
the
rvl/adp-603/api-spec-ma
branch
5 times, most recently
from
80f4f08 to
c53bae4
Compare
KtorZ
reviewed
Jan 14, 2021
specifications/api/swagger.yaml
Outdated
| # fixme: (remove this note) I changed it to hex from base64, the reason is below. | ||
| format: hex | ||
| maxLength: 64 | ||
| # fixme: (remove this note) multiple examples seem not to validate |
There was a problem hiding this comment.
Unfortunately no, OpenAPI does not support multiple examples... I think there's a Redoc extension we could use if we really wanted that, but it's a vendor-specific extension so not a pure OpenAPI primitive.
rvl
force-pushed
the
rvl/adp-603/api-spec-ma
branch
3 times, most recently
from
9a424a6 to
2994e6e
Compare
|
@rvl I've been capturing the metadata in a confluence document: https://input-output.atlassian.net/wiki/spaces/AD/pages/2137456733/Token+Identity+Metadata I've added a few (sensible) constraints / validations not yet present in our swagger specs (e.g. maxLength for the token's name) |
Anviking
reviewed
Jan 19, 2021
| @@ -236,7 +236,7 @@ x-syncClockProgress: &syncClockProgress | |||
| status: pending | |||
|
|
|||
| x-amount: &amount | |||
| description: Coins, in Lovelace | |||
| description: Coins, in Lovelace. Only relates to 'Ada'. Refer to `assets` for multi-assets wallets instead. | |||
There was a problem hiding this comment.
Q: Can a user specify to send 0 ada, and 1 Apple asset?
I'm guessing: yes, but the coin selection will automatically send the minimum required ada along in the token bundle?
There was a problem hiding this comment.
Indeed. And also assign the minimum ada value needed for the multi asset UTxO.
|
Thanks @KtorZ I shall apply that json schema to the I have one issue with the metadata schema. |
|
@rvl good point. We can still change that. |
Some reordering required to please the openapi-spec-validator.
rvl
force-pushed
the
rvl/adp-603/api-spec-ma
branch
from
24466c7 to
cad01cd
Compare
iohk-bors bot
added a commit
that referenced
this pull request
Jan 25, 2021
2447: Multi-asset API extensions r=rvl a=rvl ### Issue Number ADP-604 ### Overview Starting implementation of API spec in #2446. - [x] listAssets endpoint - [x] getAsset endpoint - [x] Added `ApiWalletAssetsBalance` which provides the balance of non-ade assets. - [x] Removed WalletBalance from Primitive.Types and replaced `ApiT WalletBalance` with `ApiWalletBalance`. - [ ] Some kind of integration test for these endpoints. - [x] Remove `Quantity "lovelace" a` where possible, except for the API. - [x] TokenName inner type is now ByteString, add length validation. ### Comments - This branch is based on top of the PR #2446 branch. Co-authored-by: KtorZ <[email protected]> Co-authored-by: Rodney Lorrimar <[email protected]>
iohk-bors bot
added a commit
that referenced
this pull request
Jan 25, 2021
2447: Multi-asset API extensions r=Anviking a=rvl ### Issue Number ADP-604 ### Overview Starting implementation of API spec in #2446. - [x] listAssets endpoint - [x] getAsset endpoint - [x] Added `ApiWalletAssetsBalance` which provides the balance of non-ade assets. - [x] Removed WalletBalance from Primitive.Types and replaced `ApiT WalletBalance` with `ApiWalletBalance`. - [ ] Some kind of integration test for these endpoints. - [x] Remove `Quantity "lovelace" a` where possible, except for the API. - [x] TokenName inner type is now ByteString, add length validation. ### Comments - This branch is based on top of the PR #2446 branch. Co-authored-by: KtorZ <[email protected]> Co-authored-by: Rodney Lorrimar <[email protected]>
iohk-bors bot
added a commit
that referenced
this pull request
Jan 25, 2021
2447: Multi-asset API extensions r=Anviking a=rvl ### Issue Number ADP-604 ### Overview Starting implementation of API spec in #2446. - [x] listAssets endpoint - [x] getAsset endpoint - [x] Added `ApiWalletAssetsBalance` which provides the balance of non-ade assets. - [x] Removed WalletBalance from Primitive.Types and replaced `ApiT WalletBalance` with `ApiWalletBalance`. - [ ] Some kind of integration test for these endpoints. - [x] Remove `Quantity "lovelace" a` where possible, except for the API. - [x] TokenName inner type is now ByteString, add length validation. ### Comments - This branch is based on top of the PR #2446 branch. Co-authored-by: KtorZ <[email protected]> Co-authored-by: Rodney Lorrimar <[email protected]>
iohk-bors bot
added a commit
that referenced
this pull request
Jan 25, 2021
2447: Multi-asset API extensions r=Anviking a=rvl ### Issue Number ADP-604 ### Overview Starting implementation of API spec in #2446. - [x] listAssets endpoint - [x] getAsset endpoint - [x] Added `ApiWalletAssetsBalance` which provides the balance of non-ade assets. - [x] Removed WalletBalance from Primitive.Types and replaced `ApiT WalletBalance` with `ApiWalletBalance`. - [ ] Some kind of integration test for these endpoints. - [x] Remove `Quantity "lovelace" a` where possible, except for the API. - [x] TokenName inner type is now ByteString, add length validation. ### Comments - This branch is based on top of the PR #2446 branch. Co-authored-by: KtorZ <[email protected]> Co-authored-by: Rodney Lorrimar <[email protected]>
|
closing since #2447 has been merged and was already including this chunk of work. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue Number
ADP-603
Overview
Adjusts the OpenAPI specification to include multi-asset amounts in transactions and wallet balances.
Changes are designed to preserve API backwards compatibility, if users only care about Ada amounts.
A primary consideration was how multi-asset values would be presented and manipulated in user interfaces such as Daedalus.
Comments