Project settings ontology

MPO Version: 1.3.0

Defines the core configuration of your Mindbricks project, including metadata, environment preferences, and infrastructure integrations. Use this section to set up the project name, description, and optionally override managed infrastructure services with your own. While Mindbricks provides managed services by default to ensure a reliable, production-ready architecture, you may choose to integrate custom services for Redis, PostgreSQL, Kafka, and others as needed.

interface ProjectSettings = {
  basicSettings : BasicProjectSettings;
  stripeSettings : StripeSettings;
  aiSettings : AiSettings;
  corsSettings : CorsSettings;
  pipelineTemplates : PipelineTemplate[];
  integrations : IntegrationConfiguration[];
}

BasicProjectSettings

MPO Version: 1.3.0

Defines the basic settings of your Mindbricks project, including its identity, descriptive metadata, environment variables, and current lifecycle stage. These values are essential for naming, documentation, and runtime configuration.

interface BasicProjectSettings = {
  name : String;
  fullname : String;
  description : Text;
  avatar : String;
  frontendDocument : Text;
  hasAuthentication : Boolean;
  ignoreDeploymentSpecificFiles : Boolean;
  customVariables : DataMapSimpleItem[];
}

DataMapSimpleItem

MPO Version: 1.3.0

Represents a single key-value pair used in most context. The value is constant.

interface DataMapSimpleItem = {
  name : String;
  value : String;
}

StripeSettings

MPO Version: 1.3.0

Defines integration settings for Stripe payments. Mindbricks does not provide a managed Stripe account—keys for both test and live modes must be supplied manually.

interface StripeSettings = {
  useStripe : Boolean;
  configuration : StripeSettingsConfig;
}

StripeSettingsConfig

MPO Version: 1.3.0

Defines the configuration for Stripe. This object is used when useStripe is set to true. It includes API keys for both test and live modes.

interface StripeSettingsConfig = {
  testPublicKey : String;
  testSecretKey : String;
  livePublicKey : String;
  liveSecretKey : String;
}

AiSettings

MPO Version: 1.3.0

Defines API keys for AI service providers such as OpenAI and Anthropic. These keys are used in any AI-powered logic within the application.

interface AiSettings = {
  openAiApiKey : String;
  anthropicApiKey : String;
}

CorsSettings

MPO Version: 1.3.0

Defines CORS settings for service accesses. When enabled Cross Origins will be accepted according to the settings.

interface CorsSettings = {
  useCorsControl : Boolean;
  configuration : CorsSettingsConfig;
}

CorsSettingsConfig

MPO Version: 1.3.0

Defines the configuration for CORS settings. This object is used when useCorsControl is set to true. Note that if your service is in a different subdomain, Mindbricks automatically uses wildcard url control and allows other subdomains in the same main domain. Localhost Vite ports are also allowed automatically.

interface CorsSettingsConfig = {
  allowedOrigins : String[];
  allowAllSubdomains : Boolean;
}

PipelineTemplate

MPO Version: 1.3.0

The asset to store a template for generating custom pipeline files. Used in project level and applied to all microservices.

interface PipelineTemplate = {
  filename : String;
  template : Text;
}

IntegrationConfiguration

MPO Version: 1.3.0

A configuration class to define client parameters to use a remote API like AWS S3, Twillio or any other 3rd part api provider.

interface IntegrationConfiguration = {
  provider : IntegrationProvider;
  configuration : DataMapItem[];
}

IntegrationProvider

An Enum value to store the names of the integration providers

const IntegrationProvider = {
  amazonS3: "amazonS3",
  amazonSES: "amazonSES",
  googleGemini: "googleGemini",
  googleMaps: "googleMaps",
  googleAnalytics: "googleAnalytics",
  Telegram: "Telegram",
  jiraServiceManagement: "jiraServiceManagement",
  Amplitude: "Amplitude",
  Mailgun: "Mailgun",
  Pusher: "Pusher",
  Slack: "Slack",
  Stripe: "Stripe",
  intercom: "intercom",
};

DataMapItem

MPO Version: 1.3.0

Represents a single key-value pair used in most context. The value can be defined dynamically using an MScript.

interface DataMapItem = {
  name : String;
  value : MScript;
}

MScript

MPO Version: 1.3.0

Represents a Mindbricks JavaScript expression used for logic, validation, or configuration. An MScript is stored as a string in the JSON schema but is expected to conform to a valid JavaScript ExpressionStatement. Acceptable forms include literals, identifiers, expressions, function calls, or a module.exports assignment returning a valid object. Although stored as plain text, MScripts are parsed and analyzed using a specialized override class that allows static checks and evaluation.

interface MScript = {
}