Swagger adjustment: Supported pool id param is hex or bech32 #2093
Conversation
piotr-iohk
added
the
RESOLVING ISSUE
specifications/api/swagger.yaml
Outdated
| maxLength: 56 | ||
| minLength: 64 | ||
| minLength: 56 |
There was a problem hiding this comment.
Empirically I see that pool ids (no matter if in hex or bech32 format) have consistently 56 char length 🤷♂️
There was a problem hiding this comment.
@KtorZ is that something we can guarantee? I'm not sure how deterministic bech32 is here.
There was a problem hiding this comment.
I don't think this is right indeed, so we could leave it as a comment in the description instead.
Also, pool ids can be 64 chars ..... with jormungandr :s
There was a problem hiding this comment.
I have added a comment. Pls let me know it that's fine.
piotr-iohk
force-pushed
the
piotr/update_swagger_pool_id
branch
from
01d5d50 to
104c2b3
Compare
specifications/api/swagger.yaml
Outdated
| @@ -2226,6 +2224,9 @@ paths: | |||
| <p align="right">status: <strong>stable</strong></p> | |||
|
|
|||
| Delegate all (current and future) addresses from the given wallet to the given stake pool. | |||
|
|
|||
| <strong>Note:</strong> Stake pool id lenght can be undeterministic when encoded as bech32. | |||
piotr-iohk
force-pushed
the
piotr/update_swagger_pool_id
branch
from
104c2b3 to
2017bc1
Compare
specifications/api/swagger.yaml
Outdated
| @@ -2226,6 +2224,9 @@ paths: | |||
| <p align="right">status: <strong>stable</strong></p> | |||
|
|
|||
| Delegate all (current and future) addresses from the given wallet to the given stake pool. | |||
|
|
|||
| <strong>Note:</strong> Stake pool id length can be undeterministic when encoded as bech32. | |||
There was a problem hiding this comment.
I'm not sure that "undeterministic" (which should probably be "nondeterministic") is the best way to word this.
Readers might infer that the bech32 encoding is nondeterministic in its length. Of course this is not true, as Bech32 encoding is completely deterministic.
Perhaps we could instead say something like:
Bech32-encoded stake pool identifiers can vary in length.
And perhaps then give some examples to illustrate the different lengths that are possible.
@piotr-iohk What do you think?
There was a problem hiding this comment.
I'm not sure that "undeterministic" (which should probably read "nondeterministic") is the best way to word this.
Unfamiliar readers might infer that the bech32 encoding is nondeterministic in its length. (Of course as we know this isn't true, as Bech32 encoding is completely deterministic.)
Perhaps we could instead say something like:
Bech32-encoded stake pool identifiers can vary in length.
And perhaps then give some examples to illustrate the different lengths that are possible.
What do you think?
specifications/api/swagger.yaml
Outdated
| @@ -2226,6 +2224,9 @@ paths: | |||
| <p align="right">status: <strong>stable</strong></p> | |||
|
|
|||
| Delegate all (current and future) addresses from the given wallet to the given stake pool. | |||
|
|
|||
| <strong>Note:</strong> Stake pool id length can be undeterministic when encoded as bech32. | |||
There was a problem hiding this comment.
I'm not sure that "undeterministic" (which should probably be "nondeterministic") is the best way to word this.
Readers might infer that the bech32 encoding is nondeterministic in its length. Of course this is not true, as Bech32 encoding is completely deterministic.
Perhaps we could instead say something like:
Bech32-encoded stake pool identifiers can vary in length.
And perhaps then give some examples to illustrate the different lengths that are possible.
@piotr-iohk What do you think?
piotr-iohk
force-pushed
the
piotr/update_swagger_pool_id
branch
from
2017bc1 to
985a129
Compare
|
bors r+ |
Build succeeded |
Issue Number
#2023
#2025
Overview
Supported pool id param is hex or bech32
Comments
Before:
After: