fix(cli): support additional properties on object declarations (#4963)

fern-api · Oct 21, 2024 · 42b9259 · 42b9259
1 parent 7a5f1c5
commit 42b9259
Show file tree

Hide file tree

Showing 355 changed files with 1,841 additions and 756 deletions.
diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,11 @@
+- changelogEntry:
+    - summary: |
+        Added support for `additionalProperties` on export to JSON Schema.
+      type: feat
+  irVersion: 53
+  version: 0.45.0-rc10
+
+
 - changelogEntry: 
     - summary: | 
         Improved JSON Schema generation for object extensions and const values:

diff --git a/...definition/ir-to-jsonschema/src/__test__/__snapshots__/alias-extends/type_:AliasType.json b/...definition/ir-to-jsonschema/src/__test__/__snapshots__/alias-extends/type_:AliasType.json
@@ -10,7 +10,8 @@
       },
       "required": [
         "parent"
-      ]
+      ],
+      "additionalProperties": false
     }
   }
 }
diff --git a/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias-extends/type_:Child.json b/...ern-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias-extends/type_:Child.json
@@ -13,6 +13,7 @@
   "required": [
     "child"
   ],
+  "additionalProperties": false,
   "definitions": {
     "Parent": {
       "type": "object",
@@ -23,7 +24,8 @@
       },
       "required": [
         "parent"
-      ]
+      ],
+      "additionalProperties": false
     }
   }
 }
diff --git a/...rn-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias-extends/type_:Parent.json b/...rn-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias-extends/type_:Parent.json
@@ -8,5 +8,6 @@
   "required": [
     "parent"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
diff --git a/...s/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias/type_:Object.json b/...s/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias/type_:Object.json
@@ -17,7 +17,8 @@
       "required": [
         "id",
         "name"
-      ]
+      ],
+      "additionalProperties": false
     }
   }
 }
diff --git a/...ges/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias/type_:Type.json b/...ges/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/alias/type_:Type.json
@@ -12,6 +12,7 @@
     "id",
     "name"
   ],
+  "additionalProperties": false,
   "definitions": {
     "TypeId": {
       "type": "string"

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
@@ -15,5 +15,6 @@
     "access_token",
     "expires_in"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
diff --git a/.../fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/any-auth/type_user:User.json b/.../fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/any-auth/type_user:User.json
@@ -12,5 +12,6 @@
     "id",
     "name"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
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
@@ -5,6 +5,7 @@
       "$ref": "#/definitions/folder-b.common.Foo"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "folder-c.common.FolderCFoo": {
       "type": "object",
@@ -16,15 +17,17 @@
       },
       "required": [
         "bar_property"
-      ]
+      ],
+      "additionalProperties": false
     },
     "folder-b.common.Foo": {
       "type": "object",
       "properties": {
         "foo": {
           "$ref": "#/definitions/folder-c.common.FolderCFoo"
         }
-      }
+      },
+      "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
@@ -5,6 +5,7 @@
       "$ref": "#/definitions/folder-c.common.FolderCFoo"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "folder-c.common.FolderCFoo": {
       "type": "object",
@@ -16,7 +17,8 @@
       },
       "required": [
         "bar_property"
-      ]
+      ],
+      "additionalProperties": false
     }
   }
 }
diff --git a/...r-to-jsonschema/src/__test__/__snapshots__/audiences/type_folder-c/common:FolderCFoo.json b/...r-to-jsonschema/src/__test__/__snapshots__/audiences/type_folder-c/common:FolderCFoo.json
@@ -9,5 +9,6 @@
   "required": [
     "bar_property"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
diff --git a/...ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_folder-d/service:Response.json b/...ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_folder-d/service:Response.json
@@ -8,5 +8,6 @@
   "required": [
     "foo"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
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
@@ -11,5 +11,6 @@
   "required": [
     "private_property"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
diff --git a/...inition/ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_foo:ImportingType.json b/...inition/ir-to-jsonschema/src/__test__/__snapshots__/audiences/type_foo:ImportingType.json
@@ -8,6 +8,7 @@
   "required": [
     "imported"
   ],
+  "additionalProperties": false,
   "definitions": {
     "commons.Imported": {
       "type": "string"

diff --git a/...napshots__/basic-auth-environment-variables/type_errors:UnauthorizedRequestErrorBody.json b/...napshots__/basic-auth-environment-variables/type_errors:UnauthorizedRequestErrorBody.json
@@ -8,5 +8,6 @@
   "required": [
     "message"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
diff --git a/...chema/src/__test__/__snapshots__/basic-auth/type_errors:UnauthorizedRequestErrorBody.json b/...chema/src/__test__/__snapshots__/basic-auth/type_errors:UnauthorizedRequestErrorBody.json
@@ -8,5 +8,6 @@
   "required": [
     "message"
   ],
+  "additionalProperties": false,
   "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
@@ -5,6 +5,7 @@
       "$ref": "#/definitions/a.A"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "RootType": {
       "type": "object",
@@ -15,15 +16,17 @@
       },
       "required": [
         "s"
-      ]
+      ],
+      "additionalProperties": false
     },
     "a.A": {
       "type": "object",
       "allOf": [
         {
           "$ref": "#/definitions/RootType"
         }
-      ]
+      ],
+      "additionalProperties": false
     }
   }
 }
diff --git a/...to-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_:RootType.json b/...to-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_:RootType.json
@@ -8,5 +8,6 @@
   "required": [
     "s"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
diff --git a/...on/ir-to-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_a:A.json b/...on/ir-to-jsonschema/src/__test__/__snapshots__/circular-references-advanced/type_a:A.json
@@ -5,6 +5,7 @@
       "$ref": "#/definitions/RootType"
     }
   ],
+  "additionalProperties": false,
   "definitions": {
     "RootType": {
       "type": "object",
@@ -15,7 +16,8 @@
       },
       "required": [
         "s"
-      ]
+      ],
+      "additionalProperties": false
     }
   }
 }
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
@@ -12,6 +12,7 @@
     "name",
     "value"
   ],
+  "additionalProperties": false,
   "definitions": {
     "ast.FieldName": {
       "type": "string"

diff --git a/...nschema/src/__test__/__snapshots__/circular-references-advanced/type_ast:ObjectValue.json b/...nschema/src/__test__/__snapshots__/circular-references-advanced/type_ast:ObjectValue.json
@@ -1,4 +1,5 @@
 {
   "type": "object",
+  "additionalProperties": false,
   "definitions": {}
 }
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
@@ -5,6 +5,7 @@
       "$ref": "#/definitions/a.A"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "RootType": {
       "type": "object",
@@ -15,15 +16,17 @@
       },
       "required": [
         "s"
-      ]
+      ],
+      "additionalProperties": false
     },
     "a.A": {
       "type": "object",
       "allOf": [
         {
           "$ref": "#/definitions/RootType"
         }
-      ]
+      ],
+      "additionalProperties": false
     }
   }
 }
diff --git a/...ition/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_:RootType.json b/...ition/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_:RootType.json
@@ -8,5 +8,6 @@
   "required": [
     "s"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
diff --git a/...-definition/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_a:A.json b/...-definition/ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_a:A.json
@@ -5,6 +5,7 @@
       "$ref": "#/definitions/RootType"
     }
   ],
+  "additionalProperties": false,
   "definitions": {
     "RootType": {
       "type": "object",
@@ -15,7 +16,8 @@
       },
       "required": [
         "s"
-      ]
+      ],
+      "additionalProperties": false
     }
   }
 }
diff --git a/...ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:ObjectValue.json b/...ir-to-jsonschema/src/__test__/__snapshots__/circular-references/type_ast:ObjectValue.json
@@ -1,4 +1,5 @@
 {
   "type": "object",
+  "additionalProperties": false,
   "definitions": {}
 }
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
@@ -5,6 +5,7 @@
       "$ref": "#/definitions/folder-b.common.Foo"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "folder-c.common.Foo": {
       "type": "object",
@@ -16,15 +17,17 @@
       },
       "required": [
         "bar_property"
-      ]
+      ],
+      "additionalProperties": false
     },
     "folder-b.common.Foo": {
       "type": "object",
       "properties": {
         "foo": {
           "$ref": "#/definitions/folder-c.common.Foo"
         }
-      }
+      },
+      "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
@@ -5,6 +5,7 @@
       "$ref": "#/definitions/folder-c.common.Foo"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "folder-c.common.Foo": {
       "type": "object",
@@ -16,7 +17,8 @@
       },
       "required": [
         "bar_property"
-      ]
+      ],
+      "additionalProperties": false
     }
   }
 }
diff --git a/...nschema/src/__test__/__snapshots__/cross-package-type-names/type_folder-c/common:Foo.json b/...nschema/src/__test__/__snapshots__/cross-package-type-names/type_folder-c/common:Foo.json
@@ -9,5 +9,6 @@
   "required": [
     "bar_property"
   ],
+  "additionalProperties": false,
   "definitions": {}
 }
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
@@ -5,6 +5,7 @@
       "$ref": "#/definitions/folder-b.common.Foo"
     }
   },
+  "additionalProperties": false,
   "definitions": {
     "folder-c.common.Foo": {
       "type": "object",
@@ -16,15 +17,17 @@
       },
       "required": [
         "bar_property"
-      ]
+      ],
+      "additionalProperties": false
     },
     "folder-b.common.Foo": {
       "type": "object",
       "properties": {
         "foo": {
           "$ref": "#/definitions/folder-c.common.Foo"
         }
-      }
+      },
+      "additionalProperties": false
     }
   }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,7 +17,8 @@ @@
           "required": [
             "id",
             "name"
-          ]
+          ],
+          "additionalProperties": false
         }
       }
     }