oxidecomputer / oxidecomputer/progenitor

Support OpenAPI 3.1.0

Open
#762 18 comments 46 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1k
Forks
136
Avg merge
8h 36m
Merged PRs (30d)
14

Description

OpenAPI version 3.1.0 came with some breaking changes, notably, the introduction of a null type and removal of the nullable attribute.

We can work around this by patching these parts of a 3.1.0 spec to a 3.0.* spec, but i'm concerned about the implication that has on the validity of the document.

Is an extension of progenitor to support OpenAPI 3.1.0 being considered or worked on?

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

No file or test is named. Start by reviewing how progenitor currently handles OpenAPI 3.0 schemas, then compare that path with the 3.1.0 changes to null and nullable. Done means a decided, validated approach for 3.1.0 support rather than a compatibility patch.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, rust
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.