✏️ Edit Page

Documentation Directory

JSON Schemas

Formal Draft 2020-12 JSON Schema specifications for HELIX Gaming DB resources.

JSON Schema Reference

All data payloads in HELIX Gaming DB strictly adhere to formal JSON Schema (Draft 2020-12) specifications.

1. Game Metadata Schema

The game schema defines the payload structure for api/v1/games/{slug}.json.

  • Schema ID: https://helix-origin.github.io/helix-gaming-db/schemas/game.schema.json
  • File Location: schemas/game.schema.json

Field Definitions

Field Type Required Description
slug string Yes Unique kebab-case identifier (matching ^[a-z0-9]+(?:-[a-z0-9]+)*$).
title string Yes The canonical display title.
aliases string[] Yes Alternate titles, subtitles, romanizations, and acronyms.
developers string[] Yes Array of studio / creator names.
publishers string[] Yes Array of publisher names.
releaseDate string Yes ISO date string (YYYY-MM-DD or YYYY).
releaseYear integer Yes Numeric release year.
genres string[] Yes Game genres (e.g. Visual Novel, RPG, Action).
categories string[] Yes Gameplay categories (e.g. Single-player, Multi-player).
tags string[] No Community and descriptive tags.
ageRating string | null No Content rating (e.g. Everyone 10+, Teen, Adults Only 18+).
userScore number | null No Rating score from 0 to 100.
shortDescription string Yes 1-2 sentence synopsis.
detailedDescription string Yes Full narrative synopsis and feature overview.
capsuleImage string Yes Portrait cover / box art image URL (600x900 or 2:3 ratio).
heroImage string Yes Wide banner / hero wallpaper image URL (1920x620 or 16:9 ratio).
logoImage string | null No Transparent logo PNG/SVG URL.
headerImage string | null No Storefront header banner URL (460x215).
screenshots string[] Yes Array of high-resolution screenshot image URLs.
movies object[] No Array of video trailers ({ title, url, thumbnail }).
soundtracks object[] No Array of soundtrack previews ({ title, url, artist }).
verified boolean Yes Flag indicating human verification of metadata and assets.

2. Developer Profile Schema

The developer schema defines the payload structure for api/v1/developers/{slug}.json.

  • Schema ID: https://helix-origin.github.io/helix-gaming-db/schemas/developer.schema.json
  • File Location: schemas/developer.schema.json

Field Definitions

Field Type Required Description
slug string Yes Unique kebab-case identifier.
name string Yes Official studio display name.
aliases string[] Yes Known aliases, historic names, or individual developer handles.
website string | null No Official website URL.
patreon string | null No Patreon creator page URL.
itch string | null No itch.io creator / publisher URL.
steam string | null No Steam developer / publisher URL.
description string Yes Studio background and notable releases.
games string[] Yes Array of game slugs belonging to this studio.

3. Manifest Schema

The manifest schema defines the database directory and health information in api/v1/manifest.json.

  • Schema ID: https://helix-origin.github.io/helix-gaming-db/schemas/manifest.schema.json
  • File Location: schemas/manifest.schema.json

Field Definitions

Field Type Required Description
name string Yes Database name.
version string Yes SemVer version of the database.
schemaVersion string Yes Version of the JSON schema contract.
updatedAt string Yes ISO 8601 timestamp of generation.
totalGames integer Yes Number of games currently indexed.
totalDevelopers integer Yes Number of developer profiles currently indexed.
endpoints object Yes Endpoint path templates.