feat: better example generation, add parameter definitions

packages/parsers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fern-api/docs-parsers",
-  "version": "0.0.37",
+  "version": "0.0.38",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern-platform.git",

packages/parsers/src/openapi/3.1/extensions/XFernEndpointExampleConverter.node.ts

@@ -184,14 +184,12 @@ export class XFernEndpointExampleConverterNode extends BaseOpenApiV3_1ConverterN
       this.requestBodyByContentType ?? {}
     )[0];
 
-    if (requestBodyContentTypeKey == null) {
-      return undefined;
-    }
-
     return this.examples.flatMap((example) => {
       return (this.responseBodies ?? []).map((responseBodyNode) => {
         const requestBodyShape =
-          this.requestBodyByContentType?.[requestBodyContentTypeKey];
+          requestBodyContentTypeKey != null
+            ? this.requestBodyByContentType?.[requestBodyContentTypeKey]
+            : undefined;
         let requestBody:
           | FernRegistry.api.latest.ExampleEndpointRequest
           | undefined;
@@ -305,27 +303,35 @@ export class XFernEndpointExampleConverterNode extends BaseOpenApiV3_1ConverterN
           }
         });
 
+        const pathParameters = Object.fromEntries(
+          Object.entries(example["path-parameters"] ?? {}).map(
+            ([key, value]) => [FernRegistry.PropertyKey(key), value]
+          )
+        );
+        const queryParameters = Object.fromEntries(
+          Object.entries(example["query-parameters"] ?? {}).map(
+            ([key, value]) => [FernRegistry.PropertyKey(key), value]
+          )
+        );
+        const headers = Object.fromEntries(
+          Object.entries(example.headers ?? {}).map(([key, value]) => [
+            FernRegistry.PropertyKey(key),
+            value,
+          ])
+        );
+
         return {
           path: this.path,
           responseStatusCode: this.successResponseStatusCode,
           name: example.name,
           description: example.docs,
-          pathParameters: Object.fromEntries(
-            Object.entries(example["path-parameters"] ?? {}).map(
-              ([key, value]) => [FernRegistry.PropertyKey(key), value]
-            )
-          ),
-          queryParameters: Object.fromEntries(
-            Object.entries(example["query-parameters"] ?? {}).map(
-              ([key, value]) => [FernRegistry.PropertyKey(key), value]
-            )
-          ),
-          headers: Object.fromEntries(
-            Object.entries(example.headers ?? {}).map(([key, value]) => [
-              FernRegistry.PropertyKey(key),
-              value,
-            ])
-          ),
+          pathParameters:
+            Object.keys(pathParameters).length > 0 ? pathParameters : undefined,
+          queryParameters:
+            Object.keys(queryParameters).length > 0
+              ? queryParameters
+              : undefined,
+          headers: Object.keys(headers).length > 0 ? headers : undefined,
           requestBody,
           responseBody,
           snippets,

packages/parsers/src/openapi/3.1/extensions/__test__/XFernEndpointExampleConverter.node.test.ts

@@ -64,9 +64,6 @@ describe("XFernEndpointExampleConverterNode", () => {
           responseStatusCode: 200,
           name: "Create user",
           description: "Example of creating a user",
-          pathParameters: {},
-          queryParameters: {},
-          headers: {},
           requestBody: {
             type: "json",
             value: {
@@ -136,9 +133,6 @@ describe("XFernEndpointExampleConverterNode", () => {
           path: "/upload",
           responseStatusCode: 200,
           name: "Upload file",
-          pathParameters: {},
-          queryParameters: {},
-          headers: {},
           requestBody: {
             type: "form",
             value: {
@@ -206,9 +200,6 @@ describe("XFernEndpointExampleConverterNode", () => {
           path: "/stream",
           responseStatusCode: 200,
           name: "Stream events",
-          pathParameters: {},
-          queryParameters: {},
-          headers: {},
           requestBody: {
             type: "json",
             value: {},

packages/parsers/src/openapi/3.1/extensions/__test__/examples/RedocExampleConverter.node.test.ts

@@ -107,31 +107,33 @@ describe("RedocExampleConverterNode", () => {
       const result = node.convert();
 
       expect(result).toEqual({
-        typescript: [
-          {
-            name: "TS Example",
-            language: "TypeScript",
-            code: "console.log('hello')",
-            install: undefined,
-            generated: false,
-            description: undefined,
-          },
-          {
-            name: undefined,
-            language: "TypeScript",
-            code: "console.log('world')",
-            install: undefined,
-            generated: false,
-            description: undefined,
-          },
-        ],
+        snippets: {
+          typescript: [
+            {
+              name: "TS Example",
+              language: "TypeScript",
+              code: "console.log('hello')",
+              install: undefined,
+              generated: false,
+              description: undefined,
+            },
+            {
+              name: undefined,
+              language: "TypeScript",
+              code: "console.log('world')",
+              install: undefined,
+              generated: false,
+              description: undefined,
+            },
+          ],
+        },
       });
     });
 
     test("returns undefined when no code samples", () => {
       const node = createNode({});
       const result = node.convert();
-      expect(result).toEqual({});
+      expect(result).toEqual(undefined);
     });
   });
 });

packages/parsers/src/openapi/3.1/extensions/examples/RedocExampleConverter.node.ts

@@ -23,11 +23,16 @@ export declare namespace RedocExampleConverterNode {
 
 export class RedocExampleConverterNode extends BaseOpenApiV3_1ConverterNode<
   unknown,
-  Record<string, FernRegistry.api.latest.CodeSnippet[]>
+  FernRegistry.api.latest.ExampleEndpointCall
 > {
   codeSamples: RedocExampleConverterNode.RedocCodeSample[] | undefined;
 
-  constructor(args: BaseOpenApiV3_1ConverterNodeConstructorArgs<unknown>) {
+  constructor(
+    args: BaseOpenApiV3_1ConverterNodeConstructorArgs<unknown>,
+    protected path: string,
+    protected responseStatusCode: number,
+    protected name: string | undefined
+  ) {
     super(args);
     this.safeParse();
   }
@@ -57,7 +62,7 @@ export class RedocExampleConverterNode extends BaseOpenApiV3_1ConverterNode<
     });
   }
 
-  convert(): Record<string, FernRegistry.api.latest.CodeSnippet[]> | undefined {
+  convert(): FernRegistry.api.latest.ExampleEndpointCall | undefined {
     const convertedCodeSamples: Record<
       string,
       FernRegistry.api.latest.CodeSnippet[]
@@ -73,6 +78,20 @@ export class RedocExampleConverterNode extends BaseOpenApiV3_1ConverterNode<
         description: undefined,
       });
     });
-    return convertedCodeSamples;
+    if (Object.keys(convertedCodeSamples).length === 0) {
+      return undefined;
+    }
+    return {
+      path: this.path,
+      responseStatusCode: this.responseStatusCode,
+      name: this.name,
+      description: undefined,
+      pathParameters: undefined,
+      queryParameters: undefined,
+      headers: undefined,
+      requestBody: undefined,
+      responseBody: undefined,
+      snippets: convertedCodeSamples,
+    };
   }
 }