feat: throw error on reservated field names

gatsbyjs · May 17, 2022 · 8aa8f20 · 8aa8f20
1 parent 37f652d
commit 8aa8f20
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/gatsby-source-contentful/src/create-schema-customization.js b/packages/gatsby-source-contentful/src/create-schema-customization.js
@@ -527,6 +527,13 @@ export async function createSchemaCustomization(
         if (field.disabled || field.omitted) {
           return
         }
+        if ([`id`, `sys`, `contentfulMetadata`].includes(field.id)) {
+          // Throw error on reserved field names as the Contenful GraphQL API does:
+          // https://www.contentful.com/developers/docs/references/graphql/#/reference/schema-generation/fields
+          throw new Error(
+            `Unfortunately the field name ${field.id} is reserved. ${contentTypeItem.name}@${contentTypeItem.sys.id}`
+          )
+        }
         fields[field.id] = translateFieldType(field, schema, createTypes)
       })