fix(cli): generated sse examples must have a data and event key (#5421

)
fern-api · Dec 16, 2024 · eff31d2 · eff31d2
1 parent 8f7ce9f
commit eff31d2
Show file tree

Hide file tree

Showing 23 changed files with 159 additions and 59 deletions.
diff --git a/...i-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/ExampleEndpointFactory.ts b/...i-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/ExampleEndpointFactory.ts
@@ -115,7 +115,13 @@ export class ExampleEndpointFactory {
                         endpoint.response?.type === "streamingJson" ||
                         endpoint.response?.type === "streamingSse"
                     ) {
-                        responseExamples.push([undefined, EndpointResponseExample.withStreaming([example])]);
+                        responseExamples.push([
+                            undefined,
+                            EndpointResponseExample.withStreaming({
+                                sse: endpoint.response?.type === "streamingSse",
+                                events: [example]
+                            })
+                        ]);
                     }
                 }
             } else {
@@ -138,7 +144,13 @@ export class ExampleEndpointFactory {
                             endpoint.response?.type === "streamingJson" ||
                             endpoint.response?.type === "streamingSse"
                         ) {
-                            responseExamples.push([exampleId, EndpointResponseExample.withStreaming([example])]);
+                            responseExamples.push([
+                                undefined,
+                                EndpointResponseExample.withStreaming({
+                                    sse: endpoint.response?.type === "streamingSse",
+                                    events: [example]
+                                })
+                            ]);
                         }
                     }
                 }

diff --git a/...openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json b/...openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json
@@ -2110,13 +2110,16 @@ service:
                     "stream": [
                       {
                         "data": {
-                          "code": "code",
-                          "event": "event",
-                          "message": "message",
+                          "data": {
+                            "code": "code",
+                            "event": "event",
+                            "message": "message",
+                          },
+                          "event": "error",
+                          "id": 1,
+                          "retry": 1,
                         },
-                        "event": "error",
-                        "id": 1,
-                        "retry": 1,
+                        "event": "",
                       },
                     ],
                   },
@@ -2797,13 +2800,15 @@ service:
             id: 6aac6f73-bd89-4a76-ab32-5a6c422e8b0b
           response:
             stream:
-              - event: error
+              - event: ''
                 data:
-                  code: code
-                  event: event
-                  message: message
-                id: 1
-                retry: 1
+                  event: error
+                  data:
+                    code: code
+                    event: event
+                    message: message
+                  id: 1
+                  retry: 1
       audiences:
         - public
   source:

diff --git a/...i-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-sse.json b/...i-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-sse.json
@@ -58,7 +58,10 @@
                   },
                   "response": {
                     "stream": [
-                      "string",
+                      {
+                        "data": "string",
+                        "event": "",
+                      },
                     ],
                   },
                 },
@@ -120,7 +123,8 @@
             prompt: prompt
           response:
             stream:
-              - string
+              - event: ''
+                data: string
   source:
     openapi: ../openapi.yml
 ",

diff --git a/...ers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/streaming.json b/...ers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/streaming.json
@@ -114,7 +114,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "properties": {
                   "id": {
@@ -378,7 +379,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "properties": {
                   "id": {
@@ -734,7 +736,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "properties": {
                   "id": {

diff --git a/...s/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/switchboard.json b/...s/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/switchboard.json
@@ -3333,7 +3333,8 @@
           "queryParameters": [],
           "headers": [],
           "response": {
-            "value": [
+            "sse": true,
+            "events": [
               {
                 "value": {
                   "value": {

diff --git a/...orters/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/vellum.json b/...orters/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/vellum.json
@@ -1309,7 +1309,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "value": {
                   "value": {
@@ -2007,7 +2008,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "properties": {
                   "delta": {

diff --git a/...openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-global-headers.json b/...openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-global-headers.json
@@ -239,7 +239,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "properties": {
                   "id": {

diff --git a/...ern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-sdk-group-name-with-streaming.json b/...ern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-sdk-group-name-with-streaming.json
@@ -127,7 +127,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "properties": {
                   "id": {

diff --git a/...-to-fern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-streaming-with-audiences.json b/...-to-fern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-streaming-with-audiences.json
@@ -129,7 +129,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "properties": {
                   "id": {

diff --git a/...-to-fern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-streaming-with-reference.json b/...-to-fern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-streaming-with-reference.json
@@ -120,7 +120,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "properties": {
                   "text": {

diff --git a/...api-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-streaming-with-sse.json b/...api-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/x-fern-streaming-with-sse.json
@@ -78,7 +78,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": true,
+            "events": [
               {
                 "value": {
                   "value": "string",

diff --git a/...n-tests/src/__test__/__snapshots__/openapi-ir/x-fern-streaming-with-stream-condition.json b/...n-tests/src/__test__/__snapshots__/openapi-ir/x-fern-streaming-with-stream-condition.json
@@ -175,7 +175,8 @@
             "type": "object"
           },
           "response": {
-            "value": [
+            "sse": false,
+            "events": [
               {
                 "properties": {
                   "chunk": {

diff --git a/...ters/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json b/...ters/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json
@@ -2002,13 +2002,16 @@ service:
                     "stream": [
                       {
                         "data": {
-                          "code": "code",
-                          "event": "event",
-                          "message": "message",
+                          "data": {
+                            "code": "code",
+                            "event": "event",
+                            "message": "message",
+                          },
+                          "event": "error",
+                          "id": 1,
+                          "retry": 1,
                         },
-                        "event": "error",
-                        "id": 1,
-                        "retry": 1,
+                        "event": "",
                       },
                     ],
                   },
@@ -2689,13 +2692,15 @@ service:
             id: 6aac6f73-bd89-4a76-ab32-5a6c422e8b0b
           response:
             stream:
-              - event: error
+              - event: ''
                 data:
-                  code: code
-                  event: event
-                  message: message
-                id: 1
-                retry: 1
+                  event: error
+                  data:
+                    code: code
+                    event: event
+                    message: message
+                  id: 1
+                  retry: 1
       audiences:
         - public
   source:

diff --git a/...penapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-sse.json b/...penapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-sse.json
@@ -58,7 +58,10 @@
                   },
                   "response": {
                     "stream": [
-                      "string",
+                      {
+                        "data": "string",
+                        "event": "",
+                      },
                     ],
                   },
                 },
@@ -120,7 +123,8 @@
             prompt: prompt
           response:
             stream:
-              - string
+              - event: ''
+                data: string
   source:
     openapi: ../openapi.yml
 ",

diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/utils/convertFullExample.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/utils/convertFullExample.ts
@@ -36,10 +36,17 @@ export function convertEndpointResponseExample(
     endpointResponseExample: EndpointResponseExample
 ): RawSchemas.ExampleStreamResponseSchema | RawSchemas.ExampleBodyResponseSchema {
     switch (endpointResponseExample.type) {
-        case "withStreaming":
-            return {
-                stream: convertArrayExample(endpointResponseExample.value)
-            };
+        case "withStreaming": {
+            if (endpointResponseExample.sse) {
+                return {
+                    stream: convertSseExample(endpointResponseExample.events)
+                };
+            } else {
+                return {
+                    stream: convertArrayExample(endpointResponseExample.events)
+                };
+            }
+        }
         case "withoutStreaming":
             return {
                 body: convertFullExample(endpointResponseExample.value)
@@ -97,6 +104,12 @@ function convertObject(object: Record<PropertyKey, FullExample>): RawSchemas.Exa
     );
 }
 
+function convertSseExample(fullExamples: FullExample[]): RawSchemas.ExampleSseEventSchema[] {
+    return fullExamples.map((fullExample) => {
+        return { event: "", data: convertFullExample(fullExample) };
+    });
+}
+
 function convertArrayExample(fullExamples: FullExample[]): RawSchemas.ExampleTypeReferenceSchema[] {
     return fullExamples.map((fullExample) => {
         return convertFullExample(fullExample);

diff --git a/packages/cli/api-importers/openapi/openapi-ir/fern/definition/finalIr.yml b/packages/cli/api-importers/openapi/openapi-ir/fern/definition/finalIr.yml
@@ -295,8 +295,13 @@ types:
   EndpointResponseExample:
     docs: An example that has either a list of streaming examples or a single non-streaming example.
     union:
-      withStreaming: list<example.FullExample>
+      withStreaming: StreamingResponseExample
       withoutStreaming: example.FullExample
+
+  StreamingResponseExample: 
+    properties: 
+      sse: boolean
+      events: list<example.FullExample>
 
   PathParameterExample:
     properties:

diff --git a/...porters/openapi/openapi-ir/src/sdk/api/resources/finalIr/types/EndpointResponseExample.ts b/...porters/openapi/openapi-ir/src/sdk/api/resources/finalIr/types/EndpointResponseExample.ts
@@ -12,9 +12,8 @@ export type EndpointResponseExample =
     | FernOpenapiIr.EndpointResponseExample.WithoutStreaming;
 
 export declare namespace EndpointResponseExample {
-    interface WithStreaming extends _Utils {
+    interface WithStreaming extends FernOpenapiIr.StreamingResponseExample, _Utils {
         type: "withStreaming";
-        value: FernOpenapiIr.FullExample[];
     }
 
     interface WithoutStreaming extends _Utils {
@@ -27,16 +26,18 @@ export declare namespace EndpointResponseExample {
     }
 
     interface _Visitor<_Result> {
-        withStreaming: (value: FernOpenapiIr.FullExample[]) => _Result;
+        withStreaming: (value: FernOpenapiIr.StreamingResponseExample) => _Result;
         withoutStreaming: (value: FernOpenapiIr.FullExample) => _Result;
         _other: (value: { type: string }) => _Result;
     }
 }
 
 export const EndpointResponseExample = {
-    withStreaming: (value: FernOpenapiIr.FullExample[]): FernOpenapiIr.EndpointResponseExample.WithStreaming => {
+    withStreaming: (
+        value: FernOpenapiIr.StreamingResponseExample
+    ): FernOpenapiIr.EndpointResponseExample.WithStreaming => {
         return {
-            value: value,
+            ...value,
             type: "withStreaming",
             _visit: function <_Result>(
                 this: FernOpenapiIr.EndpointResponseExample.WithStreaming,
@@ -66,7 +67,7 @@ export const EndpointResponseExample = {
     ): _Result => {
         switch (value.type) {
             case "withStreaming":
-                return visitor.withStreaming(value.value);
+                return visitor.withStreaming(value);
             case "withoutStreaming":
                 return visitor.withoutStreaming(value.value);
             default:

diff --git a/...orters/openapi/openapi-ir/src/sdk/api/resources/finalIr/types/StreamingResponseExample.ts b/...orters/openapi/openapi-ir/src/sdk/api/resources/finalIr/types/StreamingResponseExample.ts
@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as FernOpenapiIr from "../../../index";
+
+export interface StreamingResponseExample {
+    sse: boolean;
+    events: FernOpenapiIr.FullExample[];
+}
diff --git a/packages/cli/api-importers/openapi/openapi-ir/src/sdk/api/resources/finalIr/types/index.ts b/packages/cli/api-importers/openapi/openapi-ir/src/sdk/api/resources/finalIr/types/index.ts
@@ -26,6 +26,7 @@ export * from "./FernExample";
 export * from "./EndpointExample";
 export * from "./FullEndpointExample";
 export * from "./EndpointResponseExample";
+export * from "./StreamingResponseExample";
 export * from "./PathParameterExample";
 export * from "./QueryParameterExample";
 export * from "./HeaderExample";