Add stub OpenAPI spec #322
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
|
we should move the file under |
Co-authored-by: Tomas Zemanovic <tomas@heliax.dev>
tzemanovic
force-pushed
the
james/mainline/abci-query-openapi-spec
branch
from
0970a9a
to
d758b1b
Compare
done in d758b1b |
juped
added a commit
that referenced
this pull request
Sep 20, 2022
* main: (118 commits) Revert "Update getting-started.md" Update getting-started.md changelog: add #442 rustdoc: fix outdated links make build-doc: only build rustdoc in this command [ci] remove drone ci: double the build-and-test timeout [ci] download masp paramters [ci] improve automation tool, add pls spawn devnet command [ci] added dev documentation build, added rust doc build I removed the limitation. I removed the limitation. encoding_spec: rm ":" from fragment links in e.g. `ed25519::PublicKey` docs/dev: update encoding spec generation [fix] use fetch-depth: 0 on tag pipeline Namada 0.7.1 fix spelling of 'features' in Cargo.toml realign cargo/wasm integrity changelog: add #278 test: allow to sign and verify secp256k1 client: add check on validator consensus key shared: optional secp256k1 signing and verification to avoid wasm bloat pick scheme for generating validator keys must use ed25519 for validator consensus key and node ID update rustdoc on PKH make fmt deps: enable secp256k1 in tendermint-rs handle secp256k1 in key_to_tendermint() fmt && clippy use heliaxdev/libsecp256k1 crate fork as dependency for now release: update release.toml for namada repo new test for zeroizing secp256k1 keys wrap libsecp256k1::SecretKey in a Box within SecretKey struct add a test to zeroize secp256k1 fix bug in supplying args to test_genesis_validators() make validator_key_to_json() compatible with ed25519 and secp256k1 keys fix bug to prevent generating keys with common SchemeType fix bug where we were generating a key with common scheme make fmt fix unit test test_toml_roundtrip to supply good validator keys e2e test_genesis_validators(): make each validator have different key scheme fix some comments fix bug in supplying keypair to Tendermint clean and simplify code in id_from_pk() allow CL specification of a specific key scheme for the TxInitValidator improve write_tendermint_node_key() to produce the proper json given the underlying key scheme convert from common to underlying key type in id_from_pk() when constructing the TendermintNodeId change variable names in fns try_to_sk() and try_to_sig() to reduce confusion clean up code implementing Serialize/Deserialize, comment on certain implementations remove Result layering for id_from_pk drop 'Consensus' from SchemeType enum variants incorporate options into key generation functions command line options for specifying key scheme initial commit for supporting secp256k1 keys clean and simplify code in id_from_pk() allow CL specification of a specific key scheme for the TxInitValidator improve write_tendermint_node_key() to produce the proper json given the underlying key scheme convert from common to underlying key type in id_from_pk() when constructing the TendermintNodeId change variable names in fns try_to_sk() and try_to_sig() to reduce confusion clean up code implementing Serialize/Deserialize, comment on certain implementations remove Result layering for id_from_pk drop 'Consensus' from SchemeType enum variants make libsecp256k1 objects public when wrapped within our own Key and Sig objects remove clippy::bind_instead_of_map now that we will use wildcard incorporate options into key generation functions command line options for specifying key scheme initial commit for supporting secp256k1 keys changelog: add #277 move zeroize test out of macro (also in advance of incorporating secp256k1) wrap SigningKey in a Box pointer when placing into SecretKey struct, test that memory is actually zeroized after dropping SecretKey changes to Cargo.toml and Cargo.lock from adding latest version of zeroize crate docs: update book's config branch, edit-url and repo links docs: add notes about the books doc/docs: s/anoma/namada re-add `dev` docs section update outer readme Replace anoma with namada in quickstart Update config files update links to user guide docs update relative paths in dev docs changelog: add #322 docs: move and link to openAPI spec from Ledger RPC Apply suggestions from code review Storage key regexes should permit any UTF-8 string Add invalid storage key error response example Add example for getting an account's public key A key can contain any ASCII, not just alphabetical characters Add specs/openapi.yml Add changelog .gitignore: make some patterns relative to repo root Add changelog .gitignore: make some patterns relative to repo root change string to valid path Initial info on Secp256k1 keys and zeroizing secret keys crypto.md: add context for signatures crypto.md: remove outdated encoding descriptions crypto.md: remove references to closed issue Updates changelog Removes mention to clap version Fixes typos. Updates comment on `clap` ...
tzemanovic
added a commit
that referenced
this pull request
Sep 23, 2022
* tomas/fix-rustdoc: (116 commits) changelog: add #442 rustdoc: fix outdated links make build-doc: only build rustdoc in this command [ci] remove drone ci: double the build-and-test timeout [ci] download masp paramters [ci] improve automation tool, add pls spawn devnet command [ci] added dev documentation build, added rust doc build I removed the limitation. I removed the limitation. encoding_spec: rm ":" from fragment links in e.g. `ed25519::PublicKey` docs/dev: update encoding spec generation [fix] use fetch-depth: 0 on tag pipeline Namada 0.7.1 fix spelling of 'features' in Cargo.toml realign cargo/wasm integrity changelog: add #278 test: allow to sign and verify secp256k1 client: add check on validator consensus key shared: optional secp256k1 signing and verification to avoid wasm bloat pick scheme for generating validator keys must use ed25519 for validator consensus key and node ID update rustdoc on PKH make fmt deps: enable secp256k1 in tendermint-rs handle secp256k1 in key_to_tendermint() fmt && clippy use heliaxdev/libsecp256k1 crate fork as dependency for now release: update release.toml for namada repo new test for zeroizing secp256k1 keys wrap libsecp256k1::SecretKey in a Box within SecretKey struct add a test to zeroize secp256k1 fix bug in supplying args to test_genesis_validators() make validator_key_to_json() compatible with ed25519 and secp256k1 keys fix bug to prevent generating keys with common SchemeType fix bug where we were generating a key with common scheme make fmt fix unit test test_toml_roundtrip to supply good validator keys e2e test_genesis_validators(): make each validator have different key scheme fix some comments fix bug in supplying keypair to Tendermint clean and simplify code in id_from_pk() allow CL specification of a specific key scheme for the TxInitValidator improve write_tendermint_node_key() to produce the proper json given the underlying key scheme convert from common to underlying key type in id_from_pk() when constructing the TendermintNodeId change variable names in fns try_to_sk() and try_to_sig() to reduce confusion clean up code implementing Serialize/Deserialize, comment on certain implementations remove Result layering for id_from_pk drop 'Consensus' from SchemeType enum variants incorporate options into key generation functions command line options for specifying key scheme initial commit for supporting secp256k1 keys clean and simplify code in id_from_pk() allow CL specification of a specific key scheme for the TxInitValidator improve write_tendermint_node_key() to produce the proper json given the underlying key scheme convert from common to underlying key type in id_from_pk() when constructing the TendermintNodeId change variable names in fns try_to_sk() and try_to_sig() to reduce confusion clean up code implementing Serialize/Deserialize, comment on certain implementations remove Result layering for id_from_pk drop 'Consensus' from SchemeType enum variants make libsecp256k1 objects public when wrapped within our own Key and Sig objects remove clippy::bind_instead_of_map now that we will use wildcard incorporate options into key generation functions command line options for specifying key scheme initial commit for supporting secp256k1 keys changelog: add #277 move zeroize test out of macro (also in advance of incorporating secp256k1) wrap SigningKey in a Box pointer when placing into SecretKey struct, test that memory is actually zeroized after dropping SecretKey changes to Cargo.toml and Cargo.lock from adding latest version of zeroize crate docs: update book's config branch, edit-url and repo links docs: add notes about the books doc/docs: s/anoma/namada re-add `dev` docs section update outer readme Replace anoma with namada in quickstart Update config files update links to user guide docs update relative paths in dev docs changelog: add #322 docs: move and link to openAPI spec from Ledger RPC Apply suggestions from code review Storage key regexes should permit any UTF-8 string Add invalid storage key error response example Add example for getting an account's public key A key can contain any ASCII, not just alphabetical characters Add specs/openapi.yml Add changelog .gitignore: make some patterns relative to repo root Add changelog .gitignore: make some patterns relative to repo root change string to valid path Initial info on Secp256k1 keys and zeroizing secret keys crypto.md: add context for signatures crypto.md: remove outdated encoding descriptions crypto.md: remove references to closed issue Updates changelog Removes mention to clap version Fixes typos. Updates comment on `clap` docs/dev: remove PoS spec and link to spec page instead changelog: add #1070 ...
phy-chain
pushed a commit
to phy-chain/namada
that referenced
this pull request
Mar 1, 2024
* feat: do not decrypt mnemonic for auth * feat: create utility store
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.
moved from anoma/anoma#1228
based on #266
Relates to #149
This is a stub OpenAPI spec that could be imported with Insomnia or Postman, with only one type of operation - making a call via
abci_queryof Tendermint RPC. The default server is the ledger running on your localhost (http://127.0.0.1:26657). Many more examples could be added, e.g. specificvalue/<path>queries for common VPs such asvp_token(or alternatively we could have VP-specific OpenAPI files?).Unfortunately only the first example is imported into tools such as Insomnia or Postman. Maintaining a direct Postman collection of examples as well as/instead of this OpenAPI spec may be better. Unsure where the most appropriate place for this OpenAPI spec file is (maybe
specs/ordocs/somewhere?).