Transaction metadata in swagger API spec #2087
Merged
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
KtorZ
approved these changes
Aug 28, 2020
|
I found it difficult to debug swagger validation errors, so wrote this wiki doc: Swagger Development. |
Merged
|
bors r+ |
iohk-bors bot
added a commit
that referenced
this pull request
Aug 28, 2020
2066: Bump cardano-addresses r=rvl a=Anviking # Issue Number Release. # Overview <!-- Detail in a few bullet points the work accomplished in this PR --> - [x] Bump cardano-addresses # Comments - I believe this purely affects CLI usage of the cardano-addresses binary that will get included in the wallet release ``` Bump includes: - [Increase default mnemonic phrase length](IntersectMBO/cardano-addresses#53) - [Allow to inspect reward accounts wrt #46](IntersectMBO/cardano-addresses#56) - [Allow to generate stake addresses #58](IntersectMBO/cardano-addresses#58) - [Make 'payment' subcommand generate testnet hrp, wrt #55](IntersectMBO/cardano-addresses#59) ``` <!-- Additional comments or screenshots to attach if any --> <!-- Don't forget to: ✓ Self-review your changes to make sure nothing unexpected slipped through ✓ Assign yourself to the PR ✓ Assign one or several reviewer(s) ✓ Once created, link this PR to its corresponding ticket ✓ Assign the PR to a corresponding milestone ✓ Acknowledge any changes required to the Wiki --> 2071: Minor nix cleanups r=rvl a=rvl ### Issue Number #2046 #2054 ### Overview - Minor cleanups of nix code for migration tests and latency benchmark. ### Comments Tested with: ``` nix-build -A benchmarks.cardano-wallet.latency nix-build nix/migration-tests.nix ``` 2080: Also trace the times of stake distribution LSQ queries r=rvl a=Anviking # Issue Number #2005 / new issue # Overview <!-- Detail in a few bullet points the work accomplished in this PR --> - [x] Also measure and trace the times of the LSQ queries in the `stakeDistribution` function # Comments <!-- Additional comments or screenshots to attach if any --> <!-- Don't forget to: ✓ Self-review your changes to make sure nothing unexpected slipped through ✓ Assign yourself to the PR ✓ Assign one or several reviewer(s) ✓ Once created, link this PR to its corresponding ticket ✓ Assign the PR to a corresponding milestone ✓ Acknowledge any changes required to the Wiki --> 2087: Transaction metadata in swagger API spec r=rvl a=rvl ### Issue Number ADP-307 / #2073 / #2074 ### Overview Updates the swagger spec for the new metadata field when: - listing transactions (metadata field is always present but may be null) - posting a transaction (metadata field is optional) - estimating fee (as above) ### Comments [Rendered spec](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/input-output-hk/cardano-wallet/rvl/2073/swagger/specifications/api/swagger.yaml) Co-authored-by: Johannes Lund <[email protected]> Co-authored-by: IOHK <[email protected]> Co-authored-by: Rodney Lorrimar <[email protected]> Co-authored-by: KtorZ <[email protected]>
Build failed (retrying...) |
iohk-bors bot
added a commit
that referenced
this pull request
Aug 28, 2020
2080: Also trace the times of stake distribution LSQ queries r=rvl a=Anviking # Issue Number #2005 / new issue # Overview <!-- Detail in a few bullet points the work accomplished in this PR --> - [x] Also measure and trace the times of the LSQ queries in the `stakeDistribution` function # Comments <!-- Additional comments or screenshots to attach if any --> <!-- Don't forget to: ✓ Self-review your changes to make sure nothing unexpected slipped through ✓ Assign yourself to the PR ✓ Assign one or several reviewer(s) ✓ Once created, link this PR to its corresponding ticket ✓ Assign the PR to a corresponding milestone ✓ Acknowledge any changes required to the Wiki --> 2087: Transaction metadata in swagger API spec r=rvl a=rvl ### Issue Number ADP-307 / #2073 / #2074 ### Overview Updates the swagger spec for the new metadata field when: - listing transactions (metadata field is always present but may be null) - posting a transaction (metadata field is optional) - estimating fee (as above) ### Comments [Rendered spec](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/input-output-hk/cardano-wallet/rvl/2073/swagger/specifications/api/swagger.yaml) Co-authored-by: Johannes Lund <[email protected]> Co-authored-by: Rodney Lorrimar <[email protected]> Co-authored-by: KtorZ <[email protected]>
Build failed (retrying...) |
iohk-bors bot
added a commit
that referenced
this pull request
Aug 28, 2020
2087: Transaction metadata in swagger API spec r=rvl a=rvl ### Issue Number ADP-307 / #2073 / #2074 ### Overview Updates the swagger spec for the new metadata field when: - listing transactions (metadata field is always present but may be null) - posting a transaction (metadata field is optional) - estimating fee (as above) ### Comments [Rendered spec](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/input-output-hk/cardano-wallet/rvl/2073/swagger/specifications/api/swagger.yaml) Co-authored-by: Rodney Lorrimar <[email protected]> Co-authored-by: KtorZ <[email protected]>
Build failed |
jonathanknowles
approved these changes
Aug 31, 2020
|
|
||
| See the example on the right to get an overview and the | ||
| equivalence table below to understand how metadata are mapped to | ||
| on-chain data types. |
There was a problem hiding this comment.
Just out of interest, what does "on the right" refer to here?
Suggestion: if this wording relies on a particular rendering style, perhaps it's better to use a layout-neutral method to refer to examples? (I'm guessing that not everyone will be viewing the API spec through the web tool that we provide.)
There was a problem hiding this comment.
It refers to our current documentation layout indeed.
|
@rvl I'll look at the swagger failure above, this is a bit tricky because we use OpenAPI 3.0 but the Haskell library we use expects swagger 2.0 format, so there are some subtleties... |
|
Oh ok - I assumed it was maybe because the endpoints in the swagger file need to be added to the servant API. |
Some extra examples and documentation to better understand how JSON types are mapped to on-chain types.
KtorZ
force-pushed
the
rvl/2073/swagger
branch
from
2ffe45e to
10d022d
Compare
|
bors r+ |
iohk-bors bot
added a commit
that referenced
this pull request
Aug 31, 2020
2087: Transaction metadata in swagger API spec r=KtorZ a=rvl ### Issue Number ADP-307 / #2073 / #2074 ### Overview Updates the swagger spec for the new metadata field when: - listing transactions (metadata field is always present but may be null) - posting a transaction (metadata field is optional) - estimating fee (as above) ### Comments [Rendered spec](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/input-output-hk/cardano-wallet/rvl/2073/swagger/specifications/api/swagger.yaml) Co-authored-by: Rodney Lorrimar <[email protected]> Co-authored-by: KtorZ <[email protected]>
Build failed |
KtorZ
force-pushed
the
rvl/2073/swagger
branch
from
10d022d to
81b6a23
Compare
|
bors r+ |
Build succeeded |
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-307 / #2073 / #2074
Overview
Updates the swagger spec for the new metadata field when:
Comments
Rendered spec