fix(openapi): support nullish consts (#751)

fastify · Sep 25, 2023 · ff02608 · ff02608
1 parent e40e96d
commit ff02608
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 4 deletions.
diff --git a/lib/spec/openapi/utils.js b/lib/spec/openapi/utils.js
@@ -117,7 +117,7 @@ function transformDefsToComponents (jsonSchema) {
     if (jsonSchema.patternProperties) {
       jsonSchema.additionalProperties = Object.values(jsonSchema.patternProperties)[0]
       delete jsonSchema.patternProperties
-    } else if (jsonSchema.const) {
+    } else if (jsonSchema.const !== undefined) {
       // OAS 3.1 supports `const` but it is not supported by `swagger-ui`
       // https://swagger.io/docs/specification/data-models/keywords/
       jsonSchema.enum = [jsonSchema.const]

diff --git a/lib/spec/swagger/utils.js b/lib/spec/swagger/utils.js
@@ -158,7 +158,7 @@ function replaceUnsupported (jsonSchema) {
     if (jsonSchema.patternProperties) {
       jsonSchema.additionalProperties = { type: 'string' }
       delete jsonSchema.patternProperties
-    } else if (jsonSchema.const) {
+    } else if (jsonSchema.const !== undefined) {
       // Handle const, that is not part of OpenAPI definitions
       jsonSchema.enum = [jsonSchema.const]
       delete jsonSchema.const

diff --git a/test/spec/openapi/schema.js b/test/spec/openapi/schema.js
@@ -655,7 +655,11 @@ test('support "const" keyword', async t => {
           obj: {
             type: 'object',
             properties: {
-              constantProp: { const: 'my-const' }
+              constantProp: { const: 'my-const' },
+              constantPropZero: { const: 0 },
+              constantPropNull: { const: null },
+              constantPropFalse: { const: false },
+              constantPropEmptyString: { const: '' }
             }
           }
         }
@@ -685,6 +689,18 @@ test('support "const" keyword', async t => {
               properties: {
                 constantProp: {
                   enum: ['my-const']
+                },
+                constantPropZero: {
+                  enum: [0]
+                },
+                constantPropNull: {
+                  enum: [null]
+                },
+                constantPropFalse: {
+                  enum: [false]
+                },
+                constantPropEmptyString: {
+                  enum: ['']
                 }
               }
             }

diff --git a/test/spec/swagger/schema.js b/test/spec/swagger/schema.js
@@ -450,7 +450,11 @@ test('support "const" keyword', async t => {
           obj: {
             type: 'object',
             properties: {
-              constantProp: { const: 'my-const' }
+              constantProp: { const: 'my-const' },
+              constantPropNull: { const: null },
+              constantPropZero: { const: 0 },
+              constantPropFalse: { const: false },
+              constantPropEmptyString: { const: '' }
             }
           }
         }
@@ -475,6 +479,18 @@ test('support "const" keyword', async t => {
         properties: {
           constantProp: {
             enum: ['my-const']
+          },
+          constantPropZero: {
+            enum: [0]
+          },
+          constantPropNull: {
+            enum: [null]
+          },
+          constantPropFalse: {
+            enum: [false]
+          },
+          constantPropEmptyString: {
+            enum: ['']
           }
         }
       }