fix: adds purpose field to SanityCreateOptions

sanity-io · Oct 20, 2024 · e5fd3d3 · e5fd3d3
1 parent 1352811
commit e5fd3d3
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/@sanity/types/src/schema/definition/type/common.ts b/packages/@sanity/types/src/schema/definition/type/common.ts
@@ -32,6 +32,12 @@ export type FieldGroupDefinition = {
 export interface SanityCreateOptions {
   /** Set to true to exclude a type or field from appearing in Sanity Create */
   exclude?: boolean
+
+  /**
+   * A short description of what the type or field is used for.
+   * Purpose can be used to improve how and when content mapping uses the field.
+   * */
+  purpose?: string
 }
 
 /**