(fix): literal descriptions from OpenAPI (#3501)

* (fix): literal descriptions from OpenAPI * (fix): uploadcare test * fix and run test on larger runner * fix test * fix
fern-api · May 1, 2024 · 033fadb · 033fadb
1 parent 3da04c7
commit 033fadb
Show file tree

Hide file tree

Showing 17 changed files with 454 additions and 215 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -99,10 +99,7 @@ jobs:
         run: yarn lint:eslint
 
   test:
-    runs-on: CLI
-    strategy:
-      matrix:
-        shard: [1, 2, 3, 4]
+    runs-on: Test
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
@@ -116,7 +113,7 @@ jobs:
         run: yarn install
 
       - name: Run tests
-        run: yarn test --maxWorkers 15 --shard=${{ matrix.shard }}/${{ strategy.job-total }} --ci
+        run: yarn test --maxWorkers 15 --ci --silent
 
       - name: Ensure no changes to git-tracked files
         run: git --no-pager diff --exit-code

diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/aries.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/aries.test.ts.snap
@@ -9761,7 +9761,10 @@ exports[`open api parser aries docs 1`] = `
                     "docs": "Image url for this wallet. This image url is publicized            (self-attested) to other agents as part of forming a connection.",
                     "type": "optional<string>",
                   },
-                  "key_management_mode": "optional<literal<"managed">>",
+                  "key_management_mode": {
+                    "docs": "Key management method to use for this wallet.",
+                    "type": "optional<literal<"managed">>",
+                  },
                   "label": {
                     "docs": "Label for this wallet. This label is publicized            (self-attested) to other agents as part of forming a connection.",
                     "type": "optional<string>",
@@ -17715,7 +17718,10 @@ exports[`open api parser aries docs 1`] = `
             "docs": "Indy revocation registry identifier",
             "type": "optional<string>",
           },
-          "revocDefType": "optional<literal<"CL_ACCUM">>",
+          "revocDefType": {
+            "docs": "Revocation registry type (specify CL_ACCUM)",
+            "type": "optional<literal<"CL_ACCUM">>",
+          },
           "tag": {
             "docs": "Revocation registry tag",
             "type": "optional<string>",
@@ -17980,7 +17986,10 @@ exports[`open api parser aries docs 1`] = `
             "docs": "Issuer revocation registry record identifier",
             "type": "optional<string>",
           },
-          "revoc_def_type": "optional<literal<"CL_ACCUM">>",
+          "revoc_def_type": {
+            "docs": "Revocation registry type (specify CL_ACCUM)",
+            "type": "optional<literal<"CL_ACCUM">>",
+          },
           "revoc_reg_def": "optional<IssuerRevRegRecordRevocRegDef>",
           "revoc_reg_entry": "optional<IssuerRevRegRecordRevocRegEntry>",
           "revoc_reg_id": {
@@ -30187,7 +30196,10 @@ exports[`open api parser aries simple 1`] = `
                     "docs": "Image url for this wallet. This image url is publicized            (self-attested) to other agents as part of forming a connection.",
                     "type": "optional<string>",
                   },
-                  "key_management_mode": "optional<literal<"managed">>",
+                  "key_management_mode": {
+                    "docs": "Key management method to use for this wallet.",
+                    "type": "optional<literal<"managed">>",
+                  },
                   "label": {
                     "docs": "Label for this wallet. This label is publicized            (self-attested) to other agents as part of forming a connection.",
                     "type": "optional<string>",
@@ -38141,7 +38153,10 @@ exports[`open api parser aries simple 1`] = `
             "docs": "Indy revocation registry identifier",
             "type": "optional<string>",
           },
-          "revocDefType": "optional<literal<"CL_ACCUM">>",
+          "revocDefType": {
+            "docs": "Revocation registry type (specify CL_ACCUM)",
+            "type": "optional<literal<"CL_ACCUM">>",
+          },
           "tag": {
             "docs": "Revocation registry tag",
             "type": "optional<string>",
@@ -38406,7 +38421,10 @@ exports[`open api parser aries simple 1`] = `
             "docs": "Issuer revocation registry record identifier",
             "type": "optional<string>",
           },
-          "revoc_def_type": "optional<literal<"CL_ACCUM">>",
+          "revoc_def_type": {
+            "docs": "Revocation registry type (specify CL_ACCUM)",
+            "type": "optional<literal<"CL_ACCUM">>",
+          },
           "revoc_reg_def": "optional<IssuerRevRegRecordRevocRegDef>",
           "revoc_reg_entry": "optional<IssuerRevRegRecordRevocRegEntry>",
           "revoc_reg_id": {

diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/assembly.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/assembly.test.ts.snap
@@ -2399,7 +2399,10 @@ Valid values are in the range [0, 1] inclusive.
           "RealtimeBaseTranscript",
         ],
         "properties": {
-          "message_type": "literal<"FinalTranscript">",
+          "message_type": {
+            "docs": "Describes the type of message.",
+            "type": "literal<"FinalTranscript">",
+          },
           "punctuated": {
             "docs": "Whether the text has been punctuated and cased.",
             "type": "boolean",
@@ -2586,7 +2589,10 @@ Can be any value between 0.0 and 1.0 inclusive.
           "RealtimeBaseTranscript",
         ],
         "properties": {
-          "message_type": "literal<"PartialTranscript">",
+          "message_type": {
+            "docs": "Describes the type of message.",
+            "type": "literal<"PartialTranscript">",
+          },
         },
       },
       "PiiPolicy": {
@@ -2728,7 +2734,10 @@ Can be any value between 0.0 and 1.0 inclusive.
           },
         },
       },
-      "RedactedAudioStatus": "literal<"redacted_audio_ready">",
+      "RedactedAudioStatus": {
+        "docs": "The status of the redacted audio",
+        "type": "literal<"redacted_audio_ready">",
+      },
       "SentencesResponse": {
         "docs": undefined,
         "properties": {
@@ -2781,7 +2790,10 @@ Can be any value between 0.0 and 1.0 inclusive.
             "docs": "Timestamp when this session will expire.",
             "type": "datetime",
           },
-          "message_type": "literal<"SessionBegins">",
+          "message_type": {
+            "docs": "Describes the type of the message.",
+            "type": "literal<"SessionBegins">",
+          },
           "session_id": {
             "docs": "Unique identifier for the established session.",
             "type": "string",
@@ -2791,7 +2803,10 @@ Can be any value between 0.0 and 1.0 inclusive.
       "SessionTerminated": {
         "docs": undefined,
         "properties": {
-          "message_type": "literal<"SessionTerminated">",
+          "message_type": {
+            "docs": "Describes the type of the message.",
+            "type": "literal<"SessionTerminated">",
+          },
         },
       },
       "SeverityScoreSummary": {
@@ -5293,7 +5308,10 @@ Valid values are in the range [0, 1] inclusive.
           "RealtimeBaseTranscript",
         ],
         "properties": {
-          "message_type": "literal<"FinalTranscript">",
+          "message_type": {
+            "docs": "Describes the type of message.",
+            "type": "literal<"FinalTranscript">",
+          },
           "punctuated": {
             "docs": "Whether the text has been punctuated and cased.",
             "type": "boolean",
@@ -5480,7 +5498,10 @@ Can be any value between 0.0 and 1.0 inclusive.
           "RealtimeBaseTranscript",
         ],
         "properties": {
-          "message_type": "literal<"PartialTranscript">",
+          "message_type": {
+            "docs": "Describes the type of message.",
+            "type": "literal<"PartialTranscript">",
+          },
         },
       },
       "PiiPolicy": {
@@ -5622,7 +5643,10 @@ Can be any value between 0.0 and 1.0 inclusive.
           },
         },
       },
-      "RedactedAudioStatus": "literal<"redacted_audio_ready">",
+      "RedactedAudioStatus": {
+        "docs": "The status of the redacted audio",
+        "type": "literal<"redacted_audio_ready">",
+      },
       "SentencesResponse": {
         "docs": undefined,
         "properties": {
@@ -5675,7 +5699,10 @@ Can be any value between 0.0 and 1.0 inclusive.
             "docs": "Timestamp when this session will expire.",
             "type": "datetime",
           },
-          "message_type": "literal<"SessionBegins">",
+          "message_type": {
+            "docs": "Describes the type of the message.",
+            "type": "literal<"SessionBegins">",
+          },
           "session_id": {
             "docs": "Unique identifier for the established session.",
             "type": "string",
@@ -5685,7 +5712,10 @@ Can be any value between 0.0 and 1.0 inclusive.
       "SessionTerminated": {
         "docs": undefined,
         "properties": {
-          "message_type": "literal<"SessionTerminated">",
+          "message_type": {
+            "docs": "Describes the type of the message.",
+            "type": "literal<"SessionTerminated">",
+          },
         },
       },
       "SeverityScoreSummary": {

diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/belvo.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/belvo.test.ts.snap
@@ -23023,7 +23023,10 @@ We return one of the following enum values:
           "BUSINESS",
         ],
       },
-      "EnumBankAccountHolderTypePse": "literal<"BUSINESS">",
+      "EnumBankAccountHolderTypePse": {
+        "docs": "The type of bank account to create in Belvo. For business bank accounts, this field must the set to \`BUSINESS\`.",
+        "type": "literal<"BUSINESS">",
+      },
       "EnumBankAccountPixAccountTypeOfpi": {
         "docs": "The type of bank account. Can be either:
 
@@ -23272,7 +23275,14 @@ You can send through one of the following values:
           "LOW",
         ],
       },
-      "EnumIncomeSourceType": "literal<"BANK">",
+      "EnumIncomeSourceType": {
+        "docs": "The type of source we generate income insights from.
+We return one of the following enum values:
+
+  - \`BANK\`
+",
+        "type": "literal<"BANK">",
+      },
       "EnumIncomeStreamConfidence": {
         "docs": "Belvo's level of confidence for future incomes.
 
@@ -23346,7 +23356,12 @@ Can be either:
           "SAVINGS_ACCOUNT",
         ],
       },
-      "EnumIncomeVerificationAccountHolderType": "literal<"INDIVIDUAL">",
+      "EnumIncomeVerificationAccountHolderType": {
+        "docs": "The type of account holder. Can be:
+
+  - \`INDIVIDUAL\`",
+        "type": "literal<"INDIVIDUAL">",
+      },
       "EnumIncomeVerificationType": {
         "docs": "The direction of the transaction:
 
@@ -23732,7 +23747,14 @@ We return one of the following values:
           "Taxes",
         ],
       },
-      "EnumRecurringExpenseFrequency": "literal<"MONTHLY">",
+      "EnumRecurringExpenseFrequency": {
+        "docs": "The frequency at which this recurring expense occurs.
+
+
+ℹ️ **Note:** Belvo only identifies \`MONTHLY\` frequencies.
+",
+        "type": "literal<"MONTHLY">",
+      },
       "EnumRecurringExpensePaymentType": {
         "docs": "The type of recurring expense. We return one of the following values:
 
@@ -51543,7 +51565,10 @@ We return one of the following enum values:
           "BUSINESS",
         ],
       },
-      "EnumBankAccountHolderTypePse": "literal<"BUSINESS">",
+      "EnumBankAccountHolderTypePse": {
+        "docs": "The type of bank account to create in Belvo. For business bank accounts, this field must the set to \`BUSINESS\`.",
+        "type": "literal<"BUSINESS">",
+      },
       "EnumBankAccountPixAccountTypeOfpi": {
         "docs": "The type of bank account. Can be either:
 
@@ -51792,7 +51817,14 @@ You can send through one of the following values:
           "LOW",
         ],
       },
-      "EnumIncomeSourceType": "literal<"BANK">",
+      "EnumIncomeSourceType": {
+        "docs": "The type of source we generate income insights from.
+We return one of the following enum values:
+
+  - \`BANK\`
+",
+        "type": "literal<"BANK">",
+      },
       "EnumIncomeStreamConfidence": {
         "docs": "Belvo's level of confidence for future incomes.
 
@@ -51866,7 +51898,12 @@ Can be either:
           "SAVINGS_ACCOUNT",
         ],
       },
-      "EnumIncomeVerificationAccountHolderType": "literal<"INDIVIDUAL">",
+      "EnumIncomeVerificationAccountHolderType": {
+        "docs": "The type of account holder. Can be:
+
+  - \`INDIVIDUAL\`",
+        "type": "literal<"INDIVIDUAL">",
+      },
       "EnumIncomeVerificationType": {
         "docs": "The direction of the transaction:
 
@@ -52252,7 +52289,14 @@ We return one of the following values:
           "Taxes",
         ],
       },
-      "EnumRecurringExpenseFrequency": "literal<"MONTHLY">",
+      "EnumRecurringExpenseFrequency": {
+        "docs": "The frequency at which this recurring expense occurs.
+
+
+ℹ️ **Note:** Belvo only identifies \`MONTHLY\` frequencies.
+",
+        "type": "literal<"MONTHLY">",
+      },
       "EnumRecurringExpensePaymentType": {
         "docs": "The type of recurring expense. We return one of the following values:
 

diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/deel.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/deel.test.ts.snap
@@ -12132,7 +12132,10 @@ exports[`open api parser deel docs 1`] = `
           },
         },
       },
-      "OffCyclePaymentTypeEnum": "literal<"offcycle">",
+      "OffCyclePaymentTypeEnum": {
+        "docs": "Type for Off-cycle payments",
+        "type": "literal<"offcycle">",
+      },
       "OrganizationList": "list<BasicOrganization>",
       "OrganizationListContainer": {
         "docs": undefined,
@@ -13187,7 +13190,10 @@ exports[`open api parser deel docs 1`] = `
           "quantity": "double",
         },
       },
-      "TimesheetTypeEnum": "literal<"work">",
+      "TimesheetTypeEnum": {
+        "docs": "Type for timesheet",
+        "type": "literal<"work">",
+      },
       "TimesheetTypeEnumList": "list<TimesheetTypeEnum>",
       "UniqueObjectIdentifier": {
         "discriminated": false,
@@ -22863,7 +22869,10 @@ exports[`open api parser deel simple 1`] = `
           },
         },
       },
-      "OffCyclePaymentTypeEnum": "literal<"offcycle">",
+      "OffCyclePaymentTypeEnum": {
+        "docs": "Type for Off-cycle payments",
+        "type": "literal<"offcycle">",
+      },
       "OrganizationList": "list<BasicOrganization>",
       "OrganizationListContainer": {
         "docs": undefined,
@@ -23918,7 +23927,10 @@ exports[`open api parser deel simple 1`] = `
           "quantity": "double",
         },
       },
-      "TimesheetTypeEnum": "literal<"work">",
+      "TimesheetTypeEnum": {
+        "docs": "Type for timesheet",
+        "type": "literal<"work">",
+      },
       "TimesheetTypeEnumList": "list<TimesheetTypeEnum>",
       "UniqueObjectIdentifier": {
         "discriminated": false,