From 475fac485d48b858ad7ee4abd6eb42b91762028e Mon Sep 17 00:00:00 2001 From: Jacob Fletcher Date: Wed, 25 Jun 2025 13:26:59 -0400 Subject: [PATCH] feat: deprecate admin.hideAPIURL --- .../payload/src/collections/config/types.ts | 17 ++++++++++++++++- packages/payload/src/globals/config/types.ts | 17 ++++++++++++++++- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/packages/payload/src/collections/config/types.ts b/packages/payload/src/collections/config/types.ts index 43f80ae91dd..9d1dec286d8 100644 --- a/packages/payload/src/collections/config/types.ts +++ b/packages/payload/src/collections/config/types.ts @@ -371,7 +371,22 @@ export type CollectionAdminOptions = { */ hidden?: ((args: { user: ClientUser }) => boolean) | boolean /** - * Hide the API URL within the Edit view + * @deprecated This will be removed in v4. Use the `condition` property on the API view instead. + * @example + * ```ts + * export const MyCollection: CollectionConfig = { + * // ... + * admin: { + * views: { + * edit: { + * api: { + * condition: () => false + * }, + * } + * } + * } + * } + * ``` */ hideAPIURL?: boolean /** diff --git a/packages/payload/src/globals/config/types.ts b/packages/payload/src/globals/config/types.ts index 3bd91c5775a..2b0bbf92957 100644 --- a/packages/payload/src/globals/config/types.ts +++ b/packages/payload/src/globals/config/types.ts @@ -135,7 +135,22 @@ export type GlobalAdminOptions = { */ hidden?: ((args: { user: PayloadRequest['user'] }) => boolean) | boolean /** - * Hide the API URL within the Edit View + * @deprecated This will be removed in v4. Use the `condition` property on the API view instead. + * @example + * ```ts + * export const MyGlobal: GlobalConfig = { + * // ... + * admin: { + * views: { + * edit: { + * api: { + * condition: () => false + * }, + * } + * } + * } + * } + * ``` */ hideAPIURL?: boolean /**