Move inline to BaseTypeDeclarationSchema in Fern definition, remove r…

…edundant inline property from IR shapes
fern-api · Nov 26, 2024 · 64227b1 · 64227b1
1 parent c0e8130
commit 64227b1
Show file tree

Hide file tree

Showing 108 changed files with 2,699 additions and 1,412 deletions.
diff --git a/fern.schema.json b/fern.schema.json
@@ -497,6 +497,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {
@@ -530,16 +540,6 @@
             }
           ]
         },
-        "inline": {
-          "oneOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "extends": {
           "oneOf": [
             {
@@ -710,6 +710,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {
@@ -743,16 +753,6 @@
             }
           ]
         },
-        "inline": {
-          "oneOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "default": {
           "oneOf": [
             {
@@ -1053,6 +1053,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {
@@ -1086,16 +1096,6 @@
             }
           ]
         },
-        "inline": {
-          "oneOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "discriminant": {
           "oneOf": [
             {
@@ -1219,6 +1219,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {
@@ -1252,16 +1262,6 @@
             }
           ]
         },
-        "inline": {
-          "oneOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "discriminated": {
           "const": false
         },
@@ -1314,6 +1314,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {

diff --git a/fern/apis/fern-definition/definition/commons.yml b/fern/apis/fern-definition/definition/commons.yml
@@ -22,10 +22,6 @@ types:
     properties:
       audiences: optional<list<string>>
 
-  WithInline:
-    properties:
-      inline: optional<boolean>
-
   DeclarationSchema:
     extends:
       - WithDocsSchema

diff --git a/fern/apis/fern-definition/definition/types.yml b/fern/apis/fern-definition/definition/types.yml
@@ -90,6 +90,7 @@ types:
       examples: optional<list<examples.ExampleTypeSchema>>
       encoding: optional<encoding.EncodingSchema>
       source: optional<source.SourceSchema>
+      inline: optional<boolean>
 
   ### Aliases ####
 
@@ -102,9 +103,7 @@ types:
   #### Objects ####
 
   ObjectSchema:
-    extends:
-      - BaseTypeDeclarationSchema
-      - commons.WithInline
+    extends: BaseTypeDeclarationSchema
     properties:
       extends: optional<ObjectExtendsSchema>
       properties: optional<map<string, ObjectPropertySchema>>
@@ -127,9 +126,7 @@ types:
   #### Enums ####
 
   EnumSchema:
-    extends:
-      - BaseTypeDeclarationSchema
-      - commons.WithInline
+    extends: BaseTypeDeclarationSchema
     properties:
       default: optional<string>
       enum: list<EnumValue>
@@ -186,9 +183,7 @@ types:
       value: string
 
   DiscriminatedUnionSchema:
-    extends:
-      - BaseTypeDeclarationSchema
-      - commons.WithInline
+    extends: BaseTypeDeclarationSchema
     properties:
       discriminant: optional<UnionDiscriminant>
       extends: optional<ObjectExtendsSchema>
@@ -210,9 +205,7 @@ types:
   #### Undiscriminated Union ####
 
   UndiscriminatedUnionSchema:
-    extends:
-      - BaseTypeDeclarationSchema
-      - commons.WithInline
+    extends: BaseTypeDeclarationSchema
     properties:
       discriminated: literal<false>
       union: list<SingleUndiscriminatedUnionTypeSchema>

diff --git a/package-yml.schema.json b/package-yml.schema.json
@@ -517,6 +517,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {
@@ -550,16 +560,6 @@
             }
           ]
         },
-        "inline": {
-          "oneOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "extends": {
           "oneOf": [
             {
@@ -730,6 +730,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {
@@ -763,16 +773,6 @@
             }
           ]
         },
-        "inline": {
-          "oneOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "default": {
           "oneOf": [
             {
@@ -1073,6 +1073,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {
@@ -1106,16 +1116,6 @@
             }
           ]
         },
-        "inline": {
-          "oneOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "discriminant": {
           "oneOf": [
             {
@@ -1239,6 +1239,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {
@@ -1272,16 +1282,6 @@
             }
           ]
         },
-        "inline": {
-          "oneOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
         "discriminated": {
           "const": false
         },
@@ -1334,6 +1334,16 @@
             }
           ]
         },
+        "inline": {
+          "oneOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "docs": {
           "oneOf": [
             {

diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts
@@ -653,6 +653,12 @@ function convertPropertyTypeReferenceToTypeDefinition({
     }
 }
 
+/**
+ * Returns whether the declaration should be inlined.
+ * If a declaration is nested within another declaration, it should be inlined.
+ * @param declarationDepth Keeps track of how nested the declaration is.
+ * @returns `true` if the declaration should be inlined, `undefined` otherwise.
+ */
 function getInline(declarationDepth: number): boolean | undefined {
     return declarationDepth > 0 ? true : undefined;
 }
diff --git a/packages/cli/fern-definition/schema/src/schemas/api/resources/commons/types/WithInline.ts b/packages/cli/fern-definition/schema/src/schemas/api/resources/commons/types/WithInline.ts
diff --git a/packages/cli/fern-definition/schema/src/schemas/api/resources/commons/types/index.ts b/packages/cli/fern-definition/schema/src/schemas/api/resources/commons/types/index.ts
@@ -3,7 +3,6 @@ export * from "./WithName";
 export * from "./WithAvailability";
 export * from "./WithDisplayName";
 export * from "./WithAudiences";
-export * from "./WithInline";
 export * from "./DeclarationSchema";
 export * from "./DeclarationWithoutDocsSchema";
 export * from "./DeclarationWithNameSchema";