oxidecomputer / oxidecomputer/typify

readOnly support

Open
#348 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
898
Forks
114
Avg merge
4h 18m
Merged PRs (30d)
14

Description

Typically use of readOnly results in two schemas, one for put/post/patch without the readOnly fields, and the other for get with all of the fields.

IMO it would be sufficient for typify to create two schemas with a predictable type name suffix for the smaller schema.

However it would be nice if somehow the two schema types can indicate that it has a pair, so macros built on top of typify types can programmatically know about the soft-link between them.

Contributor guide

No contributing guide indexed for this repository

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 tracing how typify handles readOnly fields and generates the two schema types. Done would mean a predictable suffix for the smaller write schema and a way for macros to identify the relationship between the paired types.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.