Service Design Specification - Object Design for listing

clonesahibinden-listing-service documentation

Document Overview

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

listing Data Object

Object Overview

Description: Core object for classified ads. Contains main listing information, relations, status, premium logic, price, attributes, contact info, and custom attributes. Supports premium upgrades via Stripe and lifecycle management.

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

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

Stripe Integration

This data object is configured to integrate with Stripe for order management of listing. It is designed to handle payment processing and order tracking. To manage payments, Mindbricks will design additional Business API routes arround this data object, which will be used checkout orders and charge customers.

if an error occurs during the checkout process, the API will continue to execute, allowing for custom error handling. In this case, the payment error will ve recorded as a status update. To make a retry a new checkout, a new order will be created with the same data as the original order.

Properties Schema

Property Type Required Description
attributes Object No JSON object for custom per-category attributes (structured as required by category schema).
categoryId ID Yes Main category for the listing (categoryLocation:category).
condition Enum Yes Item condition: new, used, other.
contactEmail String No Contact email (recommended to send via platform only).
contactPhone String No Display phone/contact for listing; may be masked by front end.
currency String Yes Currency (ISO-4217 code, e.g. 'TRY', 'USD').
description Text Yes Full description/body of listing.
expiresAt Date No UTC expiry for listing; after this, listing is automatically expired.
favoriteCount Integer Yes Favorite count (updated asynchronously by favorite service, not directly settable by user).
isPremium Boolean Yes If true, the listing is premium (highlighted/pinned, eligible for special placement).
listingType Enum Yes Type of listing (sale, rent, service, etc.).
locationId ID Yes Location (categoryLocation:location).
_paymentConfirmation String No Stripe payment result details (Stripe webhook metadata, internal use only).
premiumExpiry Date No UTC date when premium status expires. Null if not premium or not applicable.
premiumType Enum No Which premium package (gold, silver, none, etc.).
price Double Yes Listing price.
status Enum Yes Lifecycle status: pending_review, active, denied, sold, expired, deleted.
subcategoryId ID No Subcategory for the listing, can be null for top-level (categoryLocation:category).
title String Yes Listing title, short and clear.
userId ID Yes Owner (poster) of the listing (auth:user).
viewsCount Integer Yes View count (updated asynchronously; not directly settable by user).
paymentConfirmation Enum Yes An automatic property that is used to check the confirmed status of the payment set by webhooks.

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

favoriteCount _paymentConfirmation userId viewsCount

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

attributes categoryId condition contactEmail contactPhone currency description expiresAt isPremium listingType locationId premiumExpiry premiumType price status subcategoryId title

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.

Elastic Search Indexing

attributes categoryId condition currency description expiresAt favoriteCount isPremium listingType locationId premiumExpiry premiumType price status subcategoryId title userId viewsCount paymentConfirmation

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

categoryId condition currency isPremium listingType locationId premiumExpiry premiumType price status subcategoryId userId paymentConfirmation

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

paymentConfirmation

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

categoryId locationId subcategoryId 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.

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

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

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

userId

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.

This property is also used to store the owner of the session data, allowing for ownership checks and access control.

Formula Properties

isPremium

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.

Filter Properties

categoryId condition expiresAt isPremium listingType locationId premiumExpiry premiumType price status subcategoryId title userId paymentConfirmation

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.