Skip to main content

Infrastructure Module

Description​

Represents a distinct module within the infrastructure layer, grouping related infrastructure concerns (e.g., 'messaging', 'caching').

Definition Schema​

The definition for a infrastructure_module component expects the following structure:

{
  "example": {
    "name": "messaging"
  },
  "properties": {
    "name": {
      "description": "Name of the Infrastructure Module",
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "InfrastructureModuleInputDTO",
  "type": "object"
}

Naming and Location Conventions​

Directory Name: snake_case (e.g., 'infrastructure_module_name_name'). Defines structure at/under app/infrastructure/${infrastructure_module_name}.

Example Definition​

{
  "name": "messaging"
}