feat(openrpc): support environments (#2015)

fern-api · Jan 15, 2025 · 8449221 · 8449221
1 parent e516628
commit 8449221
Show file tree

Hide file tree

Showing 8 changed files with 10,463 additions and 69 deletions.
diff --git a/packages/parsers/package.json b/packages/parsers/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@fern-api/docs-parsers",
-  "version": "0.0.35",
+  "version": "0.0.36",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern-platform.git",

diff --git a/packages/parsers/src/openrpc/1.x/MethodConverter.node.ts b/packages/parsers/src/openrpc/1.x/MethodConverter.node.ts
@@ -1,8 +1,9 @@
 import { isNonNullish } from "@fern-api/ui-core-utils";
 import { MethodObject } from "@open-rpc/meta-schema";
+import { camelCase } from "es-toolkit";
 import { UnreachableCaseError } from "ts-essentials";
 import { FernRegistry } from "../../client/generated";
-import { SchemaConverterNode } from "../../openapi";
+import { SchemaConverterNode, ServerObjectConverterNode } from "../../openapi";
 import { maybeSingleValueToArray } from "../../openapi/utils/maybeSingleValueToArray";
 import {
   BaseOpenrpcConverterNode,
@@ -17,10 +18,15 @@ export class MethodConverterNode extends BaseOpenrpcConverterNode<
   FernRegistry.api.latest.EndpointDefinition
 > {
   private method: MethodObject;
+  private servers: ServerObjectConverterNode[] = [];
 
-  constructor(args: BaseOpenrpcConverterNodeConstructorArgs<MethodObject>) {
+  constructor(
+    args: BaseOpenrpcConverterNodeConstructorArgs<MethodObject>,
+    servers: ServerObjectConverterNode[]
+  ) {
     super(args);
     this.method = args.input;
+    this.servers = servers;
     this.safeParse();
   }
 
@@ -98,7 +104,7 @@ export class MethodConverterNode extends BaseOpenrpcConverterNode<
       // This is a basic implementation that needs to be expanded
       return {
         id: FernRegistry.EndpointId(this.input.name),
-        displayName: this.input.summary ?? this.input.name,
+        displayName: camelCase(this.input.name),
         method: "POST",
         path: [{ type: "literal", value: "" }],
         auth: undefined,
@@ -152,10 +158,12 @@ export class MethodConverterNode extends BaseOpenrpcConverterNode<
             }
           )
           .filter(isNonNullish),
-        description: this.input.description,
+        description: this.input.description ?? this.input.summary,
         operationId: this.input.name,
         defaultEnvironment: undefined,
-        environments: [],
+        environments: this.servers
+          .map((server) => server.convert())
+          .filter(isNonNullish),
         availability: this.method.deprecated ? "Deprecated" : undefined,
         requestHeaders: [],
         responseHeaders: [],

diff --git a/packages/parsers/src/openrpc/1.x/OpenrpcDocumentConverter.node.ts b/packages/parsers/src/openrpc/1.x/OpenrpcDocumentConverter.node.ts
@@ -2,7 +2,9 @@ import { isNonNullish } from "@fern-api/ui-core-utils";
 import { OpenrpcDocument } from "@open-rpc/meta-schema";
 import { v4 } from "uuid";
 import { FernRegistry } from "../../client/generated";
+import { ServerObjectConverterNode } from "../../openapi";
 import { ComponentsConverterNode } from "../../openapi/3.1/schemas/ComponentsConverter.node";
+import { coalesceServers } from "../../openapi/utils/3.1/coalesceServers";
 import {
   BaseOpenrpcConverterNode,
   BaseOpenrpcConverterNodeConstructorArgs,
@@ -14,6 +16,7 @@ export class OpenrpcDocumentConverterNode extends BaseOpenrpcConverterNode<
   OpenrpcDocument,
   FernRegistry.api.latest.ApiDefinition
 > {
+  servers: ServerObjectConverterNode[] = [];
   methods: MethodConverterNode[] = [];
   components: ComponentsConverterNode | undefined;
 
@@ -23,6 +26,15 @@ export class OpenrpcDocumentConverterNode extends BaseOpenrpcConverterNode<
   }
 
   parse(): void {
+    if (this.context.openrpc.servers != null) {
+      this.servers = coalesceServers(
+        this.servers,
+        this.input.servers,
+        this.context,
+        this.accessPath
+      );
+    }
+
     if (this.input.methods != null) {
       for (const method of this.input.methods) {
         const resolvedMethod = resolveMethodReference(
@@ -33,15 +45,19 @@ export class OpenrpcDocumentConverterNode extends BaseOpenrpcConverterNode<
           continue;
         }
         this.methods.push(
-          new MethodConverterNode({
-            input: resolvedMethod,
-            context: this.context,
-            accessPath: this.accessPath,
-            pathId: "methods",
-          })
+          new MethodConverterNode(
+            {
+              input: resolvedMethod,
+              context: this.context,
+              accessPath: this.accessPath,
+              pathId: "methods",
+            },
+            this.servers
+          )
         );
       }
     }
+
     if (this.context.openrpc.components != null) {
       this.components = new ComponentsConverterNode({
         input: this.context.openrpc.components,

diff --git a/packages/parsers/src/openrpc/__test__/OpenrpcConverter.test.ts b/packages/parsers/src/openrpc/__test__/OpenrpcConverter.test.ts
@@ -29,8 +29,6 @@ describe("OpenRPC converter", () => {
       const errors = [];
       const warnings = [];
 
-      expect(parsed.components?.schemas).toBeDefined();
-
       if (parsed.components?.schemas) {
         const converter = new OpenrpcDocumentConverterNode({
           input: parsed,
@@ -51,8 +49,6 @@ describe("OpenRPC converter", () => {
       if (warnings.length > 0) {
         // console.warn("warnings:", warnings);
       }
-
-      converted.id = "test-uuid-replacement";
       await expect(
         replaceEndpointUUIDs(JSON.stringify(converted, null, 2))
       ).toMatchFileSnapshot(`./__snapshots__/${directory}.json`);