这是indexloc提供的服务，不要输入任何密码
Skip to content

fix: update schema pruning logic to correctly handle required properties #2556

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

Merged
merged 3 commits into from
Aug 29, 2025
Merged

fix: update schema pruning logic to correctly handle required properties #2556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26252cb
fix: update schema pruning logic to correctly handle required properties
carson2222 Aug 29, 2025
74c16f2
chore: update changeset
carson2222 Aug 29, 2025
e93eeec
Update seven-rings-drop.md
mrlubos Aug 29, 2025
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
5 changes: 5 additions & 0 deletions .changeset/seven-rings-drop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@hey-api/openapi-ts': patch
---

fix(parser): prune `required` array after removing properties
2 changes: 1 addition & 1 deletion ...pi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@hey-api/schemas/default/schemas.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,7 @@ export const failure_FailureSchema = {
export const ModelWithPropertiesWritableSchema = {
description: 'This is a model with one nested property',
type: 'object',
required: ['required', 'requiredAndReadOnly'],
required: ['required'],
properties: {
required: {
type: 'string'
Expand Down
6 changes: 3 additions & 3 deletions ...pi-ts-tests/main/test/__snapshots__/3.0.x/plugins/@hey-api/schemas/default/schemas.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1571,7 +1571,7 @@ export const ModelWithNestedCompositionEnumsSchema = {

export const ModelWithReadOnlyAndWriteOnlySchema = {
type: 'object',
required: ['foo', 'bar', 'baz'],
required: ['foo', 'bar'],
properties: {
foo: {
type: 'string'
Expand Down Expand Up @@ -2002,7 +2002,7 @@ export const Generic_Schema_Duplicate_Issue_1_System_String_Schema = {
export const ModelWithPropertiesWritableSchema = {
description: 'This is a model with one nested property',
type: 'object',
required: ['required', 'requiredAndReadOnly', 'requiredAndNullable'],
required: ['required', 'requiredAndNullable'],
properties: {
required: {
type: 'string'
Expand Down Expand Up @@ -2087,7 +2087,7 @@ export const FileWritableSchema = {

export const ModelWithReadOnlyAndWriteOnlyWritableSchema = {
type: 'object',
required: ['foo', 'bar', 'baz'],
required: ['foo', 'baz'],
properties: {
foo: {
type: 'string'
Expand Down
6 changes: 3 additions & 3 deletions ...pi-ts-tests/main/test/__snapshots__/3.1.x/plugins/@hey-api/schemas/default/schemas.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1564,7 +1564,7 @@ export const ModelWithNestedCompositionEnumsSchema = {

export const ModelWithReadOnlyAndWriteOnlySchema = {
type: 'object',
required: ['foo', 'bar', 'baz'],
required: ['foo', 'bar'],
properties: {
foo: {
type: 'string'
Expand Down Expand Up @@ -1996,7 +1996,7 @@ export const Generic_Schema_Duplicate_Issue_1_System_String_Schema = {
export const ModelWithPropertiesWritableSchema = {
description: 'This is a model with one nested property',
type: 'object',
required: ['required', 'requiredAndReadOnly', 'requiredAndNullable'],
required: ['required', 'requiredAndNullable'],
properties: {
required: {
type: 'string'
Expand Down Expand Up @@ -2080,7 +2080,7 @@ export const FileWritableSchema = {

export const ModelWithReadOnlyAndWriteOnlyWritableSchema = {
type: 'object',
required: ['foo', 'bar', 'baz'],
required: ['foo', 'baz'],
properties: {
foo: {
type: 'string'
Expand Down
42 changes: 35 additions & 7 deletions packages/openapi-ts/src/openApi/shared/transforms/readWrite.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,13 +139,9 @@ const pruneSchemaByScope = (
scope: 'readOnly' | 'writeOnly',
): boolean => {
if (schema && typeof schema === 'object') {
// Remove $ref if the referenced schema is exclusively the excluded scope
if (
'$ref' in schema &&
typeof (schema as Record<string, unknown>)['$ref'] === 'string'
) {
const ref = (schema as Record<string, unknown>)['$ref'] as string;
const nodeInfo = graph.nodes.get(ref);
// Handle $ref schemas
if ('$ref' in schema && typeof schema.$ref === 'string') {
const nodeInfo = graph.nodes.get(schema.$ref);
if (nodeInfo?.scopes) {
// Only remove $ref if the referenced schema is *exclusively* the excluded scope.
// This ensures 'normal' or multi-scope schemas are always kept.
Expand Down Expand Up @@ -197,6 +193,9 @@ const pruneSchemaByScope = (
!(value instanceof Array)
) {
const objMap = value as Record<string, unknown>;
// Track removed properties for object schemas to update required array
const removedProperties = new Set<string>();

for (const key of Object.keys(objMap)) {
const prop = objMap[key];
if (
Expand All @@ -205,13 +204,42 @@ const pruneSchemaByScope = (
(prop as Record<string, unknown>)[scope] === true
) {
delete objMap[key];
// Track removed properties for object schemas
if (keyword === 'properties') {
removedProperties.add(key);
}
} else {
const shouldRemove = pruneSchemaByScope(graph, prop, scope);
if (shouldRemove) {
delete objMap[key];
// Track removed properties for object schemas
if (keyword === 'properties') {
removedProperties.add(key);
}
}
}
}

// Update required array if properties were removed
if (
removedProperties.size > 0 &&
keyword === 'properties' &&
'required' in schema &&
Array.isArray((schema as Record<string, unknown>).required)
) {
const required = (schema as Record<string, unknown>)
.required as string[];
const filteredRequired = required.filter(
(prop) => !removedProperties.has(prop),
);

if (filteredRequired.length === 0) {
delete (schema as Record<string, unknown>).required;
} else {
(schema as Record<string, unknown>).required = filteredRequired;
}
}

if (!Object.keys(objMap).length) {
delete (schema as Record<string, unknown>)[keyword];
}
Expand Down
Loading