oxidecomputer / oxidecomputer/typify

Add support for external $ref

Open
#201 21 comments 15 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

Hey,

Thanks for this crate.

I was using it to generate some code based on the following NVD schema: https://csrc.nist.gov/schema/nvd/api/2.0/cve_api_json_2.0.schema

It would be useful to add the support for fetching external $ref coming from the file system or via HTTP:

E.g.:

"cvss-v30": {
...
	"properties": {
		"cvssData": {"$ref": "//csrc.nist.gov/schema/nvd/api/2.0/external/cvss-v3.0.json" },
	},
...
},

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 this crate currently resolves JSON Schema $ref values, using the NVD schema example as the first case to follow. Review the existing schema-loading entry point and determine how filesystem and HTTP references should be handled. Done means external references like the shown cvss-v3.0.json resolve successfully during Rust code generation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.