Comments (5)
You're right, it's not valid swagger by the spec. This was an extension to swagger that we used at Shutterstock because otherwise there was no way to define a property that could be null. The libraries we used back then supported it (curiously, I thought Swagger UI was one of them).
There is also no null type. Swagger 3.0 added the nullable: true
attribute. I don't have the time right now to change this lib to use it, but I'd welcome a pull request that switched to that behavior.
from joi-to-swagger.
You mean a PR to add nullable: true
instead of type: ["string", "null"]
, or to remove null
from type: ["string", "null"]
.
To which swagger verion joi-to-swagger
targets? To 2.0 or to 3.0? So we won't start generating invalid schema again as swagger 2.0 does not support nullable: true
.
from joi-to-swagger.
The former.
IMO Swagger 2 is a fundamentally flawed spec, I see no reason to continue to support it now that 3 is out. This change would probably merit a major version bump, however.
from joi-to-swagger.
Fixed in 2.0 release
from joi-to-swagger.
See ajv-validator/ajv#1471. Enum doesn't play well with nullable
.
This schema
const schema = joi
.object({
field1: joi.valid("a", "b", null)
})
.unknown();
below generates:
{
"type": "object",
"properties": {
"field1": {
"enum": ["a", "b"],
"nullable": true
}
}
}
The correct schema should be
{
"type": "object",
"properties": {
"field1": {
"enum": ["a", "b", null]
"nullable": true
}
}
}
nullable
flag andnull
are required
Codesandbox link https://codesandbox.io/s/json-schema-enum-nullable-zsrlbj?file=/src/index.test.js
from joi-to-swagger.
Related Issues (20)
- Usage of joi.ref() in min()/max() generated invalid schemas
- [Feature request] Support Joi.link() HOT 1
- Update joi dependency to use @hapi/joi HOT 5
- More examples HOT 6
- regeneratorRuntime - error HOT 3
- Meta options (className, swagger and swaggerOverride) HOT 1
- [FEATURE] Support for schema.tailor and schema.alter HOT 2
- joi is leaving the @hapi organization and moving back to 'joi' HOT 2
- False default values for boolean not passing HOT 2
- joi.object().keys() vs joi.object({}) HOT 1
- add meta option to override alternatives feature (for AWS APIG) HOT 1
- Custom data x-custom-definition / x-custom-property-data HOT 1
- Support for .allow('a','b') by setting enums for this
- Description feature HOT 3
- How to create joi schema of allOf: swagger syntax HOT 1
- thank you for this
- Generate parameters array HOT 1
- Set responses using joi HOT 1
- Key-Value Map via Joi.object().pattern() does not work
- Generation of components using .pattern() HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from joi-to-swagger.