Title (Semantic Module)

← Back to Modules Reference

The Title semantic module standardizes text properties that serve as the primary heading or display title of a record (such as an article title, product headline, book name, or task subject).

Tagging a property with Title ensures that headings are clean text strings, automatically trims extraneous whitespace from copy-paste operations, converts empty inputs to null, and indicates to search engines and indexing systems that this property holds high-priority relevance.

---

Technical Specifications

Attribute	Specification
Scope	Property (Applied to a text property)
Data Type	String
Default Max Length	255 characters
Whitespace Handling	Automatically trimmed on Create and Update
Empty Input Handling	Blank strings ("" or spaces only) convert to null

---

Key Capabilities

1. Automatic Whitespace Sanitization

When authors copy and paste titles from word processors or spreadsheets, accidental spaces often slip in. The Serverless Engine automatically cleans the input:

• " The Art of System Architecture " is stored as "The Art of System Architecture".

2. Empty String Normalization

Submitting an empty string ("") or a string containing only spaces is automatically normalized to null. This prevents phantom blank titles from appearing in search results or navigation menus.

3. Complementary with Name

While Title is typically used for creative works, articles, products, and documents, the platform also provides the Name semantic module for individuals, companies, or named entities.

---

API Lifecycle Examples

1. Creating a Record with a Clean Title

A client submits an article with extra padding:

POST /articles
Content-Type: application/json

{
  "title": "   10 Rules for Scalable APIs   ",
  "category": "Architecture"
}

Server Response (201 Created):

{
  "data": {
    "id": "art_101",
    "title": "10 Rules for Scalable APIs",
    "category": "Architecture"
  }
}

---

2. Submitting an Empty Title

Submitting whitespace-only:

POST /articles
Content-Type: application/json

{
  "title": "    ",
  "category": "Drafts"
}

Server Response (201 Created):

{
  "data": {
    "id": "art_102",
    "title": null,
    "category": "Drafts"
  }
}

---

3. Validation Failure (Invalid Type)

If a client passes an array or number:

{
  "title": 12345
}

Server Response (400 Bad Request):

{
  "type": "https://docs.apinow.app/errors/validation",
  "title": "Validation Error",
  "status": 400,
  "code": "E_VALIDATION_ERROR",
  "detail": "Property 'title' must be a string."
}

---

Validation Rules & Modeling Guidelines

• Applicable Property Types: Apply to a String property in the Domain Modeler.
• Property Length Constraints: By default, String properties have a Maximum Length of 255 characters. For long publication titles or thesis headings, you can increase the Maximum Length in the property settings.