Structured Outputs: Response object - text -> format -> JSON Schema -> description can be null, but documentation doesn't say "string or null"

Documentation
,
1

Hey,

I think I have found a bug in either the documentation or the api itself.

When I use structured outputs and send a JSON schema with an empty string as description to the Responses API, the returned object has “null” as its description. The api spec, however, says it can only be “string”, and not “string or null”.

You can find the api spec here: https://platform.openai.com/docs/api-reference/responses/object

It’s in the responses object under text → format → JSON schema → description.

Is this intentional? Which is wrong? The api behavior or the documentation?

Thanks

1 Like