Service Design Specification - Object Design for auditLog
auteurlabb-moderationadmin-service documentation
Document Overview
This document outlines the object design for the auditLog model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.
auditLog Data Object
Object Overview
Description: Generic audit log for all admin/moderation actions across services/objects for compliance and traceability.
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: Disabled — 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 |
|---|---|---|---|
actionType |
String | Yes | Type of admin action (created, updated, suspended, approved, etc.) |
actorUserId |
ID | Yes | User ID of admin/staff performing the action |
targetType |
String | Yes | Type of object affected by this action (approvalRequest, reportLog, suspensionRecord, etc.) |
targetId |
ID | Yes | ID of the object affected by this action |
details |
Text | No | Freeform details, note, or JSON blob describing action context |
actionAt |
Date | Yes | When the action occurred |
- 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.
- actionType: ‘default’
- actorUserId: ‘00000000-0000-0000-0000-000000000000’
- targetType: ‘default’
- targetId: ‘00000000-0000-0000-0000-000000000000’
- actionAt: new Date()
Constant Properties
actionType actorUserId targetType targetId details actionAt
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
actionType actorUserId targetType targetId details actionAt
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
actionType actorUserId targetType targetId actionAt
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.