Sanity Library Reference Docs
    Preparing search index...

    Interface BlueprintContentResourceConfigBeta

    Configuration for a content resource: a custom permission of type sanity.document.filter.mode, as the Manage UI makes it. This feature is subject to breaking changes.

    interface BlueprintContentResourceConfig {
        description?: string;
        documentTypes?: string[];
        filter?: string;
        name: string;
        project?: string;
        title?: string;
    }

    Hierarchy

    Index

    Properties

    description? documentTypes? filter? name project? title?

    Properties

    description?: string

    A description of the permission. Defaults to an empty string.

    documentTypes?: string[]

    The document types that the content resource applies to. Omit to apply to documents of any type.

    filter?: string

    A GROQ filter that selects documents, e.g. branch == "london". It is joined to documentTypes with &&.

    name: string

    The name of the permission.

    Lowercase letters, numbers, hyphens, and underscores only. Must not start with sanity or res-.

    project?: string

    The project ID of the project that contains the permission.

    The project attribute must be defined if your blueprint is scoped to an organization and the stack has no default project.

    title?: string

    A human-readable title. Defaults to name.

    Settings

    Member Visibility

    On This Page

    Properties