2024-02-09 - Per Service Schemas Docs

Per Service Schemas
Describe object schema design and workflow.

Schema Description

• objectSchema is an object that shows data models in service.
• relationshipSchema is an object that describes a relation between objectSchema.
• refRelationshipSchema is an object that references to relationshipSchema in another service

Rules for creating objectSchema

• Don’t have duplicate fieldName
• FieldName in identifier should exist in objectSchema.fieldNames
• Don’t have duplicate tableName in storageResources.type dynamoDB of objectSchema

Rules for creating addOnDatastructure:versionedData

• Don’t have duplicate versionedData.versionedDataLabel in addOnDataStructure
• Don’t have duplicate fieldName with objectSchema and other versionedData

Per service scripts and lambda for schema

• npm run generateCode
  • generate lambda in the local computer
• npm run validateSchema
  • validate schema in the local computer
• lambda: UploadSchemaHdrInv
  • use to upload schema to s3 after deploy.