Skip to content

feat: deprecate admin.hideAPIURL #12940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+32 −2
Open

feat: deprecate admin.hideAPIURL #12940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion packages/payload/src/collections/config/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
/**
Expand Down
17 changes: 16 additions & 1 deletion packages/payload/src/globals/config/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
/**
Expand Down
Loading