Service Design Specification - Object Design for suspensionRecord
auteurlabb-moderationadmin-service documentation
Document Overview
This document outlines the object design for the suspensionRecord model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.
suspensionRecord Data Object
Object Overview
Description: Admin action to suspend or lift suspension on a user. Each record logs a suspension/lift action for audit/compliance.
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 |
|---|---|---|---|
userId |
ID | Yes | Suspended user id |
reason |
String | Yes | Reason for suspension action |
suspendedByUserId |
ID | Yes | Admin ID who performed the suspension action |
suspendedAt |
Date | Yes | Time of action (suspend/lift) |
status |
Enum | Yes | Current state: active (suspended), lifted (reinstated) |
- 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.
- userId: ‘00000000-0000-0000-0000-000000000000’
- reason: ‘default’
- suspendedByUserId: ‘00000000-0000-0000-0000-000000000000’
- suspendedAt: new Date()
- status: active
Always Create with Default Values
Some of the default values are set to be always used when creating a new object, even if the property value is provided in the request body. It ensures that the property is always initialized with a default value when the object is created.
- status: Will be created with value
active
Constant Properties
userId reason suspendedByUserId suspendedAt status
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
userId reason suspendedByUserId suspendedAt status
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: [active, lifted]
Elastic Search Indexing
userId suspendedByUserId suspendedAt status
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
userId suspendedByUserId 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.
Relation Properties
userId suspendedByUserId
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.
- userId: 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
- suspendedByUserId: 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