fix(cli): generate sse examples (#5420)

fern-api · Dec 15, 2024 · 8f7ce9f · 8f7ce9f
1 parent f0ee23d
commit 8f7ce9f
Show file tree

Hide file tree

Showing 12 changed files with 288 additions and 60 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
@@ -111,7 +111,10 @@ export class ExampleEndpointFactory {
                 if (example != null) {
                     if (endpoint.response?.type === "json") {
                         responseExamples.push([undefined, EndpointResponseExample.withoutStreaming(example)]);
-                    } else if (endpoint.response?.type === "streamingJson") {
+                    } else if (
+                        endpoint.response?.type === "streamingJson" ||
+                        endpoint.response?.type === "streamingSse"
+                    ) {
                         responseExamples.push([undefined, EndpointResponseExample.withStreaming([example])]);
                     }
                 }
@@ -131,7 +134,10 @@ export class ExampleEndpointFactory {
                     if (example != null) {
                         if (endpoint.response?.type === "json") {
                             responseExamples.push([exampleId, EndpointResponseExample.withoutStreaming(example)]);
-                        } else if (endpoint.response?.type === "streamingJson") {
+                        } else if (
+                            endpoint.response?.type === "streamingJson" ||
+                            endpoint.response?.type === "streamingSse"
+                        ) {
                             responseExamples.push([exampleId, EndpointResponseExample.withStreaming([example])]);
                         }
                     }
@@ -493,7 +499,7 @@ function getResponseSchema(response: ResponseWithExample | null | undefined): Sc
     if (response == null) {
         return undefined;
     }
-    if (response.type !== "json" && response.type !== "streamingJson") {
+    if (response.type !== "json" && response.type !== "streamingJson" && response.type !== "streamingSse") {
         return { type: "unsupported" };
     }
     return { type: "present", schema: response.schema, examples: response.fullExamples ?? [] };

diff --git a/...importers/openapi/openapi-ir-parser/src/openapi/v3/converters/endpoint/convertResponse.ts b/...importers/openapi/openapi-ir-parser/src/openapi/v3/converters/endpoint/convertResponse.ts
@@ -171,15 +171,14 @@ function convertResolvedResponse({
                 return ResponseWithExample.streamingSse({
                     description: resolvedResponse.description,
                     responseProperty: undefined,
-                    schema: convertSchemaWithExampleToSchema(
-                        convertSchema(
-                            textEventStreamObject.schema,
-                            false,
-                            context,
-                            responseBreadcrumbs,
-                            source,
-                            namespace
-                        )
+                    fullExamples: textEventStreamObject.examples,
+                    schema: convertSchema(
+                        textEventStreamObject.schema,
+                        false,
+                        context,
+                        responseBreadcrumbs,
+                        source,
+                        namespace
                     ),
                     source
                 });
@@ -209,15 +208,14 @@ function convertResolvedResponse({
                     return ResponseWithExample.streamingSse({
                         description: resolvedResponse.description,
                         responseProperty: undefined,
-                        schema: convertSchemaWithExampleToSchema(
-                            convertSchema(
-                                jsonMediaObject.schema,
-                                false,
-                                context,
-                                responseBreadcrumbs,
-                                source,
-                                namespace
-                            )
+                        fullExamples: jsonMediaObject.examples,
+                        schema: convertSchema(
+                            jsonMediaObject.schema,
+                            false,
+                            context,
+                            responseBreadcrumbs,
+                            source,
+                            namespace
                         ),
                         source
                     });

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
@@ -2101,6 +2101,27 @@ service:
                 "root.SessionsEventsRequestUnprocessableEntityError",
                 "root.SessionsEventsRequestInternalServerError",
               ],
+              "examples": [
+                {
+                  "path-parameters": {
+                    "id": "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
+                  },
+                  "response": {
+                    "stream": [
+                      {
+                        "data": {
+                          "code": "code",
+                          "event": "event",
+                          "message": "message",
+                        },
+                        "event": "error",
+                        "id": 1,
+                        "retry": 1,
+                      },
+                    ],
+                  },
+                },
+              ],
               "method": "GET",
               "pagination": undefined,
               "path": "/sessions/{id}/events",
@@ -2771,6 +2792,18 @@ service:
         - root.SessionsEventsRequestNotFoundError
         - root.SessionsEventsRequestUnprocessableEntityError
         - root.SessionsEventsRequestInternalServerError
+      examples:
+        - path-parameters:
+            id: 6aac6f73-bd89-4a76-ab32-5a6c422e8b0b
+          response:
+            stream:
+              - 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
@@ -51,6 +51,18 @@
             "create": {
               "auth": false,
               "docs": undefined,
+              "examples": [
+                {
+                  "request": {
+                    "prompt": "prompt",
+                  },
+                  "response": {
+                    "stream": [
+                      "string",
+                    ],
+                  },
+                },
+              ],
               "method": "POST",
               "pagination": undefined,
               "path": "/completions/chat",
@@ -103,6 +115,12 @@
         docs: Success!
         type: string
         format: sse
+      examples:
+        - request:
+            prompt: prompt
+          response:
+            stream:
+              - string
   source:
     openapi: ../openapi.yml
 ",