paritytech / paritytech/json-rpc-interface-spec
`archive_v1_storage`: clarify `paginationStartKey` property
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 37
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
The spec says:
paginationStartKey: This parameter is optional and should be a string containing the hexadecimal-encoded key from which the storage iteration should resume. This parameter is only valid in the context of descendantsValues and descendantsHashes.
Does storage iteration resume by handing back the value for the given paginationStartKey, or the first value after the paginationStartKey? The wording isn't clear to me.
(In my current case, which is being able to resume in the event of disconnect, the desired property is that we get back the first value after the provided key, but in that case I would also rename the field to something like afterKey in a future version to be clear. Are there any cases where we would want to obtain the paginationStartKey itself though?)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the specification entries for paginationStartKey, descendantsValues, and descendantsHashes, then review the single existing comment for the intended iteration semantics. Resolve whether the key is included or skipped and update the specification so the behavior and completion criteria are explicit.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100