Service Design Specification

airbnb-adminpanel-service documentation -Version:1.0.4

Scope

This document provides a structured architectural overview of the adminPanel microservice, detailing its configuration, data model, authorization logic, business rules, and API design. It has been automatically generated based on the service definition within Mindbricks, ensuring that the information reflects the source of truth used during code generation and deployment.

The document is intended to serve multiple audiences:

• Service architects can use it to validate design decisions and ensure alignment with broader architectural goals.
• Developers and maintainers will find it useful for understanding the structure and behavior of the service, facilitating easier debugging, feature extension, and integration with other systems.
• Stakeholders and reviewers can use it to gain a clear understanding of the service's capabilities and domain logic.

Note for Frontend Developers: While this document is valuable for understanding business logic and data interactions, please refer to the Service API Documentation for endpoint-level specifications and integration details.

Note for Backend Developers: Since the code for this service is automatically generated by Mindbricks, you typically won't need to implement or modify it manually. However, this document is especially valuable when you're building other services—whether within Mindbricks or externally—that need to interact with or depend on this service. It provides a clear reference to the service's data contracts, business rules, and API structure, helping ensure compatibility and correct integration.

AdminPanel Service Settings Edit

Administrative and compliance management backend for moderation, audit, dispute, financial oversight, localization, and GDPR in the Airbnb-style rental platform...

Service Overview

This service is configured to listen for HTTP requests on port 3003, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

• API Test Interface (API Face): /
• Swagger Documentation: /swagger
• Postman Collection Download: /getPostmanCollection
• Health Checks: /health and /admin/health
• Current Session Info: /currentuser
• Favicon: /favicon.ico

The service uses a PostgreSQL database for data storage, with the database name set to airbnb-adminpanel-service.

This service is accessible via the following environment-specific URLs:

• Preview: https://airbnb3.prw.mindbricks.com/adminpanel-api
• Staging: https://airbnb3-stage.mindbricks.co/adminpanel-api
• Production: https://airbnb3.mindbricks.co/adminpanel-api

Authentication & Security

• Login Required: Yes

This service requires user authentication for access. It supports both JWT and RSA-based authentication mechanisms, ensuring secure user sessions and data integrity. If a crud route also is configured to require login, it will check a valid JWT token in the request query/header/bearer/cookie. If the token is valid, it will extract the user information from the token and make the fetched session data available in the request context.

Service Data Objects

The service uses a PostgreSQL database for data storage, with the database name set to airbnb-adminpanel-service.

Data deletion is managed using a soft delete strategy. Instead of removing records from the database, they are flagged as inactive by setting the isActive field to false.

localizationSetting Data Object

Object Overview

Description: Admin-configured valid languages/currencies for site usage and preference.

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: accessProtected — If enabled, anonymous users may access this object’s data depending on API-level rules.

Properties Schema

• 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.

• languageCode: 'default'
• currencyCode: 'default'
• isCurrencyActive: false

Auto Update Properties

languageCode effectiveFrom effectiveTo currencyCode isCurrencyActive

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

languageCode currencyCode

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

languageCode currencyCode isCurrencyActive

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.

Filter Properties

languageCode currencyCode isCurrencyActive

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.

• languageCode: String has a filter named languageCode

• currencyCode: String has a filter named currencyCode

• isCurrencyActive: Boolean has a filter named isCurrencyActive

adminDisputeAction Data Object

Object Overview

Description: Record of an admin's moderation/decision action on a dispute.

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: accessProtected — If enabled, anonymous users may access this object’s data depending on API-level rules.

Properties Schema

• 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.

• disputeId: '00000000-0000-0000-0000-000000000000'
• actionTaken: 'default'
• adminId: '00000000-0000-0000-0000-000000000000'
• actionDate: new Date()

Constant Properties

disputeId actionTaken notes adminId outcome actionDate

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

disputeId actionTaken adminId outcome actionDate

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

disputeId adminId actionDate

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.

Secondary Key Properties

disputeId adminId

Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key.

Relation Properties

disputeId adminId

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.

• disputeId: ID Relation to dispute.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

• adminId: 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

Formula Properties

actionDate

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.

• actionDate: Date

  • Formula: new Date()

  • Calculate After Instance: No

Filter Properties

disputeId adminId

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.

• disputeId: ID has a filter named disputeId

• adminId: ID has a filter named adminId

apiKey Data Object

Object Overview

Description: Admin-generated API key for internal/external integration—has revocation, audit trail.

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

• 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.

• key: 'default'
• active: false
• createdBy: '00000000-0000-0000-0000-000000000000'

Constant Properties

key createdBy

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

active description revokedAt

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.

Hashed Properties

key

Hashed properties are stored in the database as a hash value, providing an additional layer of security for sensitive data.

Database Indexing

key active createdBy

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.

Unique Properties

key

Unique properties are enforced to have distinct values across all instances of the data object, preventing duplicate entries. Note that a unique property is automatically indexed in the database so you will not need to set the Indexed in DB option.

Relation Properties

createdBy

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.

• createdBy: 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

financialReport Data Object

Object Overview

Description: System-generated or admin-generated report snapshots of platform financials for a given period (GDPR/tax).

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

• 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.

• period: 'default'
• totalPayouts: 0.0
• createdBy: '00000000-0000-0000-0000-000000000000'
• totalRefunds: 0.0
• currency: 'default'
• generatedAt: new Date()
• totalRevenue: 0.0

Constant Properties

period cityTaxByLocation totalPayouts createdBy totalRefunds currency generatedAt totalRevenue

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

period currency generatedAt totalRevenue

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

period createdBy currency generatedAt

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.

Secondary Key Properties

createdBy

Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key.

Relation Properties

createdBy

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.

• createdBy: 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

Formula Properties

generatedAt

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.

• generatedAt: Date

  • Formula: new Date()

  • Calculate After Instance: No

Filter Properties

period

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.

• period: String has a filter named period

auditLog Data Object

Object Overview

Description: Immutable audit log for recording sensitive admin actions and platform changes.

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: accessProtected — If enabled, anonymous users may access this object’s data depending on API-level rules.

Properties Schema

• 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.

• performedBy: '00000000-0000-0000-0000-000000000000'
• actionObject: 'default'
• occurredAt: new Date()
• actionType: 'default'

Constant Properties

performedBy objectId details ipAddress actionObject occurredAt actionType

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

performedBy actionObject occurredAt actionType

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

performedBy objectId ipAddress actionObject occurredAt actionType

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

performedBy

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.

• performedBy: 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

Formula Properties

occurredAt

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.

• occurredAt: Date

  • Formula: new Date()

  • Calculate After Instance: No

Filter Properties

performedBy objectId actionObject occurredAt actionType

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.

• performedBy: ID has a filter named performedBy

• objectId: ID has a filter named objectId

• actionObject: String has a filter named actionObject

• occurredAt: Date has a filter named occurredAt

• actionType: String has a filter named actionType

gdprAction Data Object

Object Overview

Description: Record of individual user GDPR/consent/export/delete request flow. Used for logs, compliance, and controls.

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

• 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.

• requestedAt: new Date()
• status: pending
• actionType: 'default'
• userId: '00000000-0000-0000-0000-000000000000'

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 pending

Constant Properties

requestedAt actionType userId

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 processedAt

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, complete, failed]

Database Indexing

requestedAt status actionType userId processedAt

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.

Secondary Key Properties

userId

Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key.

Relation Properties

userId

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

Formula Properties

requestedAt

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.

• requestedAt: Date

  • Formula: new Date()

  • Calculate After Instance: No

Business Logic

adminPanel has got 17 Business APIs to manage its internal and crud logic. For the details of each business API refer to its chapter.

• Get Auditlog

• Get Financialreport

• Create Financialreport

• List Auditlogs

• List Financialreports

• Create Auditlog

• Create Localizationsetting

• List Admindisputeactions

• Create Admindisputeaction

• Update Localizationsetting

• Update Gdpraction

• List Gdpractions

• Create Apikey

• List Apikeys

• Update Apikey

• List Localizationsettings

• Create Gdpraction

Edge Controllers

No edge controllers defined for this service.

Service Library

Functions

No general functions defined.

Hook Functions

No hook functions defined.

Edge Functions

No edge functions defined.

Templates

No templates defined.

Assets

No assets defined.

Public Assets

No public assets defined.

Event Emission

Integration Patterns

Deployment Considerations

Environment Configuration

• HTTP Port: 3003
• Database Type: MongoDB
• Global Soft Delete: Enabled

Implementation Guidelines

Development Workflow

1. Data Model Implementation: Generate database schema from data object definitions
2. CRUD Route Generation: Implement auto-generated routes with custom logic
3. Custom Logic Integration: Implement hook functions and edge functions
4. Authentication Integration: Configure with project-level authentication
5. Testing: Unit and integration testing for all components

Code Generation Expectations

• Database Schema: Auto-generated from data objects and relationships
• API Routes: REST endpoints with customizable behavior
• Validation Logic: Input validation from property definitions
• Access Control: Authentication and authorization middleware

Custom Code Integration Points

• Hook Functions: Lifecycle-specific custom logic
• Edge Functions: Full request/response control
• Library Functions: Reusable business logic
• Templates: Dynamic content rendering

Testing Strategy

Unit Testing

• Test all custom library functions
• Test validation logic and business rules
• Test hook function implementations

Integration Testing

• Test API endpoints with authentication scenarios
• Test database operations and transactions
• Test external integrations
• Test event emission and Kafka integration

Performance Testing

• Load test high-traffic endpoints
• Test caching effectiveness
• Monitor database query performance
• Test scalability under load

Appendices

Data Type Reference

Enum Value Mappings

Request Locations

• 0: Bearer token in Authorization header
• 1: Cookie value
• 2: Custom HTTP header
• 3: Query parameter
• 4: Request body property
• 5: URL path parameter
• 6: Session data
• 7: Root request object

HTTP Methods

• 0: GET
• 1: POST
• 2: PUT
• 3: PATCH
• 4: DELETE

Edge Function Signature

async function edgeFunction(request) {
  // Custom request processing
  // Return response object or throw error
  return {
    data: {},
    status: 200,
    message: "Success"
  };
}

This document was generated from the service architecture definition and should be kept in sync with implementation changes.