oxidecomputer / oxidecomputer/oxide.go

Implement API type validation on the client side

Open
#137 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement Go SDK
Dominant language
Go
Stars
26
Forks
6
Avg merge
5h 33m
Merged PRs (30d)
9

Description

Would like to have validation on the client side to verify whether the value of a type is acceptable or not.

For example: If the only acceptable values for BlockSize during a disk create are 512, 2048 or 4096, we'd like to validate before an API call is made

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating how request types such as BlockSize are represented and how disk-create requests are assembled in the Go SDK. Determine the scope of client-side validation and how acceptable values should be declared; done means invalid values are rejected before an API call while valid values continue to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.