Skip to content
Lonely Planet Docs

Overview

This section provides comprehensive documentation for all API schemas, data transformations, and payload structures used across the platform. These schemas define the contract between services and ensure consistent data flow from Contentful through the Customs Transformer to Rakirura and Kakado.

Schema Categories

Section titled “Schema Categories”

Content Transformation Schemas

Section titled “Content Transformation Schemas”

These schemas define how content is transformed from Contentful Rich Text into structured formats:

  • Rich Text → Content Blocks - Transform Contentful Rich Text into EditorJS-style content blocks with HTML output
  • Articles Schema (Coming Soon) - Complete article payload structure including metadata, content blocks, and related data
  • POIs Schema (Coming Soon) - Points of Interest data structure with location, content, and media information
  • Places Schema (Coming Soon) - Place/destination data structure with comprehensive location and content data

Data Flow Overview

Section titled “Data Flow Overview”

Schema Standards

Section titled “Schema Standards”

All schemas in this section follow these standards:

Structure Consistency

Section titled “Structure Consistency”
  • Block Format: { id: string, type: string, data: object }
  • Field Naming: camelCase for JSON properties
  • ID Generation: Predictable prefixes for debugging and testing

Content Fields

Section titled “Content Fields”
  • contentHtml: Complete HTML with wrapper tags
  • innerHtml: Inner HTML content without wrapper tags (DOM standard)
  • text: Plain text content (where applicable)

Compatibility Requirements

Section titled “Compatibility Requirements”
  • Backward Compatibility: All schemas maintain compatibility with existing CAPI consumers
  • Performance Parity: New implementations must match or exceed current API response times
  • Testing Coverage: Comprehensive test coverage for all schema transformations

Implementation Notes

Section titled “Implementation Notes”

For Developers

Section titled “For Developers”
  • Review the specific schema documentation before implementing transformers
  • Use the provided examples for testing and validation
  • Follow migration considerations for backward compatibility

For Content Editors

Section titled “For Content Editors”
  • These schemas define what content structures are available
  • Rich text capabilities are documented with supported HTML tags
  • Media block types show available layout and presentation options
Section titled “Related Documentation”

This documentation is updated as schemas evolve. Last updated: January 2025