Make required fields required
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 27
- Forks
- 24
- Avg merge
- 12d 6h
- Merged PRs (30d)
- 1
Description
This includes:
- In
WriteAuthorizationModelRequest,schema_versionshould be required - In
ReadAuthorizationModelRequest,idshould be required - In
TupleKeyall are required - All responses
These currently cause a lot of DX problems in the SDKs, as the generated types show that the fields are optional.
E.g. In the typescript SDK, users have to check for nullability on responses even if we know it will never be null, and they mistakenly think that some fields are optional in requests even when they are.
In the Go SDK, we have to make the fields accept pointer instead of values because of this when it is unnecessary
Contributor guide
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
The issue names WriteAuthorizationModelRequest, ReadAuthorizationModelRequest, TupleKey, all responses, and the generated TypeScript and Go SDK types. Start by locating the Protocol Buffer definitions for these messages and inspecting how requiredness appears in generated types; done means the named request and response fields are non-optional without unnecessary pointers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, typescript
- Domain
- api, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100