Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

API - How to have valid nullable fields in swagger ?

See original GitHub issue

Hi,

Thanks for express-openapi. I really appreciate to use it 😃 But I have a problem, I need to expose fields which the type strings that could be nullable. This following code works when i run the server based on express-api :

responses: { 200: { schema: { title: 'MyObject', properties: { myfield: { type: ['string', 'null'],

But it’s not valid against Swagger (editor.swagger.io) 😦

Semantic error at definitions.MyObject.myfield “type” should be a string

Do you have a valid way to use nullable fields with express-openapi ?

Thanks by advance !

And Thanks for this top library.

Regards,

Issue Analytics

State:
Created 6 years ago
Comments:10 (7 by maintainers)

Top GitHub Comments

1reaction

lzearcommented, Jun 28, 2018

Is there a way to correctly validate requests/responses having nullable fields with OpenAPI v3?

The OAI specifies that nullable fields should use the keyword “nullable”, which doesn’t seem to be implemented in any JS library for validation. There are several discussions related to this topic: https://github.com/epoberezkin/ajv/issues/486 https://github.com/OAI/OpenAPI-Specification/issues/1389 https://github.com/OAI/OpenAPI-Specification/issues/229

I started working on trying to convert OAI’s syntax to JSON-schema’s (see https://github.com/kogosoftwarellc/open-api/pull/127). Does it make sense to work in that direction?

1reaction

jsdevelcommented, Jun 23, 2018

@fdescamps I recently adding schema extension support. Should address this.