Service Design Specification - Object Design for coursePack

tutorhub-tutorcatalog-service documentation

Document Overview

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

coursePack Data Object

Object Overview

Description: Publicly listed course pack/structured course offered by a tutor.

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

An error will be thrown, preventing the insertion of conflicting data.

Properties Schema

Display Label Property: title — This property is the default display label for records of this data object. Relation dropdowns and record references in the frontend will show the value of this property as the human-readable label.

Property Type Required Description
tutorProfileId ID Yes -
title String Yes -
description Text No -
price Double Yes -
category String Yes -
schedulingType Enum Yes -
minWeeklyClasses Integer No -
preliminaryMeetingRequired Boolean Yes -
isPublished Boolean Yes -
maxDailyLessons Integer No -
requiredClassesCount Integer No -
moderationStatus Enum No Content moderation status.
moderationNote String No Admin note for flagged/removed course packs.
maxPeriodValue Integer No Maximum time period value for strict scheduling (e.g. 3 for 3 months)
maxPeriodUnit Enum No Time unit for maxPeriodValue in strict scheduling

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.

Auto Update Properties

tutorProfileId title description price category schedulingType minWeeklyClasses preliminaryMeetingRequired isPublished maxDailyLessons requiredClassesCount moderationStatus moderationNote maxPeriodValue maxPeriodUnit

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

tutorProfileId title description price category schedulingType minWeeklyClasses preliminaryMeetingRequired isPublished maxDailyLessons requiredClassesCount moderationStatus maxPeriodValue maxPeriodUnit

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

tutorProfileId title category isPublished moderationStatus

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

tutorProfileId

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

tutorProfileId category

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

Filter Properties

tutorProfileId title category schedulingType isPublished moderationStatus

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.