Skip to content

Support v3.1 typed arrays #1167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support v3.1 typed arrays #1167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/schema-parser/base-schema-parsers/object.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@ export class ObjectSchemaParser extends MonoSchemaParser {
"rawTypeData",
{},
);
// In OpenAPI v3.1 the nullable property was replaced with a "typed
// array", that is an array that can either be of type T or null.
if (Array.isArray(property.type) && property.type.length == 2) {
if (property.type[0] == "null") {
property.type = property.type[1];
property.nullable = true;
} else if (property.type[1] == "null") {
Comment on lines +42 to +45
Copy link
Preview

Copilot AI Apr 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using strict equality (===) instead of loose equality (==) for comparing property.type elements to "null" to avoid potential type coercion issues.

Suggested change
if (property.type[0] == "null") {
property.type = property.type[1];
property.nullable = true;
} else if (property.type[1] == "null") {
if (property.type[0] === "null") {
property.type = property.type[1];
property.nullable = true;
} else if (property.type[1] === "null") {

Copilot uses AI. Check for mistakes.

property.type = property.type[0];
property.nullable = true;
}
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to add also this after your condition, to type array with single type work.

if (Array.isArray(property.type) && property.type.length == 1) { property.type = property.type[0]; }

Example yaml:

SomeType:
type:
- string
enum:
- one
- two

OtherComponent:
type: object
properties:
type:
$ref: '#/components/schemas/SomeType'

const nullable = !!(rawTypeData.nullable || property.nullable);
const fieldName = this.typeNameFormatter.isValidName(name)
? name
Expand Down