Skip to content

Commit f71c4f7

Browse files
zerone0xclaude
andcommitted
fix(provider): add required field to object schemas for strict validators
Backends like SGLang with strict JSON Schema validation fail when object schemas don't have a 'required' field. This fix ensures all object-type schemas have 'required' set (as an empty array if no fields are required). Fixes anomalyco#8184 Co-Authored-By: Claude <[email protected]>
1 parent 067338b commit f71c4f7

2 files changed

Lines changed: 129 additions & 0 deletions

File tree

‎packages/opencode/src/provider/transform.ts‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -621,6 +621,35 @@ export namespace ProviderTransform {
621621
}
622622
*/
623623

624+
// Ensure 'required' is always an array for object types to satisfy strict backends (e.g., SGLang)
625+
const ensureRequiredField = (obj: any): any => {
626+
if (obj === null || typeof obj !== "object") {
627+
return obj
628+
}
629+
630+
if (Array.isArray(obj)) {
631+
return obj.map(ensureRequiredField)
632+
}
633+
634+
const result: any = {}
635+
for (const [key, value] of Object.entries(obj)) {
636+
if (typeof value === "object" && value !== null) {
637+
result[key] = ensureRequiredField(value)
638+
} else {
639+
result[key] = value
640+
}
641+
}
642+
643+
// Add required: [] for object types that don't have it
644+
if (result.type === "object" && !result.required) {
645+
result.required = []
646+
}
647+
648+
return result
649+
}
650+
651+
schema = ensureRequiredField(schema)
652+
624653
// Convert integer enums to string enums for Google/Gemini
625654
if (model.providerID === "google" || model.api.id.includes("gemini")) {
626655
const sanitizeGemini = (obj: any): any => {

‎packages/opencode/test/provider/transform.test.ts‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,106 @@ describe("ProviderTransform.maxOutputTokens", () => {
167167
})
168168
})
169169

170+
describe("ProviderTransform.schema - required field for strict backends", () => {
171+
const genericModel = {
172+
providerID: "openai-compatible",
173+
api: {
174+
id: "custom-model",
175+
},
176+
} as any
177+
178+
test("adds required: [] to empty object schemas", () => {
179+
const schema = {
180+
type: "object",
181+
properties: {},
182+
} as any
183+
184+
const result = ProviderTransform.schema(genericModel, schema) as any
185+
186+
expect(result.required).toEqual([])
187+
})
188+
189+
test("preserves existing required field", () => {
190+
const schema = {
191+
type: "object",
192+
properties: {
193+
name: { type: "string" },
194+
},
195+
required: ["name"],
196+
} as any
197+
198+
const result = ProviderTransform.schema(genericModel, schema) as any
199+
200+
expect(result.required).toEqual(["name"])
201+
})
202+
203+
test("adds required: [] to nested object schemas", () => {
204+
const schema = {
205+
type: "object",
206+
properties: {
207+
nested: {
208+
type: "object",
209+
properties: {},
210+
},
211+
},
212+
} as any
213+
214+
const result = ProviderTransform.schema(genericModel, schema) as any
215+
216+
expect(result.required).toEqual([])
217+
expect(result.properties.nested.required).toEqual([])
218+
})
219+
220+
test("handles deeply nested object schemas", () => {
221+
const schema = {
222+
type: "object",
223+
properties: {
224+
level1: {
225+
type: "object",
226+
properties: {
227+
level2: {
228+
type: "object",
229+
properties: {
230+
value: { type: "string" },
231+
},
232+
},
233+
},
234+
},
235+
},
236+
} as any
237+
238+
const result = ProviderTransform.schema(genericModel, schema) as any
239+
240+
expect(result.required).toEqual([])
241+
expect(result.properties.level1.required).toEqual([])
242+
expect(result.properties.level1.properties.level2.required).toEqual([])
243+
})
244+
245+
test("handles array of objects", () => {
246+
const schema = {
247+
type: "array",
248+
items: {
249+
type: "object",
250+
properties: {},
251+
},
252+
} as any
253+
254+
const result = ProviderTransform.schema(genericModel, schema) as any
255+
256+
expect(result.items.required).toEqual([])
257+
})
258+
259+
test("does not add required to non-object types", () => {
260+
const schema = {
261+
type: "string",
262+
} as any
263+
264+
const result = ProviderTransform.schema(genericModel, schema) as any
265+
266+
expect(result.required).toBeUndefined()
267+
})
268+
})
269+
170270
describe("ProviderTransform.schema - gemini array items", () => {
171271
test("adds missing items for array properties", () => {
172272
const geminiModel = {

0 commit comments

Comments
 (0)