fix(openapi-typescript): handle nullable schemas

[gduliscouet-ubitransport]

Changes

Allow all types except UNKNOWN to be nullable.
Fixes #1821 and #1940 .

How to Review

I re-applied #1959 (it didn't move for a while)

I added tests for the new syntax (oneOf: [SchemaFoo, { type: "null" }]).

I also wanted to add test for both syntax, mainly for our use case.

Checklist

• Unit tests updated
• docs/ updated (if necessary)
• pnpm run update:examples run (only applicable for openapi-typescript)
• add a minor changeset patch

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4339d72

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[gduliscouet-ubitransport]

Hello @drwpow ,
Could I get your input for this schema ?
I added it to the tests, but it doesn't pass yet.
From what I see in the code, it seems to me that if we have a $ref in an object schema, all other keys are ignored. Is it me that misunderstood how $ref work ? Or is it a bug we should fix ?

Once we resolve that I'll finalize the PR

[drwpow]

it seems to me that if we have a $ref in an object schema, all other keys are ignored. Is it me that misunderstood how $ref work ? Or is it a bug we should fix ?

That’s my understanding. If you look at the OpenAPI 3.1 specification, you’ll often see typings like this: SchemaObject | ReferenceObject. The fact that a reference object IS NOT a SchemaObject, or any other type for that matter, means they aren’t to be mixed-and-matched. If you want to combine multiple objects, you MUST use allOf/oneOf/anyOf to compose an object (but within those arrays, you are allowed to have some object be ReferenceObject and some SchemaObjects, but there’s no such thing as combining the two together.

[drwpow]

As discussed, this is simply an invalid type. We shouldn’t be testing this. To combine obj1Ref and these properties, it must be within allOf or anyOf. We can also simply remove this test if it’s the only one failing (haven’t looked a the failure logs yet)