Business API Design Specification - Create Favorite

A Business API is a set of logical actions centered around a main data object. These actions can range from simple CRUD operations to complex workflows that implement intricate business logic.

While the term “API” traditionally refers to an interface that allows software systems to interact, in Mindbricks a Business API represents a broader concept. It encapsulates a business workflow around a data object, going beyond basic CRUD operations to include rich, internally coordinated actions that can be fully designed and customized.

This document provides an in-depth explanation of the architectural design of the createFavorite Business API. It is intended to guide backend architects and developers in maintaining the current design. Additionally, frontend developers and frontend AI agents can use this document to understand how to properly consume this API on the client side.

Main Data Object and CRUD Operation

The createFavorite Business API is designed to handle a create operation on the Favorite data object. This operation is performed under the specified conditions and may include additional, coordinated actions as part of the workflow.

API Description

Add a favorite for a listing for the current user. Prevents duplicate (user,listing) pairs, and can’t favorite own listing.

API Frontend Description By The Backend Architect

AI Dev: Call this API to favorite a listing; on success, update UI state and increment count. If already favorited, show appropriate feedback. Cannot favorite own listings. No double favoriting allowed.

API Options

API Controllers

A Mindbricks Business API can be accessed through multiple interfaces, including REST, gRPC, WebSocket, Kafka, or Cron. The controllers listed below map the business workflow to a specific interface, enabling consistent interaction regardless of the communication channel.

REST Controller

The createFavorite Business API includes a REST controller that can be triggered via the following route:

/v1/favorites

By sending a request to this route using the service API address, you can execute this Business API. Parameters can be provided in multiple HTTP locations, including the URL path, URL query, request body, and request headers. Detailed information about these parameters is provided in the Parameters section.

MCP Tool

REST controllers also expose the Business API as a tool in the MCP, making it accessible to AI agents. This createFavorite Business API will be registered as a tool on the MCP server within the service binding.

API Parameters

The createFavorite Business API has 3 parameters that must be sent from the controller. Note that all parameters, except session and Redis parameters, should be provided by the client.

Business API parameters can be:

Regular Parameters

Name Type Required Default Location Data Path
favoriteId ID No - body favoriteId
Description: This id paremeter is used to create the data object with a given specific id. Leave null for automatic id.
listingId ID Yes - body listingId
Description: Target listing being favorited.
userId ID Yes - session userId
Description: User who favorited the listing.

Parameter Transformations

Some parameters are post-processed using transform scripts after being read from the request but before validation or workflow execution. Only parameters with a transform script are listed below.

No parameters are transformed in this API.

AUTH Configuration

The authentication and authorization configuration defines the core access rules for the createFavorite Business API. These checks are applied after parameter validation and before executing the main business logic.

While these settings cover the most common scenarios, more fine-grained or conditional access control—such as permissions based on object context, nested memberships, or custom workflows—should be implemented using explicit actions like PermissionCheckAction, MembershipCheckAction, or ObjectPermissionCheckAction.

Login Requirement

This API requires login (loginRequired = true). Requests from non-logged-in users will return a 401 Unauthorized error. Login is necessary but not sufficient, as additional role, permission, or other authorization checks may still apply.

Ownership Checks

Role and Permission Settings

Data Clause

Defines custom field-value assignments used to modify or augment the default payload for create and update operations. These settings override values derived from the session or parameters if explicitly provided.", Note that a default data clause is always prepared by Mindbricks using data property settings, however any property in the data clause can be override by Data Clause Settings.

Custom Data Clause Override No custom data clause override configured

Actual Data Clause

The business api will use the following data clause. Note that any calculated value will be added to the data clause in the api manager. 

{
  id: this.favoriteId,
  listingId: this.listingId,
  userId: this.userId,
  isActive: true,
  _archivedAt: null,
}

Business Logic Workflow

[1] Step : startBusinessApi

Manager initializes context, populates session and request objects, prepares internal structures for parameter handling and workflow execution.

You can use the following settings to change some behavior of this step. apiOptions, restSettings, grpcSettings, kafkaSettings, socketSettings, cronSettings

[2] Step : readParameters

Manager reads input parameters, normalizes missing values, applies default type casting, and stores them in the API context.

You can use the following settings to change some behavior of this step. customParameters, redisParameters

[3] Action : fetchListing

Action Type: FetchObjectAction

Fetch the related listing to check user can’t favorite own listing, and for count update. 

class Api {
  async fetchListing() {
    // Fetch Object on childObject listing

    const userQuery = {
      $and: [{ id: this.listingId }, { isActive: true }],
    };
    const { convertUserQueryToElasticQuery } = require("common");
    const scriptQuery = convertUserQueryToElasticQuery(userQuery);

    const elasticIndex = new ElasticIndexer("listing");
    const data = await elasticIndex.getOne(scriptQuery);

    if (!data) {
      throw new NotFoundError("errMsg_FethcedObjectNotFound:listing");
    }

    return data
      ? {
          id: data["id"],
          userId: data["userId"],
        }
      : null;
  }
}

[4] Action : checkDuplicate

Action Type: FunctionCallAction

Check if this favorite already exists.

class Api {
  async checkDuplicate() {
    try {
      return await getFavoriteByQuery({
        userId: this.session.userId,
        listingId: this.listingId,
      });
    } catch (err) {
      console.error("Error in FunctionCallAction checkDuplicate:", err);
      throw err;
    }
  }
}

[5] Step : transposeParameters

Manager transforms parameters, computes derived values, flattens or remaps arrays/objects, and adjusts formats for downstream processing.

[6] Action : checkDuplicateValidation

Action Type: ValidationAction

Block duplicate favoriting.

class Api {
  async checkDuplicateValidation() {
    const isError = !!this.duplicateFavorite;

    if (isError) {
      throw new BadRequestError("You have already favorited this listing!");
    }
    return isError;
  }
}

[7] Action : selfFavoriteValidation

Action Type: ValidationAction

User cannot favorite own listing.

class Api {
  async selfFavoriteValidation() {
    const isError = this.session.userId == this.targetListing.userId;

    if (isError) {
      throw new BadRequestError("You cannot favorite your own listing!");
    }
    return isError;
  }
}

[8] Step : checkParameters

Manager executes built-in validations: required field checks, type enforcement, and basic business rules. Prevents operation if validation fails.

[9] Step : checkBasicAuth

Manager performs authentication and authorization checks: verifies session, user roles, permissions, and tenant restrictions.

You can use the following settings to change some behavior of this step. authOptions

[10] Step : buildDataClause

Manager constructs the final data object for creation, fills auto-generated fields (IDs, timestamps, owner fields), and ensures schema consistency.

You can use the following settings to change some behavior of this step. dataClause

[11] Action : setFavoritedAt

Action Type: AddToContextAction

Ensure favoritedAt is set now.

class Api {
  async setFavoritedAt() {
    try {
      this["favoritedAt"] = new Date().toISOString();

      return true;
    } catch (error) {
      console.error("AddToContextAction error:", error);
      throw error;
    }
  }
}

[12] Step : mainCreateOperation

Manager executes the database insert operation, updates indexes/caches, and triggers internal post-processing like linked default records.

[13] Action : incFavoriteCount

Action Type: UpdateCrudAction

Increment favoriteCount on listing after favorite created.

class Api {
  async incFavoriteCount() {
    // Aggregated Update Operation on childObject listing

    const params = {
      favoriteCount: (this.targetListing.favoriteCount ?? 0) + 1,
    };
    const userQuery = { id: this.listingId };

    const { convertUserQueryToSequelizeQuery } = require("common");
    const query = convertUserQueryToSequelizeQuery(userQuery);

    // Remote object - call inter-service M2M edge function
    const { InterService } = require("common-service");
    const options = {};

    const result = await InterService.callListingm2mUpdateListingByQuery(
      {
        body: { dataClause: params, query: query },
      },
      options,
    );

    if (!result || result.status !== 200) {
      throw new HttpServerError(
        `Inter-service call failed: ${result?.message || "Unknown error"}`,
      );
    }

    const updatedResult = result.content;
    if (!updatedResult) return null;

    // if updated record is in main data update main data
    if (this.dbResult) {
      for (const item of updatedResult) {
        if (item.id == this.dbResult.id) {
          Object.assign(this.dbResult, item);
          this.favorite = this.dbResult;
        }
      }
    }
    if (updatedResult.length == 0) return null;
    if (updatedResult.length == 1) return updatedResult[0];
    return updatedResult;
  }
}

[14] Step : buildOutput

Manager shapes the response: masks sensitive fields, resolves linked references, and formats output according to API contract.

[15] Step : sendResponse

Manager sends the response to the client and finalizes internal tasks like flushing logs or updating session state.

[16] Step : raiseApiEvent

Manager triggers API-level events (Kafka, WebSocket, async workflows) as the final internal step.

Rest Usage

Rest Client Parameters

Client parameters are the api parameters that are visible to client and will be populated by the client. Note that some api parameters are not visible to client because they are populated by internal system, session, calculation or joint sources.

The createFavorite api has got 1 regular client parameter

Parameter Type Required Population
listingId ID true request.body?.[“listingId”]

REST Request

To access the api you can use the REST controller with the path POST /v1/favorites 

  axios({
    method: 'POST',
    url: '/v1/favorites',
    data: {
            listingId:"ID",  
    
    },
    params: {
    
        }
  });

REST Response

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the “Error Response” section.

Following JSON represents the most comprehensive form of the favorite object in the respones. However, some properties may be omitted based on the object’s internal logic. 

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "favorite",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"favorite": {
		"id": "ID",
		"favoritedAt": "Date",
		"listingId": "ID",
		"userId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}