Skip to main content

Schema

Schema is a way to define structure of data and has the following properties:

PropertyTypeDescriptionRequired
logicalNamestringThe logical name of the schema.Yes
labelstringLabel for UI.Yes
pluralLabelstringPlural label for UI.Yes
descriptionstringDescription about the schema.No
idAttributestringThe attribute name of the primary key.Yes
primaryAttributestringThe attribute name of the primary attribute.Yes
createdAtAttributestringThe attribute name of the created at attribute.No
updatedAtAttributestringThe attribute name of the updated at attribute.No
avatarAttributestringThe attribute name of the avatar attribute.No
ownershipscoped, globalThe ownership of the schema.No
additionalMetadataRecord<string, unknown>Additional metadata.No
restrictionsRestrictionThe restrictions for operationNo
attributesRecord<string, Attribute>The attributes of the schema.Yes