bug fix for undiscriminated union and optional implying nullable

fern-api · Oct 21, 2024 · d8b4703 · d8b4703
1 parent bfc7aa0
commit d8b4703
Show file tree

Hide file tree

Showing 224 changed files with 7,135 additions and 1,080 deletions.
diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,12 @@
+- changelogEntry:
+- changelogEntry:
+    - summary: |
+        Undiscriminated unions are now represented using `anyOf` in the generated JSON Schema
+        Nullable properties are now correctly propagated to the JSON Schema
+      type: fix
+  irVersion: 53
+  version: 0.45.0-rc12
+
 - changelogEntry:
     - summary: |
         Improved JSON Schema generation for object inheritance:

diff --git a/...inition/ir-to-jsonschema/src/__test__/__snapshots__/any-auth/type_auth:TokenResponse.json b/...inition/ir-to-jsonschema/src/__test__/__snapshots__/any-auth/type_auth:TokenResponse.json
@@ -8,7 +8,14 @@
       "type": "integer"
     },
     "refresh_token": {
-      "type": "string"
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "required": [

diff --git a/...ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_folder-a/service:Response.json b/...ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_folder-a/service:Response.json
@@ -2,7 +2,14 @@
   "type": "object",
   "properties": {
     "foo": {
-      "$ref": "#/definitions/folder-b.common.Foo"
+      "oneOf": [
+        {
+          "$ref": "#/definitions/folder-b.common.Foo"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "additionalProperties": false,
@@ -24,7 +31,14 @@
       "type": "object",
       "properties": {
         "foo": {
-          "$ref": "#/definitions/folder-c.common.FolderCFoo"
+          "oneOf": [
+            {
+              "$ref": "#/definitions/folder-c.common.FolderCFoo"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "additionalProperties": false

diff --git a/...ition/ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_folder-b/common:Foo.json b/...ition/ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_folder-b/common:Foo.json
@@ -2,7 +2,14 @@
   "type": "object",
   "properties": {
     "foo": {
-      "$ref": "#/definitions/folder-c.common.FolderCFoo"
+      "oneOf": [
+        {
+          "$ref": "#/definitions/folder-c.common.FolderCFoo"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "additionalProperties": false,

diff --git a/...finition/ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_foo:FilteredType.json b/...finition/ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_foo:FilteredType.json
@@ -2,7 +2,14 @@
   "type": "object",
   "properties": {
     "public_property": {
-      "type": "string"
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "private_property": {
       "type": "integer"

diff --git a/...nition/ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_foo:OptionalString.json b/...nition/ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_foo:OptionalString.json
@@ -1,4 +1,11 @@
 {
-  "type": "string",
+  "oneOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
   "definitions": {}
 }
diff --git a/...-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_:ImportingA.json b/...-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_:ImportingA.json
@@ -2,7 +2,14 @@
   "type": "object",
   "properties": {
     "a": {
-      "$ref": "#/definitions/a.A"
+      "oneOf": [
+        {
+          "$ref": "#/definitions/a.A"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "additionalProperties": false,

diff --git a/...hema/src/__test__/__snapshots__/circular-references-advanced/type_ast:ContainerValue.json b/...hema/src/__test__/__snapshots__/circular-references-advanced/type_ast:ContainerValue.json
@@ -35,7 +35,14 @@
           "const": "optional"
         },
         "value": {
-          "$ref": "#/definitions/ast.FieldValue"
+          "oneOf": [
+            {
+              "$ref": "#/definitions/ast.FieldValue"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "required": [
@@ -88,7 +95,14 @@
               "const": "optional"
             },
             "value": {
-              "$ref": "#/definitions/ast.FieldValue"
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/ast.FieldValue"
+                },
+                {
+                  "type": "null"
+                }
+              ]
             }
           },
           "required": [

diff --git a/...onschema/src/__test__/__snapshots__/circular-references-advanced/type_ast:FieldValue.json b/...onschema/src/__test__/__snapshots__/circular-references-advanced/type_ast:FieldValue.json
@@ -150,7 +150,14 @@
               "const": "optional"
             },
             "value": {
-              "$ref": "#/definitions/ast.FieldValue"
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/ast.FieldValue"
+                },
+                {
+                  "type": "null"
+                }
+              ]
             }
           },
           "required": [

diff --git a/...ma/src/__test__/__snapshots__/circular-references-advanced/type_ast:ObjectFieldValue.json b/...ma/src/__test__/__snapshots__/circular-references-advanced/type_ast:ObjectFieldValue.json
@@ -61,7 +61,14 @@
               "const": "optional"
             },
             "value": {
-              "$ref": "#/definitions/ast.FieldValue"
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/ast.FieldValue"
+                },
+                {
+                  "type": "null"
+                }
+              ]
             }
           },
           "required": [

diff --git a/...ion/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_:ImportingA.json b/...ion/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_:ImportingA.json
@@ -2,7 +2,14 @@
   "type": "object",
   "properties": {
     "a": {
-      "$ref": "#/definitions/a.A"
+      "oneOf": [
+        {
+          "$ref": "#/definitions/a.A"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "additionalProperties": false,

diff --git a/...to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:ContainerValue.json b/...to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:ContainerValue.json
@@ -35,7 +35,14 @@
           "const": "optional"
         },
         "value": {
-          "$ref": "#/definitions/ast.FieldValue"
+          "oneOf": [
+            {
+              "$ref": "#/definitions/ast.FieldValue"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "required": [
@@ -88,7 +95,14 @@
               "const": "optional"
             },
             "value": {
-              "$ref": "#/definitions/ast.FieldValue"
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/ast.FieldValue"
+                },
+                {
+                  "type": "null"
+                }
+              ]
             }
           },
           "required": [

diff --git a/.../ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:FieldValue.json b/.../ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:FieldValue.json
@@ -150,7 +150,14 @@
               "const": "optional"
             },
             "value": {
-              "$ref": "#/definitions/ast.FieldValue"
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/ast.FieldValue"
+                },
+                {
+                  "type": "null"
+                }
+              ]
             }
           },
           "required": [

diff --git a/...on/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:JsonLike.json b/...on/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:JsonLike.json
@@ -1,5 +1,5 @@
 {
-  "oneOf": [
+  "anyOf": [
     {
       "type": "array",
       "items": {
@@ -24,7 +24,7 @@
   ],
   "definitions": {
     "ast.JsonLike": {
-      "oneOf": [
+      "anyOf": [
         {
           "type": "array",
           "items": {

diff --git a/...a/src/__test__/__snapshots__/cross-package-type-names/type_folder-a/service:Response.json b/...a/src/__test__/__snapshots__/cross-package-type-names/type_folder-a/service:Response.json
@@ -2,7 +2,14 @@
   "type": "object",
   "properties": {
     "foo": {
-      "$ref": "#/definitions/folder-b.common.Foo"
+      "oneOf": [
+        {
+          "$ref": "#/definitions/folder-b.common.Foo"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "additionalProperties": false,
@@ -24,7 +31,14 @@
       "type": "object",
       "properties": {
         "foo": {
-          "$ref": "#/definitions/folder-c.common.Foo"
+          "oneOf": [
+            {
+              "$ref": "#/definitions/folder-c.common.Foo"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "additionalProperties": false

diff --git a/...nschema/src/__test__/__snapshots__/cross-package-type-names/type_folder-b/common:Foo.json b/...nschema/src/__test__/__snapshots__/cross-package-type-names/type_folder-b/common:Foo.json
@@ -2,7 +2,14 @@
   "type": "object",
   "properties": {
     "foo": {
-      "$ref": "#/definitions/folder-c.common.Foo"
+      "oneOf": [
+        {
+          "$ref": "#/definitions/folder-c.common.Foo"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "additionalProperties": false,

diff --git a/...a/src/__test__/__snapshots__/cross-package-type-names/type_folder-d/service:Response.json b/...a/src/__test__/__snapshots__/cross-package-type-names/type_folder-d/service:Response.json
@@ -2,7 +2,14 @@
   "type": "object",
   "properties": {
     "foo": {
-      "$ref": "#/definitions/folder-b.common.Foo"
+      "oneOf": [
+        {
+          "$ref": "#/definitions/folder-b.common.Foo"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "additionalProperties": false,
@@ -24,7 +31,14 @@
       "type": "object",
       "properties": {
         "foo": {
-          "$ref": "#/definitions/folder-c.common.Foo"
+          "oneOf": [
+            {
+              "$ref": "#/definitions/folder-c.common.Foo"
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "additionalProperties": false

diff --git a/...onschema/src/__test__/__snapshots__/cross-package-type-names/type_foo:OptionalString.json b/...onschema/src/__test__/__snapshots__/cross-package-type-names/type_foo:OptionalString.json
@@ -1,4 +1,11 @@
 {
-  "type": "string",
+  "oneOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
   "definitions": {}
 }
diff --git a/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/enum/type_:ColorOrOperand.json b/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/enum/type_:ColorOrOperand.json
@@ -1,5 +1,5 @@
 {
-  "oneOf": [
+  "anyOf": [
     {
       "$ref": "#/definitions/Color"
     },

diff --git a/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/examples/type_:Identifier.json b/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/examples/type_:Identifier.json
@@ -34,7 +34,7 @@
       ]
     },
     "Type": {
-      "oneOf": [
+      "anyOf": [
         {
           "$ref": "#/definitions/BasicType"
         },

diff --git a/.../cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/examples/type_:Type.json b/.../cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/examples/type_:Type.json
@@ -1,5 +1,5 @@
 {
-  "oneOf": [
+  "anyOf": [
     {
       "$ref": "#/definitions/BasicType"
     },