fix(cli): conjure importer brings in endpoint level descriptions (#5034)

fern-api · Oct 29, 2024 · 654aa61 · 654aa61
1 parent f25e5ea
commit 654aa61
Show file tree

Hide file tree

Showing 34 changed files with 476 additions and 25 deletions.
diff --git a/packages/cli/api-importers/conjure/conjure-to-fern-tests/__test__/__snapshots__/trace.json b/packages/cli/api-importers/conjure/conjure-to-fern-tests/__test__/__snapshots__/trace.json
diff --git a/packages/cli/api-importers/conjure/conjure-to-fern/src/ConjureImporter.ts b/packages/cli/api-importers/conjure/conjure-to-fern/src/ConjureImporter.ts
@@ -139,6 +139,10 @@ export class ConjureImporter extends APIDefinitionImporter<ConjureImporter.Args>
                         response: endpointDeclaration.returns === "binary" ? "file" : endpointDeclaration.returns
                     };
 
+                    if (endpointDeclaration.docs != null) {
+                        endpoint.docs = endpointDeclaration.docs;
+                    }
+
                     const pathParameters: Record<string, RawSchemas.HttpPathParameterSchema> = {};
                     if (endpointDeclaration.args != null) {
                         for (const pathParameter of endpointLocator.pathParameters) {

diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,10 @@
+- changelogEntry:
+    - summary: |
+        The Conjure importer now brings in endpoint level descriptions. 
+      type: feat
+  irVersion: 53
+  version: 0.45.0-rc27
+
 - changelogEntry:
     - summary: |
         `fern check` handles validating unions that contain base properties. 

diff --git a/packages/cli/generation/ir-generator/src/converters/type-declarations/convertExampleType.ts b/packages/cli/generation/ir-generator/src/converters/type-declarations/convertExampleType.ts
@@ -494,7 +494,8 @@ function convertObject({
                               file: fileContainingType
                           });
                           if (originalTypeDeclaration == null) {
-                              throw new Error("Could not find original type declaration for property: " + wireKey);
+                              // dont fail hard because it may be from `base-properties`
+                              return exampleProperties;
                           }
 
                           const valueExample = convertTypeReferenceExample({

diff --git a/seed/csharp-model/mixed-case/.mock/definition/service.yml b/seed/csharp-model/mixed-case/.mock/definition/service.yml
diff --git a/seed/csharp-sdk/mixed-case/.mock/definition/service.yml b/seed/csharp-sdk/mixed-case/.mock/definition/service.yml
diff --git a/seed/fastapi/mixed-case/.mock/definition/service.yml b/seed/fastapi/mixed-case/.mock/definition/service.yml
diff --git a/seed/go-fiber/mixed-case/.mock/definition/service.yml b/seed/go-fiber/mixed-case/.mock/definition/service.yml
diff --git a/seed/go-model/mixed-case/.mock/definition/service.yml b/seed/go-model/mixed-case/.mock/definition/service.yml
diff --git a/seed/go-sdk/mixed-case/.mock/definition/service.yml b/seed/go-sdk/mixed-case/.mock/definition/service.yml
diff --git a/seed/java-model/mixed-case/.mock/definition/service.yml b/seed/java-model/mixed-case/.mock/definition/service.yml
diff --git a/seed/java-sdk/mixed-case/.mock/definition/service.yml b/seed/java-sdk/mixed-case/.mock/definition/service.yml
diff --git a/seed/java-spring/mixed-case/.mock/definition/service.yml b/seed/java-spring/mixed-case/.mock/definition/service.yml
diff --git a/seed/openapi/mixed-case/.mock/definition/service.yml b/seed/openapi/mixed-case/.mock/definition/service.yml
diff --git a/seed/openapi/mixed-case/openapi.yml b/seed/openapi/mixed-case/openapi.yml
diff --git a/seed/php-model/mixed-case/.mock/definition/service.yml b/seed/php-model/mixed-case/.mock/definition/service.yml
diff --git a/seed/php-sdk/mixed-case/.mock/definition/service.yml b/seed/php-sdk/mixed-case/.mock/definition/service.yml
diff --git a/seed/postman/mixed-case/.mock/definition/service.yml b/seed/postman/mixed-case/.mock/definition/service.yml
diff --git a/seed/postman/mixed-case/collection.json b/seed/postman/mixed-case/collection.json