fix: Docs for connected_account_ids (#1399)

Co-authored-by: Evan Sosenko <evan@getseam.com>
seamapi · Dec 19, 2024 · 32216c2 · 32216c2
1 parent 30f8ab6
commit 32216c2
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 20 deletions.
diff --git a/src/lib/seam/connect/models/acs/acs-system.ts b/src/lib/seam/connect/models/acs/acs-system.ts
@@ -271,13 +271,12 @@ export const acs_system = z
       .describe(
         'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
       ),
-    connected_account_ids: z.array(z.string().uuid()).describe(
-      `IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the \`acs_system\`.
-        ---
-        deprecated: Use \`connected_account_id\`.
-        ---
-        `,
-    ),
+    connected_account_ids: z.array(z.string().uuid()).describe(`
+      ---
+      deprecated: Use \`connected_account_id\`.
+      ---
+      IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the \`acs_system\`.
+      `),
     connected_account_id: z
       .string()
       .uuid()

diff --git a/src/lib/seam/connect/openapi.ts b/src/lib/seam/connect/openapi.ts
@@ -780,10 +780,12 @@ export default {
             type: 'string',
           },
           connected_account_ids: {
+            deprecated: true,
             description:
-              'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.\n---\ndeprecated: Use `connected_account_id`.\n---',
+              'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.',
             items: { format: 'uuid', type: 'string' },
             type: 'array',
+            'x-deprecated': 'Use `connected_account_id`.',
           },
           created_at: {
             description: 'Date and time at which the `acs_system` was created.',

diff --git a/src/lib/seam/connect/route-types.ts b/src/lib/seam/connect/route-types.ts
@@ -8725,9 +8725,7 @@ export interface Routes {
         /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
         workspace_id: string
         /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.
-        ---
-        deprecated: Use `connected_account_id`.
-        --- */
+         * @deprecated Use `connected_account_id`. */
         connected_account_ids: string[]
         /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
         connected_account_id: string
@@ -8898,9 +8896,7 @@ export interface Routes {
         /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
         workspace_id: string
         /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.
-        ---
-        deprecated: Use `connected_account_id`.
-        --- */
+         * @deprecated Use `connected_account_id`. */
         connected_account_ids: string[]
         /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
         connected_account_id: string
@@ -9071,9 +9067,7 @@ export interface Routes {
         /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
         workspace_id: string
         /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.
-        ---
-        deprecated: Use `connected_account_id`.
-        --- */
+         * @deprecated Use `connected_account_id`. */
         connected_account_ids: string[]
         /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
         connected_account_id: string
@@ -37903,9 +37897,7 @@ export interface Routes {
         /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
         workspace_id: string
         /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.
-        ---
-        deprecated: Use `connected_account_id`.
-        --- */
+         * @deprecated Use `connected_account_id`. */
         connected_account_ids: string[]
         /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
         connected_account_id: string