Service Design Specification - Object Design for adminActionLog

clonesahibinden-adminmoderation-service documentation

Document Overview

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

adminActionLog Data Object

Object Overview

Description: Records every moderation/admin action: who, what, target, reason, metadata, and timestamp. Used for full audit compliance and enables appeals, overrides, and reporting. Immutable except for soft delete.

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

Redis Entity Caching

This data object is configured for Redis entity caching, which improves data retrieval performance by storing frequently accessed data in Redis. Each time a new instance is created, updated or deleted, the cache is updated accordingly. Any get requests by id will first check the cache before querying the database. If you want to use the cache by other select criteria, you can configure any data property as a Redis cluster. 

{"action":{"$in":["approveListing","banUser","denyListing","deleteMessage","assignRole"]}}

This object is only cached if this criteria is met.

The criteria is only checked during create and update operations, not during read operations. So if you want the criteria to be checked during read operations because it has checks about reading time context, you should deactivate the checkCriteriaOnlyInCreateAndUpdates option.

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

The new record will be inserted without checking for duplicates. This means that the composite index is designed for search purposes only.

Properties Schema

Property Type Required Description
action String Yes Action performed (e.g., approveListing, denyListing, banUser, assignRole, etc.)
actionAt Date Yes Date and time the action was performed, UTC.
adminUserId ID Yes User ID of admin/moderator who initiated the action (refers to auth:user).
metadata Object No Extended details/JSON object with details relevant to the action (previous/new values, related entities, etc.)
reason String No Reason for action (required on denial, ban; optional for others).
targetId ID Yes ID of the affected resource/entity (listing, user, message, etc.)
targetType String Yes Kind of entity affected by the action (e.g., listing, user, conversationMessage, roleAssignment, category, etc.)

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.

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.

Constant Properties

action actionAt adminUserId metadata reason targetId targetType

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.

Elastic Search Indexing

action actionAt adminUserId metadata reason targetId targetType

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

action actionAt adminUserId targetId targetType

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

adminUserId

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

Session Data Properties

adminUserId

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.

Filter Properties

action actionAt adminUserId targetId targetType

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.