Service Design Specification - Object Design for adminModerationAction

tutorhub-platformadmin-service documentation

Document Overview

This document outlines the object design for the adminModerationAction model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.

adminModerationAction Data Object

Object Overview

Description: Action performed by an admin to moderate user, coursePack, profile, or material. All admin actions logged for audit trail. Only admins can create.

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

Composite Indexes

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: doUpdate

The existing record will be updated with the new data.No error will be thrown.

Properties Schema

Property Type Required Description
adminId ID Yes Admin performing moderation action.
targetType Enum Yes Moderation target type (user/coursePack/profile/material).
targetId ID Yes ID of moderation target object (userId, coursePackId, etc).
actionType Enum Yes Type of moderation action (suspend, ban, edit, remove, approve, warn).
actionReason String Yes Reason for moderation action, as recorded by the admin.
actionDate Date Yes Datetime when the action took place.
targetUserId ID Yes UserId of the person affected by the moderation action. For user moderation: the user being moderated. For content moderation: the tutor who owns the content.

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.

Constant Properties

adminId targetType targetId actionType actionReason actionDate targetUserId

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.

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.

Elastic Search Indexing

adminId targetType targetId actionType actionReason actionDate targetUserId

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

adminId targetType targetId actionType actionDate targetUserId

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

adminId targetUserId

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.

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

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