payload 1.8.6 → 1.9.1

package/docs/fields/blocks.mdx

@@ -6,8 +6,11 @@ desc: The Blocks field type is a great layout build and can be used to construct
 keywords: blocks, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-<Banner >
-  The Blocks field type is <strong>incredibly powerful</strong> and can be used as a <em>layout builder</em> as well as to define any other flexible content model you can think of. It stores an array of objects, where each object must match the shape of one of your provided block configs.
+<Banner>
+  The Blocks field type is <strong>incredibly powerful</strong> and can be used
+  as a <em>layout builder</em> as well as to define any other flexible content
+  model you can think of. It stores an array of objects, where each object must
+  match the shape of one of your provided block configs.
 </Banner>
 
 **Example uses:**
@@ -17,55 +20,61 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme
 - Virtual event agenda "timeslots" where a timeslot could either be a `Break`, a `Presentation`, or a `BreakoutSession`.
 
 ![Blocks field in Payload admin panel](https://payloadcms.com/images/docs/fields/blocks.jpg)
-*Admin panel screenshot of a Blocks field type with Call to Action and Number block examples*
-
+_Admin panel screenshot of a Blocks field type with Call to Action and Number block examples_
 
 ### Field config
 
-| Option                  | Description                                                                                                                                                                                                                                                                        |
-|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** *            | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
-| **`label`**             | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                                                                                                              |
-| **`blocks`** *          | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field.                                                                                                                                                                                    |
-| **`validate`**          | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
-| **`saveToJWT`**         | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                                                                                                      |
-| **`hooks`**             | Provide field-level hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                                                                                                         |
-| **`access`**            | Provide field-level access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                                                                                                            |
-| **`hidden`**            | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API response or the Admin panel.                                                                                                                          |
-| **`defaultValue`**      | Provide an array of block data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                             |
-| **`localized`**         | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this field will be kept, so there is no need to specify each nested field as `localized`. || **`required`**       | Require this field to have a value. |
-| **`unique`**            | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                                                                                                       |
-| **`labels`**            | Customize the block row labels appearing in the Admin dashboard.                                                                                                                                                                                                                   |
-| **`admin`**             | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                                                                                          |
-| **`custom`**            | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
-
-*\* An asterisk denotes that a property is required.*
+| Option             | Description                                                                                                                                                                                                                                                                        |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------- | ----------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
+| **`label`**        | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                     |
+| **`blocks`** \*    | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field.                                                                                                                                                                                    |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                                                                                                      |
+| **`hooks`**        | Provide field-level hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                                                                                                         |
+| **`access`**       | Provide field-level access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                                                                                                            |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API response or the Admin panel.                                                                                                                          |
+| **`defaultValue`** | Provide an array of block data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                             |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this field will be kept, so there is no need to specify each nested field as `localized`. |     | **`required`** | Require this field to have a value. |
+| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                                                                                                       |
+| **`labels`**       | Customize the block row labels appearing in the Admin dashboard.                                                                                                                                                                                                                   |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                                                                                          |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
+
+_\* An asterisk denotes that a property is required._
 
 ### Admin Config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
 
-| Option                 | Description                     |
-| ---------------------- | ------------------------------- |
-| **`initCollapsed`**    | Set the initial collapsed state |
+| Option              | Description                     |
+| ------------------- | ------------------------------- |
+| **`initCollapsed`** | Set the initial collapsed state |
 
 ### Block configs
 
 Blocks are defined as separate configs of their own.
 
 <Banner type="success">
-  <strong>Tip:</strong><br />
-  Best practice is to define each block config in its own file, and then import them into your Blocks field as necessary. This way each block config can be easily shared between fields. For instance, using the "layout builder" example, you might want to feature a few of the same blocks in a Post collection as well as a Page collection. Abstracting into their own files trivializes their reusability.
+  <strong>Tip:</strong>
+  <br />
+  Best practice is to define each block config in its own file, and then import
+  them into your Blocks field as necessary. This way each block config can be
+  easily shared between fields. For instance, using the "layout builder"
+  example, you might want to feature a few of the same blocks in a Post
+  collection as well as a Page collection. Abstracting into their own files
+  trivializes their reusability.
 </Banner>
 
-| Option                     | Description                                                                                             |
-|----------------------------|---------------------------------------------------------------------------------------------------------|
-| **`slug`** *               | Identifier for this block type. Will be saved on each block as the `blockType` property.                |
-| **`fields`** *             | Array of fields to be stored in this block.                                                             |
-| **`labels`**               | Customize the block labels that appear in the Admin dashboard. Auto-generated from slug if not defined. |
-| **`imageURL`**             | Provide a custom image thumbnail to help editors identify this block in the Admin UI.                   |
-| **`imageAltText`**         | Customize this block's image thumbnail alt text.                                                        |
-| **`graphQL.singularName`** | Text to use for the GraphQL schema name. Auto-generated from slug if not defined                        |
+| Option                     | Description                                                                                                                                                                         |
+| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`slug`** \*              | Identifier for this block type. Will be saved on each block as the `blockType` property.                                                                                            |
+| **`fields`** \*            | Array of fields to be stored in this block.                                                                                                                                         |
+| **`labels`**               | Customize the block labels that appear in the Admin dashboard. Auto-generated from slug if not defined.                                                                             |
+| **`imageURL`**             | Provide a custom image thumbnail to help editors identify this block in the Admin UI.                                                                                               |
+| **`imageAltText`**         | Customize this block's image thumbnail alt text.                                                                                                                                    |
+| **`interfaceName`**        | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). |
+| **`graphQL.singularName`** | Text to use for the GraphQL schema name. Auto-generated from slug if not defined. NOTE: this is set for deprecation, prefer `interfaceName`.                                        |
 
 #### Auto-generated data per block
 
@@ -82,41 +91,44 @@ The Admin panel provides each block with a `blockName` field which optionally al
 ### Example
 
 `collections/ExampleCollection.js`
+
 ```ts
-import { Block, CollectionConfig } from 'payload/types';
+import { Block, CollectionConfig } from "payload/types";
 
 const QuoteBlock: Block = {
-  slug: 'Quote', // required
-  imageURL: 'https://google.com/path/to/image.jpg',
-  imageAltText: 'A nice thumbnail image to show what this block looks like',
-  fields: [ // required
+  slug: "Quote", // required
+  imageURL: "https://google.com/path/to/image.jpg",
+  imageAltText: "A nice thumbnail image to show what this block looks like",
+  interfaceName: "QuoteBlock", // optional
+  fields: [
+    // required
     {
-      name: 'quoteHeader',
-      type: 'text',
+      name: "quoteHeader",
+      type: "text",
       required: true,
     },
     {
-      name: 'quoteText',
-      type: 'text',
+      name: "quoteText",
+      type: "text",
     },
-  ]
+  ],
 };
 
 export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
+  slug: "example-collection",
   fields: [
     {
-      name: 'layout', // required
-      type: 'blocks', // required
+      name: "layout", // required
+      type: "blocks", // required
       minRows: 1,
       maxRows: 20,
-      blocks: [ // required
-       QuoteBlock
-      ]
-    }
-  ]
-}
-
+      blocks: [
+        // required
+        QuoteBlock,
+      ],
+    },
+  ],
+};
 ```
 
 ### TypeScript
@@ -124,6 +136,5 @@ export const ExampleCollection: CollectionConfig = {
 As you build your own Block configs, you might want to store them in separate files but retain typing accordingly. To do so, you can import and use Payload's `Block` type:
 
 ```ts
-import type { Block } from 'payload/types';
-
+import type { Block } from "payload/types";
 ```

package/docs/fields/group.mdx

@@ -6,28 +6,30 @@ desc: The Group field allows other fields to be nested under a common property.
 keywords: group, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-<Banner >
-  The Group field allows fields to be nested under a common property name. It also groups fields together visually in the Admin panel.
+<Banner>
+  The Group field allows fields to be nested under a common property name. It
+  also groups fields together visually in the Admin panel.
 </Banner>
 
 ### Config
 
-| Option           | Description |
-| ---------------- | ----------- |
-| **`name`** *         | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
-| **`fields`** *       | Array of field types to nest within this Group. |
-| **`label`**          | Used as a heading in the Admin panel and to name the generated GraphQL type. |
-| **`validate`**       | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
-| **`saveToJWT`**      | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. |
-| **`hooks`**          | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) |
-| **`access`**         | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) |
-| **`hidden`**         | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. |
-| **`defaultValue`**   | Provide an object of data to be used for this field's default value. [More](/docs/fields/overview#default-values) |
-| **`localized`**      | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Group will be kept, so there is no need to specify each nested field as `localized`. |
-| **`admin`**          | Admin-specific configuration. See below for [more detail](#admin-config). |
-| **`custom`**         | Extension point for adding custom data (e.g. for plugins) |
+| Option              | Description                                                                                                                                                                                                                                                                        |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*       | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
+| **`fields`** \*     | Array of field types to nest within this Group.                                                                                                                                                                                                                                    |
+| **`label`**         | Used as a heading in the Admin panel and to name the generated GraphQL type.                                                                                                                                                                                                       |
+| **`validate`**      | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                                                                                       |
+| **`saveToJWT`**     | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                                                                                                      |
+| **`hooks`**         | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                                                                                                         |
+| **`access`**        | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                                                                                                            |
+| **`hidden`**        | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                                                                                                   |
+| **`defaultValue`**  | Provide an object of data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                                                                                  |
+| **`localized`**     | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Group will be kept, so there is no need to specify each nested field as `localized`. |
+| **`admin`**         | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                                                                                          |
+| **`custom`**        | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                                                                          |
+| **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas).                                                                                                |
 
-*\* An asterisk denotes that a property is required.*
+_\* An asterisk denotes that a property is required._
 
 ### Admin config
 
@@ -40,32 +42,35 @@ Set this property to `true` to hide this field's gutter within the admin panel.
 ### Example
 
 `collections/ExampleCollection.ts`
+
 ```ts
-import { CollectionConfig } from 'payload/types';
+import { CollectionConfig } from "payload/types";
 
 export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
+  slug: "example-collection",
   fields: [
     {
-      name: 'pageMeta', // required
-      type: 'group', // required
-      fields: [ // required
+      name: "pageMeta", // required
+      type: "group", // required
+      interfaceName: "Meta", // optional
+      fields: [
+        // required
         {
-          name: 'title',
-          type: 'text',
+          name: "title",
+          type: "text",
           required: true,
           minLength: 20,
           maxLength: 100,
         },
         {
-          name: 'description',
-          type: 'textarea',
+          name: "description",
+          type: "textarea",
           required: true,
           minLength: 40,
           maxLength: 160,
-        }
+        },
       ],
-    }
-  ]
+    },
+  ],
 };
 ```

package/docs/fields/tabs.mdx

@@ -6,71 +6,78 @@ desc: The Tabs field is a great way to organize complex editing experiences into
 keywords: tabs, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-<Banner >
-  The Tabs field is presentational-only and only affects the Admin panel (unless a tab is named). By using it, you can place fields within a nice layout component that separates certain sub-fields by a tabbed interface.
+<Banner>
+  The Tabs field is presentational-only and only affects the Admin panel (unless
+  a tab is named). By using it, you can place fields within a nice layout
+  component that separates certain sub-fields by a tabbed interface.
 </Banner>
 
 ![Tabs field type used to separate Hero fields from Page Layout](https://payloadcms.com/images/docs/fields/tabs/tabs.jpg)
-*Tabs field type used to separate Hero fields from Page Layout*
+_Tabs field type used to separate Hero fields from Page Layout_
 
 ### Config
 
-| Option           | Description |
-| ---------------- | ----------- |
-| **`tabs`** *     | Array of tabs to render within this Tabs field. |
-| **`admin`**      | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
-| **`custom`**     | Extension point for adding custom data (e.g. for plugins) |
+| Option        | Description                                                                                                              |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| **`tabs`** \* | Array of tabs to render within this Tabs field.                                                                          |
+| **`admin`**   | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
+| **`custom`**  | Extension point for adding custom data (e.g. for plugins)                                                                |
 
 #### Tab-specific Config
 
 Each tab has its own required `label` and `fields` array. You can also optionally pass a `description` to render within each individual tab.
 
-| Option            | Description |
-| ----------------- | ----------- |
-| **`name`**        | An optional property name to be used when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
-| **`label`** *     | The label to render on the tab itself. |
-| **`fields`** *    | The fields to render within this tab. |
-| **`description`** | Optionally render a description within this tab to describe the contents of the tab itself. |
+| Option              | Description                                                                                                                                                                                                  |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`name`**          | An optional property name to be used when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                  |
+| **`label`** \*      | The label to render on the tab itself.                                                                                                                                                                       |
+| **`fields`** \*     | The fields to render within this tab.                                                                                                                                                                        |
+| **`description`**   | Optionally render a description within this tab to describe the contents of the tab itself.                                                                                                                  |
+| **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). (`name` must be present) |
 
-*\* An asterisk denotes that a property is required.*
+_\* An asterisk denotes that a property is required._
 
 ### Example
 
 `collections/ExampleCollection.ts`
+
 ```ts
-import { CollectionConfig } from 'payload/types';
+import { CollectionConfig } from "payload/types";
 
 export const ExampleCollection: CollectionConfig = {
-  slug: 'example-collection',
+  slug: "example-collection",
   fields: [
     {
-      type: 'tabs', // required
-      tabs: [ // required
+      type: "tabs", // required
+      tabs: [
+        // required
         {
-          label: 'Tab One Label', // required
-          description: 'This will appear within the tab above the fields.',
-          fields: [ // required
+          label: "Tab One Label", // required
+          description: "This will appear within the tab above the fields.",
+          fields: [
+            // required
             {
-              name: 'someTextField',
-              type: 'text',
+              name: "someTextField",
+              type: "text",
               required: true,
             },
           ],
         },
         {
-          name: 'tabTwo',
-          label: 'Tab Two Label', // required
-          fields: [ // required
+          name: "tabTwo",
+          label: "Tab Two Label", // required
+          interfaceName: "TabTwo", // optional (`name` must be present)
+          fields: [
+            // required
             {
-              name: 'numberField', // accessible via tabTwo.numberField
-              type: 'number',
+              name: "numberField", // accessible via tabTwo.numberField
+              type: "number",
               required: true,
             },
           ],
-        }
-      ]
-
-    }
-  ]
-}
+        },
+      ],
+    },
+  ],
+};
 ```

package/docs/graphql/graphql-schema.mdx

@@ -8,7 +8,7 @@ keywords: headless cms, typescript, documentation, Content Management System, cm
 
 When working with GraphQL it is useful to have the schema for development of other projects that need to call on your GraphQL endpoint. In Payload the schema is controlled by your collections and globals and is made available to the developer or third parties, it is not necessary for developers using Payload to write schema types manually.
 
-### GraphQL Schema generate script
+### Schema generatation script
 
 Run the following command in a Payload project to generate your project's GraphQL schema from Payload:
 
@@ -16,9 +16,9 @@ Run the following command in a Payload project to generate your project's GraphQ
 payload generate:graphQLSchema
 ```
 
-You can run this command whenever you need to regenerate your graphQL schema and output it to a file, and then you can use the schema for writing your own graphQL elsewhere in other projects.
+You can run this command whenever you need to regenerate your GraphQL schema and output it to a file, and then you can use the schema for writing your own GraphQL elsewhere in other projects.
 
-### GraphQL schema output file
+### Custom output file path
 
 ```js
 {
@@ -29,12 +29,51 @@ You can run this command whenever you need to regenerate your graphQL schema and
 }
 ```
 
+### Custom Field Schemas
+
+For `array`, `block`, `group` and named `tab` fields, you can generate top level reusable interfaces. The following group field config:
+
+```ts
+{
+  type: 'group',
+  name: 'meta',
+  interfaceName: 'SharedMeta', <-- here!!
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+    },
+    {
+      name: 'description',
+      type: 'text',
+    },
+  ],
+}
+```
+
+will generate:
+
+```ts
+// a top level reusable type!!
+type SharedMeta {
+  title: String
+  description: String
+}
+
+// example usage inside collection schema
+type Collection1 {
+  // ...other fields
+  meta: SharedMeta
+}
+```
+
 The above example outputs all your definitions to a file relative from your payload config as `./graphql/schema.graphql`. By default, the file will be output to your current working directory as `schema.graphql`.
 
 #### Adding an NPM script
 
 <Banner type="warning">
-  <strong>Important:</strong><br/>
+  <strong>Important</strong>
+  <br />
   Payload needs to be able to find your config to generate your GraphQL schema.
 </Banner>
 
@@ -45,8 +84,8 @@ To add an NPM script to generate your types and show Payload where to find your
 ```json
 {
   "scripts": {
-    "generate:graphQLSchema": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema",
-  },
+    "generate:graphQLSchema": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema"
+  }
 }
 ```
 

package/docs/graphql/overview.mdx

@@ -16,13 +16,13 @@ The labels you provide for your Collections and Globals are used to name the Gra
 
 At the top of your Payload config you can define all the options to manage GraphQL.
 
-| Option               | Description  |
-| -------------------- | -------------|
-| `mutations`                     | Any custom Mutations to be added in addition to what Payload provides. [More](/docs/graphql/extending) |
-| `queries`                       | Any custom Queries to be added in addition to what Payload provides. [More](/docs/graphql/extending) |
-| `maxComplexity`                 | A number used to set the maximum allowed complexity allowed by requests [More](/docs/graphql/overview#query-complexity-limits) |
-| `disablePlaygroundInProduction` | A boolean that if false will enable the graphQL playground, defaults to true. [More](/docs/graphql/overview#graphql-playground) |
-| `disable`                       | A boolean that if true will disable the graphQL entirely, defaults to false. |
+| Option                          | Description                                                                                                                                                   |
+| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `mutations`                     | Any custom Mutations to be added in addition to what Payload provides. [More](/docs/graphql/extending)                                                        |
+| `queries`                       | Any custom Queries to be added in addition to what Payload provides. [More](/docs/graphql/extending)                                                          |
+| `maxComplexity`                 | A number used to set the maximum allowed complexity allowed by requests [More](/docs/graphql/overview#query-complexity-limits)                                |
+| `disablePlaygroundInProduction` | A boolean that if false will enable the GraphQL playground, defaults to true. [More](/docs/graphql/overview#graphql-playground)                               |
+| `disable`                       | A boolean that if true will disable the GraphQL entirely, defaults to false.                                                                                  |
 | `schemaOutputFile`              | A string for the file path used by the generate schema command. Defaults to `graphql.schema` next to `payload.config.ts` [More](/docs/graphql/graphql-schema) |
 
 ## Collections
@@ -43,26 +43,26 @@ export const PublicUser: CollectionConfig = {
 
 **Payload will automatically open up the following queries:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`PublicUser`**       | `findByID` |
-| **`PublicUsers`**      | `find` |
-| **`mePublicUser`**     | `me` auth operation |
+| Query Name         | Operation           |
+| ------------------ | ------------------- |
+| **`PublicUser`**   | `findByID`          |
+| **`PublicUsers`**  | `find`              |
+| **`mePublicUser`** | `me` auth operation |
 
 **And the following mutations:**
 
-| Query Name                     | Operation    |
-| ------------------------------ | -------------|
-| **`createPublicUser`**         | `create` |
-| **`updatePublicUser`**         | `update` |
-| **`deletePublicUser`**         | `delete` |
+| Query Name                     | Operation                       |
+| ------------------------------ | ------------------------------- |
+| **`createPublicUser`**         | `create`                        |
+| **`updatePublicUser`**         | `update`                        |
+| **`deletePublicUser`**         | `delete`                        |
 | **`forgotPasswordPublicUser`** | `forgotPassword` auth operation |
-| **`resetPasswordPublicUser`**  | `resetPassword` auth operation |
-| **`unlockPublicUser`**         | `unlock` auth operation |
-| **`verifyPublicUser`**         | `verify` auth operation |
-| **`loginPublicUser`**          | `login` auth operation |
-| **`logoutPublicUser`**         | `logout` auth operation |
-| **`refreshTokenPublicUser`**   | `refresh` auth operation |
+| **`resetPasswordPublicUser`**  | `resetPassword` auth operation  |
+| **`unlockPublicUser`**         | `unlock` auth operation         |
+| **`verifyPublicUser`**         | `verify` auth operation         |
+| **`loginPublicUser`**          | `login` auth operation          |
+| **`logoutPublicUser`**         | `logout` auth operation         |
+| **`refreshTokenPublicUser`**   | `refresh` auth operation        |
 
 ## Globals
 
@@ -81,32 +81,32 @@ const Header: GlobalConfig = {
 
 **Payload will open the following query:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`Header`**           | `findOne`    |
+| Query Name   | Operation |
+| ------------ | --------- |
+| **`Header`** | `findOne` |
 
 **And the following mutation:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`updateHeader`**     | `update`     |
+| Query Name         | Operation |
+| ------------------ | --------- |
+| **`updateHeader`** | `update`  |
 
 ## Preferences
 
-User [preferences](/docs/admin/overview#preferences)  for the admin panel are also available to GraphQL. To query preferences you must supply an authorization token in the header and only the preferences of that user will be accessible and of the `key` argument.
+User [preferences](/docs/admin/overview#preferences) for the admin panel are also available to GraphQL. To query preferences you must supply an authorization token in the header and only the preferences of that user will be accessible and of the `key` argument.
 
 **Payload will open the following query:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`Preference`**       | `findOne`    |
+| Query Name       | Operation |
+| ---------------- | --------- |
+| **`Preference`** | `findOne` |
 
 **And the following mutations:**
 
-| Query Name             | Operation    |
-| ---------------------- | -------------|
-| **`updatePreference`** | `update`     |
-| **`deletePreference`** | `delete`     |
+| Query Name             | Operation |
+| ---------------------- | --------- |
+| **`updatePreference`** | `update`  |
+| **`deletePreference`** | `delete`  |
 
 ## GraphQL Playground
 
@@ -115,8 +115,16 @@ GraphQL Playground is enabled by default for development purposes, but disabled
 You can even log in using the `login[collection-singular-label-here]` mutation to use the Playground as an authenticated user.
 
 <Banner type="success">
-  <strong>Tip:</strong><br/>
-  To see more regarding how the above queries and mutations are used, visit your GraphQL playground (by default at <a href="http://localhost:3000/api/graphql-playground">(http://localhost:3000/api/graphql-playground</a>) while your server is running. There, you can use the "Schema" and "Docs" buttons on the right to see a ton of detail about how GraphQL operates within Payload.
+  <strong>Tip:</strong>
+  <br />
+  To see more regarding how the above queries and mutations are used, visit your
+  GraphQL playground (by default at{" "}
+  <a href="http://localhost:3000/api/graphql-playground">
+    (http://localhost:3000/api/graphql-playground
+  </a>
+  ) while your server is running. There, you can use the "Schema" and "Docs"
+  buttons on the right to see a ton of detail about how GraphQL operates within
+  Payload.
 </Banner>
 
 ## Query complexity limits