Yasmine's project fields

db-fields.yml

#### Models
user:
    fields:
        id:
            type: string
            required: true
        requestType: 
            type: string
            enum: [first-user, new-user, client-vip]
            required: true
        clientType:
            type: string
            enum: [vip, client]
            required: true
        professionalStatus:
            type: string
            required: true
        isUniversityStaff:
            type: boolean
            required: true
        status:
            type: string
            enum: [Sir, Mrs, Miss]
            required: true
        sex: 
            type: string
            enum: [M, F]
            required: true
        dob:
            type: string
            required: true
        firstName:
            type: string
            required: true
        familyName:
            type: string
            required: true
        maidenName:
            type: string
            required: false
        stateOfBirthInUsa:
            type: string
            required: true
        stateOfBirthOutsideUsa:
            type: string
            required: true
        countryOfbirth:
            type: string
            required: true
            format: ISO "ALPHA-2 Code e.g US, NG, IN, ...
        fullNames:
            type: string
            required: true
        address:
            type: string
            required: true
        firstAddressFloor:
            type: string
            required: true
        firstAddressBuildingNumber:
            type: string
            required: true
        firstAddressBoulevard:
            type: string
            required: true
        firstAddressPostalCode:
            type: string
            required: true
        firstAddressState:
            type: string
            required: true
        firstAddressState:
            type: string
            required: true
        firstAddressCountry:
            type: string
            required: true
            format: ISO "ALPHA-2 Code e.g US, NG, IN, ...
        secondAddressFloor:
            type: string
            required: false
        secondAddressBuildingNumber:
            type: string
            required: false
        secondAddressBoulevard:
            type: string
            required: true
        secondAddressPostalCode:
            type: string
            required: false
        secondAddressState:
            type: string
            required: false
        secondAddressState:
            type: string
            required: false
        secondAddressCountry:
            type: string
            required: false
            format: ISO "ALPHA-2 Code e.g US, NG, IN, ...
        phoneType:
            type: string
            required: false
            enum: [mobile, home]
        email:
            type: string
            required: false
        phoneNumber:
            type: string
            required: false
        fax:
            type: string
            required: false
        authQuestionOne:
            type: string
            required: true
            enum: [singleMotherName, favoriteSport, firstSchool, firstCarModel]
        authQuestionTwo:
            type: string
            required: true
            enum: [singleMotherName, favoriteSport, firstSchool, firstCarModel]
        authQuestionOneAnswer:
            type: string
            required: true
        authQuestionTwoAnswer:
            type: string
            required: true
        offersList:
            type: array
            description: Array of objects. Each object in the list is an instance or mock of the service model
            children:
                type: object
                model: service



request:
    fields:
        id:
            type: string
            required: true
        appId:
            type: string
            required: true
        name:
            type: string
            required: true
        environment:
            type: string
            required: false
        remarks:
            type: string
            required: false
        status:
            type: string
            required: false
            enum: [saved, sent]
        students:
            type: array
            required: false
            description: Array of objects. Each object in the list is an instance of the user model
            children:
                type: object
                model: user



service:
    fields:
        service:
            type: string
            required: true
        details:
            type: string
            required: true
        amount:
            type: float
            required: true
        comment:
            type: string
            required: false
        remarks:
            type: string
            required: false
        charges: 
            type: string
            required: false
        sold:
            type: string
            required: false
        totalAmount:
            type: float
            required: false