fix(openrpc): handle require false (#2093)

fern-api · Jan 30, 2025 · e68acfc · e68acfc
1 parent c425af4
commit e68acfc
Show file tree

Hide file tree

Showing 5 changed files with 1,674 additions and 1,437 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.42",
+  "version": "0.0.43",
   "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
@@ -102,7 +102,16 @@ export class MethodConverterNode extends BaseOpenrpcConverterNode<
 
             return {
               key: FernRegistry.PropertyKey(param.name),
-              valueShape,
+              valueShape: !param.required
+                ? {
+                    type: "alias",
+                    value: {
+                      type: "optional",
+                      shape: valueShape,
+                      default: undefined,
+                    },
+                  }
+                : valueShape,
               description: param.description,
               availability: undefined,
             };

diff --git a/packages/parsers/src/openrpc/__test__/__snapshots__/ethereum.json b/packages/parsers/src/openrpc/__test__/__snapshots__/ethereum.json
@@ -1389,10 +1389,16 @@
                 "valueShape": {
                   "type": "alias",
                   "value": {
-                    "type": "primitive",
-                    "value": {
-                      "type": "string",
-                      "regex": "^0x[a-fA-F\\d]+$"
+                    "type": "optional",
+                    "shape": {
+                      "type": "alias",
+                      "value": {
+                        "type": "primitive",
+                        "value": {
+                          "type": "string",
+                          "regex": "^0x[a-fA-F\\d]+$"
+                        }
+                      }
                     }
                   }
                 },
@@ -2164,8 +2170,14 @@
                 "valueShape": {
                   "type": "alias",
                   "value": {
-                    "type": "id",
-                    "id": "BlockNumber"
+                    "type": "optional",
+                    "shape": {
+                      "type": "alias",
+                      "value": {
+                        "type": "id",
+                        "id": "BlockNumber"
+                      }
+                    }
                   }
                 },
                 "description": "A BlockNumber at which to request the balance"
@@ -2641,8 +2653,14 @@
                 "valueShape": {
                   "type": "alias",
                   "value": {
-                    "type": "id",
-                    "id": "BlockNumber"
+                    "type": "optional",
+                    "shape": {
+                      "type": "alias",
+                      "value": {
+                        "type": "id",
+                        "id": "BlockNumber"
+                      }
+                    }
                   }
                 },
                 "description": "A BlockNumber of which the code existed"

diff --git a/packages/parsers/src/openrpc/__test__/__snapshots__/petstore.json b/packages/parsers/src/openrpc/__test__/__snapshots__/petstore.json
@@ -118,10 +118,16 @@
                 "valueShape": {
                   "type": "alias",
                   "value": {
-                    "type": "primitive",
-                    "value": {
-                      "type": "integer",
-                      "minimum": 1
+                    "type": "optional",
+                    "shape": {
+                      "type": "alias",
+                      "value": {
+                        "type": "primitive",
+                        "value": {
+                          "type": "integer",
+                          "minimum": 1
+                        }
+                      }
                     }
                   }
                 },
@@ -242,9 +248,15 @@
                 "valueShape": {
                   "type": "alias",
                   "value": {
-                    "type": "primitive",
-                    "value": {
-                      "type": "string"
+                    "type": "optional",
+                    "shape": {
+                      "type": "alias",
+                      "value": {
+                        "type": "primitive",
+                        "value": {
+                          "type": "string"
+                        }
+                      }
                     }
                   }
                 },