Service Design Specification - Object Design for companyAvatarsFile
workforceos-auth-service documentation
Document Overview
This document outlines the object design for the companyAvatarsFile model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.
companyAvatarsFile Data Object
Object Overview
Description: Auto-generated file storage for the companyAvatars database bucket. Files are stored as BYTEA in PostgreSQL.
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
- Soft Delete: Disabled — Determines whether records are marked inactive (
isActive = false) instead of being physically deleted. - Public Access: accessPublic — If enabled, anonymous users may access this object’s data depending on API-level rules.
- Tenant-Level Scope: No — Enables data isolation per tenant by attaching a tenant ID field.
Properties Schema
| Property | Type | Required | Description |
|---|---|---|---|
fileName |
String | Yes | Original file name as uploaded by the client. |
mimeType |
String | Yes | MIME type of the uploaded file (e.g., image/png, application/pdf). |
fileSize |
Integer | Yes | File size in bytes. |
accessKey |
String | Yes | 12-character random key for shareable access. Auto-generated on upload. |
ownerId |
ID | No | ID of the user who uploaded the file (from session). |
fileData |
Blob | Yes | Binary file content. Stored as BYTEA in PostgreSQL or Buffer in MongoDB. |
metadata |
Object | No | Optional JSON metadata for the file (tags, alt text, etc.). |
companyId |
ID | No | Reference to the owner company record. |
- Required properties are mandatory for creating objects and must be provided in the request body if no default value is set.
- Properties marked
Type[] (array)MUST be sent as a JSON array (e.g.["a","b"]), even when only one value is present (["a"]). Sending a bare scalar fails validation.
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.
- fileName: ‘default’
- mimeType: ‘default’
- fileSize: 0
- accessKey: ‘default’
- fileData: Buffer.alloc(0)
Constant Properties
fileName mimeType fileSize accessKey ownerId fileData companyId
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
fileName mimeType fileSize accessKey ownerId fileData metadata companyId
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.
Elastic Search Indexing
fileName mimeType fileSize ownerId companyId
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
fileName mimeType accessKey ownerId companyId
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.
Unique Properties
accessKey
Unique properties are enforced to have distinct values across all instances of the data object, preventing duplicate entries.
Note that a unique property is automatically indexed in the database so you will not need to set the Indexed in DB option.
Session-sourced Properties
ownerId
These properties have source: 'session' — their values are read from the authenticated session at create/update time and cannot be supplied in the request body.
- ownerId: ID property will be mapped to the session parameter
userId.
This property is the data object’s ownership field, used by ownership-based access control.
Filter Properties
mimeType ownerId companyId
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.
-
mimeType: String has a filter named
mimeType -
ownerId: ID has a filter named
ownerId -
companyId: ID has a filter named
companyId