fix(types): update branching types for api route changes (#38548)

Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>

apps/studio/data/branches/branch-delete-mutation.ts

@@ -12,8 +12,8 @@ export type BranchDeleteVariables = {
 }
 
 export async function deleteBranch({ id }: Pick<BranchDeleteVariables, 'id'>) {
-  const { data, error } = await del('/v1/branches/{branch_id}', {
-    params: { path: { branch_id: id } },
+  const { data, error } = await del('/v1/branches/{branch_id_or_ref}', {
+    params: { path: { branch_id_or_ref: id } },
   })
 
   if (error) handleError(error)

apps/studio/data/branches/branch-diff-query.ts

@@ -15,9 +15,9 @@ export async function getBranchDiff({
   branchId,
   includedSchemas,
 }: Pick<BranchDiffVariables, 'branchId' | 'includedSchemas'>) {
-  const { data: diffData, error } = await get('/v1/branches/{branch_id}/diff', {
+  const { data: diffData, error } = await get('/v1/branches/{branch_id_or_ref}/diff', {
     params: {
-      path: { branch_id: branchId },
+      path: { branch_id_or_ref: branchId },
       query: includedSchemas ? { included_schemas: includedSchemas } : undefined,
     },
     headers: {

apps/studio/data/branches/branch-merge-mutation.ts

@@ -17,7 +17,6 @@ export type BranchMergeVariables = {
 export async function mergeBranch({
   id,
   branchProjectRef,
-  baseProjectRef,
   migration_version,
 }: BranchMergeVariables) {
   // Step 1: Get the diff output from the branch
@@ -41,8 +40,8 @@ export async function mergeBranch({
   }
 
   // Step 3: Call POST /v1/branches/id/merge to merge the branch
-  const { data, error } = await post('/v1/branches/{branch_id}/merge', {
-    params: { path: { branch_id: id } },
+  const { data, error } = await post('/v1/branches/{branch_id_or_ref}/merge', {
+    params: { path: { branch_id_or_ref: id } },
     body: { migration_version },
   })
 

apps/studio/data/branches/branch-push-mutation.ts

@@ -11,8 +11,8 @@ export type BranchPushVariables = {
 }
 
 export async function pushBranch({ id }: Pick<BranchPushVariables, 'id'>) {
-  const { data, error } = await post('/v1/branches/{branch_id}/push', {
-    params: { path: { branch_id: id } },
+  const { data, error } = await post('/v1/branches/{branch_id_or_ref}/push', {
+    params: { path: { branch_id_or_ref: id } },
     body: {},
   })
 

apps/studio/data/branches/branch-query.ts

@@ -13,8 +13,8 @@ export type BranchVariables = {
 export async function getBranch({ id }: BranchVariables, signal?: AbortSignal) {
   if (!id) throw new Error('id is required')
 
-  const { data, error } = await get(`/v1/branches/{branch_id}`, {
-    params: { path: { branch_id: id } },
+  const { data, error } = await get(`/v1/branches/{branch_id_or_ref}`, {
+    params: { path: { branch_id_or_ref: id } },
     signal,
   })
 

apps/studio/data/branches/branch-reset-mutation.ts

@@ -11,8 +11,8 @@ export type BranchResetVariables = {
 }
 
 export async function resetBranch({ id }: Pick<BranchResetVariables, 'id'>) {
-  const { data, error } = await post('/v1/branches/{branch_id}/reset', {
-    params: { path: { branch_id: id } },
+  const { data, error } = await post('/v1/branches/{branch_id_or_ref}/reset', {
+    params: { path: { branch_id_or_ref: id } },
     body: {},
   })
 

apps/studio/data/branches/branch-update-mutation.ts

@@ -21,9 +21,9 @@ export async function updateBranch({
   persistent,
   requestReview,
 }: BranchUpdateVariables) {
-  const { data, error } = await patch('/v1/branches/{branch_id}', {
+  const { data, error } = await patch('/v1/branches/{branch_id_or_ref}', {
     params: {
-      path: { branch_id: id },
+      path: { branch_id_or_ref: id },
     },
     body: {
       branch_name: branchName,

apps/ui-library/registry/default/platform/platform-kit-nextjs/lib/management-api-schema.d.ts

@@ -4,7 +4,7 @@
  */
 
 export interface paths {
-  '/v1/branches/{branch_id}': {
+  '/v1/branches/{branch_id_or_ref}': {
     parameters: {
       query?: never
       header?: never
@@ -32,7 +32,7 @@ export interface paths {
     patch: operations['v1-update-a-branch-config']
     trace?: never
   }
-  '/v1/branches/{branch_id}/push': {
+  '/v1/branches/{branch_id_or_ref}/push': {
     parameters: {
       query?: never
       header?: never
@@ -52,7 +52,7 @@ export interface paths {
     patch?: never
     trace?: never
   }
-  '/v1/branches/{branch_id}/merge': {
+  '/v1/branches/{branch_id_or_ref}/merge': {
     parameters: {
       query?: never
       header?: never
@@ -72,7 +72,7 @@ export interface paths {
     patch?: never
     trace?: never
   }
-  '/v1/branches/{branch_id}/reset': {
+  '/v1/branches/{branch_id_or_ref}/reset': {
     parameters: {
       query?: never
       header?: never
@@ -92,7 +92,7 @@ export interface paths {
     patch?: never
     trace?: never
   }
-  '/v1/branches/{branch_id}/diff': {
+  '/v1/branches/{branch_id_or_ref}/diff': {
     parameters: {
       query?: never
       header?: never

packages/api-types/types/api.d.ts

@@ -4,7 +4,7 @@
  */
 
 export interface paths {
-  '/v1/branches/{branch_id}': {
+  '/v1/branches/{branch_id_or_ref}': {
     parameters: {
       query?: never
       header?: never
@@ -32,7 +32,7 @@ export interface paths {
     patch: operations['v1-update-a-branch-config']
     trace?: never
   }
-  '/v1/branches/{branch_id}/diff': {
+  '/v1/branches/{branch_id_or_ref}/diff': {
     parameters: {
       query?: never
       header?: never
@@ -52,7 +52,7 @@ export interface paths {
     patch?: never
     trace?: never
   }
-  '/v1/branches/{branch_id}/merge': {
+  '/v1/branches/{branch_id_or_ref}/merge': {
     parameters: {
       query?: never
       header?: never
@@ -72,7 +72,7 @@ export interface paths {
     patch?: never
     trace?: never
   }
-  '/v1/branches/{branch_id}/push': {
+  '/v1/branches/{branch_id_or_ref}/push': {
     parameters: {
       query?: never
       header?: never
@@ -92,7 +92,7 @@ export interface paths {
     patch?: never
     trace?: never
   }
-  '/v1/branches/{branch_id}/reset': {
+  '/v1/branches/{branch_id_or_ref}/reset': {
     parameters: {
       query?: never
       header?: never
@@ -1513,23 +1513,6 @@ export interface paths {
     patch?: never
     trace?: never
   }
-  '/v1/projects/{ref}/storage/buckets/{id}/objects': {
-    parameters: {
-      query?: never
-      header?: never
-      path?: never
-      cookie?: never
-    }
-    get?: never
-    put?: never
-    /** Gets list of objects with the given bucket */
-    post: operations['v1-list-storage-objects']
-    delete?: never
-    options?: never
-    head?: never
-    patch?: never
-    trace?: never
-  }
   '/v1/projects/{ref}/types/typescript': {
     parameters: {
       query?: never
@@ -2843,7 +2826,13 @@ export interface components {
     }
     RemoveNetworkBanRequest: {
       identifier?: string
+      /** @description List of IP addresses to unban. */
       ipv4_addresses: string[]
+      /**
+       * @description Include requester's public IP in the list of addresses to unban.
+       * @default false
+       */
+      requester_ip?: boolean
     }
     RemoveReadReplicaBody: {
       database_identifier: string
@@ -3568,43 +3557,6 @@ export interface components {
       name?: string
       version: string
     }[]
-    V1ListStorageObjectsBody: {
-      options?: {
-        limit?: number
-        offset?: number
-        search?: string
-        sort_by?: string
-        /** @enum {string} */
-        sort_order?: 'asc' | 'desc'
-      }
-      path?: string
-    }
-    V1ListStorageObjectsResponse: {
-      items: {
-        bucket_id: string
-        buckets: {
-          allowed_mime_types?: string[]
-          created_at: string
-          file_size_limit?: number
-          id: string
-          name: string
-          owner: string
-          public: boolean
-          /** @enum {string} */
-          type?: 'STANDARD' | 'ANALYTICS'
-          updated_at: string
-        }
-        created_at: string
-        id: string
-        last_accessed_at: string
-        metadata: {
-          [key: string]: unknown
-        }
-        name: string
-        owner: string
-        updated_at: string
-      }[]
-    }
     V1OrganizationMemberResponse: {
       email?: string
       mfa_enabled: boolean
@@ -3875,7 +3827,7 @@ export interface operations {
       header?: never
       path: {
         /** @description Branch ID */
-        branch_id: string
+        branch_id_or_ref: string
       }
       cookie?: never
     }
@@ -3904,7 +3856,7 @@ export interface operations {
       header?: never
       path: {
         /** @description Branch ID */
-        branch_id: string
+        branch_id_or_ref: string
       }
       cookie?: never
     }
@@ -3933,7 +3885,7 @@ export interface operations {
       header?: never
       path: {
         /** @description Branch ID */
-        branch_id: string
+        branch_id_or_ref: string
       }
       cookie?: never
     }
@@ -3968,7 +3920,7 @@ export interface operations {
       header?: never
       path: {
         /** @description Branch ID */
-        branch_id: string
+        branch_id_or_ref: string
       }
       cookie?: never
     }
@@ -3997,7 +3949,7 @@ export interface operations {
       header?: never
       path: {
         /** @description Branch ID */
-        branch_id: string
+        branch_id_or_ref: string
       }
       cookie?: never
     }
@@ -4030,7 +3982,7 @@ export interface operations {
       header?: never
       path: {
         /** @description Branch ID */
-        branch_id: string
+        branch_id_or_ref: string
       }
       cookie?: never
     }
@@ -4063,7 +4015,7 @@ export interface operations {
       header?: never
       path: {
         /** @description Branch ID */
-        branch_id: string
+        branch_id_or_ref: string
       }
       cookie?: never
     }
@@ -6955,6 +6907,13 @@ export interface operations {
           'application/json': components['schemas']['BulkUpdateFunctionResponse']
         }
       }
+      /** @description Maximum number of functions reached for Plan */
+      402: {
+        headers: {
+          [name: string]: unknown
+        }
+        content?: never
+      }
       403: {
         headers: {
           [name: string]: unknown
@@ -7005,6 +6964,13 @@ export interface operations {
           'application/json': components['schemas']['FunctionResponse']
         }
       }
+      /** @description Maximum number of functions reached for Plan */
+      402: {
+        headers: {
+          [name: string]: unknown
+        }
+        content?: never
+      }
       403: {
         headers: {
           [name: string]: unknown
@@ -7209,6 +7175,13 @@ export interface operations {
           'application/json': components['schemas']['DeployFunctionResponse']
         }
       }
+      /** @description Maximum number of functions reached for Plan */
+      402: {
+        headers: {
+          [name: string]: unknown
+        }
+        content?: never
+      }
       403: {
         headers: {
           [name: string]: unknown
@@ -8105,47 +8078,6 @@ export interface operations {
       }
     }
   }
-  'v1-list-storage-objects': {
-    parameters: {
-      query?: never
-      header?: never
-      path: {
-        /** @description Storage bucket id */
-        id: string
-        /** @description Project ref */
-        ref: string
-      }
-      cookie?: never
-    }
-    requestBody: {
-      content: {
-        'application/json': components['schemas']['V1ListStorageObjectsBody']
-      }
-    }
-    responses: {
-      200: {
-        headers: {
-          [name: string]: unknown
-        }
-        content: {
-          'application/json': components['schemas']['V1ListStorageObjectsResponse']
-        }
-      }
-      403: {
-        headers: {
-          [name: string]: unknown
-        }
-        content?: never
-      }
-      /** @description Failed to get list of objects with the given bucket */
-      500: {
-        headers: {
-          [name: string]: unknown
-        }
-        content?: never
-      }
-    }
-  }
   'v1-generate-typescript-types': {
     parameters: {
       query?: {