Service Design Specification - Object Design for conversationMessage
clonesahibinden-conversation-service documentation
Document Overview
This document outlines the object design for the
conversationMessage model in our application. It includes
details about the model’s attributes, relationships, and any specific
validation or business logic that applies.
conversationMessage Data Object
Object Overview
Description: A single message sent between two users within a conversation about a listing. Tracks sender, receiver, timestamps and read status.
This object represents a core data structure within the service and
acts as the blueprint for database interaction, API generation, and
business logic enforcement. It is defined using the
ObjectSettings pattern, which governs its behavior,
access control, caching strategy, and integration points with other
systems such as Stripe and Redis.
Core Configuration
-
Soft Delete: Enabled — Determines whether records
are marked inactive (
isActive = false) instead of being physically deleted. - Public Access: accessPrivate — If enabled, anonymous users may access this object’s data depending on API-level rules.
Properties Schema
| Property | Type | Required | Description |
|---|---|---|---|
content |
Text | Yes | Message text body. Sanitized before saving. |
conversationThreadId |
ID | Yes | Parent thread for this message. |
isRead |
Boolean | Yes | True if the receiver has read this message. |
readAt |
Date | No | Timestamp when the receiver read the message (null if unread). |
receiverId |
ID | Yes | User receiving the message (must be the other participant of the thread). |
senderId |
ID | Yes | User sending the message (must be a participant of the thread). |
sentAt |
Date | Yes | Timestamp when message was sent. |
- Required properties are mandatory for creating objects and must be provided in the request body if no default value is set.
Default Values
Default values are automatically assigned to properties when a new object is created, if no value is provided in the request body. Since default values are applied on db level, they should be literal values, not expressions.If you want to use expressions, you can use transposed parameters in any business API to set default values dynamically.
- content: ‘text’
- conversationThreadId: ‘00000000-0000-0000-0000-000000000000’
- receiverId: ‘00000000-0000-0000-0000-000000000000’
- senderId: ‘00000000-0000-0000-0000-000000000000’
- sentAt: new Date()
Constant Properties
content conversationThreadId
receiverId senderId sentAt
Constant properties are defined to be immutable after creation,
meaning they cannot be updated or changed once set. They are typically
used for properties that should remain constant throughout the
object’s lifecycle. A property is set to be constant if the
Allow Update option is set to false.
Auto Update Properties
isRead readAt
An update crud API created with the option
Auto Params enabled will automatically update these
properties with the provided values in the request body. If you want
to update any property in your own business logic not by user input,
you can set the Allow Auto Update option to false. These
properties will be added to the update API’s body parameters and can
be updated by the user if any value is provided in the request body.
Elastic Search Indexing
content conversationThreadId
isRead readAt receiverId
senderId sentAt
Properties that are indexed in Elastic Search will be searchable via the Elastic Search API. While all properties are stored in the elastic search index of the data object, only those marked for Elastic Search indexing will be available for search queries.
Database Indexing
conversationThreadId receiverId
senderId
Properties that are indexed in the database will be optimized for query performance, allowing for faster data retrieval. Make a property indexed in the database if you want to use it frequently in query filters or sorting.
Cache Select Properties
conversationThreadId receiverId
senderId
Cache select properties are used to collect data from Redis entity cache with a different key than the data object id. This allows you to cache data that is not directly related to the data object id, but a frequently used filter.
Relation Properties
conversationThreadId receiverId
senderId
Mindbricks supports relations between data objects, allowing you to define how objects are linked together. You can define relations in the data object properties, which will be used to create foreign key constraints in the database. For complex joins operations, Mindbricks supportsa BFF pattern, where you can view dynamic and static views based on Elastic Search Indexes. Use db level relations for simple one-to-one or one-to-many relationships, and use BFF views for complex joins that require multiple data objects to be joined together.
-
conversationThreadId: ID Relation to
conversationThread.id
The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.
On Delete: Set Null Required: Yes
-
receiverId: ID Relation to
user.id
The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.
On Delete: Set Null Required: Yes
-
senderId: ID Relation to
user.id
The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.
On Delete: Set Null Required: Yes