oasisprotocol / oasisprotocol/explorer
Serializing array of strings in API requests
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 13
- Avg merge
- 58m
- Merged PRs (30d)
- 2
Description
API specifies
https://github.com/oasisprotocol/nexus/blob/389cc9f2e08d0b0d0252b8594a2efe218e5fb5e4/api/spec/v1.yaml#L1274-L1277
style: form
explode: false
schema:
type: array
https://github.com/oasisprotocol/explorer/pull/2012 manually added paramsSerializer: paramSerializerWithComma
Ideally this should be fixed at orval config level (or even upstream) based on API definition, not manually
(related https://github.com/oasisprotocol/explorer/issues/1839)
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 referenced API definition in api/spec/v1.yaml and compare its form/explode settings with the manual paramsSerializer change from explorer PR 2012. Trace the Orval configuration or generated request entry point that handles these parameters. Done means array-of-string API requests follow the specification without a manual per-request serializer; check related issue 1839 for context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100