Service Design Specification - Object Design for connectionRequest
linkedin-networking-service documentation
Document Overview
This document outlines the object design for the connectionRequest model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.
connectionRequest Data Object
Object Overview
Description: Tracks a user's request to connect with another user, supporting request/accept/reject/cancel, with audit timestamps.
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.
Composite Indexes
- uniqueConnectionRequestPair: [senderUserId, receiverUserId] This composite index is defined to optimize query performance for complex queries involving multiple fields.
The index also defines a conflict resolution strategy for duplicate key violations.
When a new record would violate this composite index, the following action will be taken:
On Duplicate: throwError
An error will be thrown, preventing the insertion of conflicting data.
Properties Schema
| Property | Type | Required | Description |
|---|---|---|---|
receiverUserId |
ID | Yes | - |
senderUserId |
ID | Yes | - |
sentAt |
Date | Yes | - |
status |
Enum | Yes | - |
respondedAt |
Date | No | - |
message |
String | No | - |
- 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.
- receiverUserId: ‘00000000-0000-0000-0000-000000000000’
- senderUserId: ‘00000000-0000-0000-0000-000000000000’
- sentAt: new Date()
- status: pending
Constant Properties
receiverUserId senderUserId sentAt message
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
status respondedAt
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.
Enum Properties
Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an addtional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the index property to sort by the enum value or when your enum options represent a sequence of values.
- status: [pending, accepted, rejected]
Elastic Search Indexing
receiverUserId senderUserId sentAt status respondedAt message
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
receiverUserId senderUserId sentAt status
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
receiverUserId senderUserId status
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
receiverUserId senderUserId
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.
- receiverUserId: 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
- senderUserId: 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
Session Data Properties
senderUserId
Session data properties are used to store data that is specific to the user session, allowing for personalized experiences and temporary data storage. If a property is configured as session data, it will be automatically mapped to the related field in the user session during CRUD operations. Note that session data properties can not be mutated by the user, but only by the system.
- senderUserId: ID property will be mapped to the session parameter
userId.
Formula Properties
sentAt
Formula properties are used to define calculated fields that derive their values from other properties or external data. These properties are automatically calculated based on the defined formula and can be used for dynamic data retrieval.
- sentAt: Date
-
Formula:
new Date() -
Calculate After Instance: No
-
Filter Properties
status
Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API’s that have “Auto Params” enabled.
- status: Enum has a filter named
status