SpecDefinition referenceView source

Socials

Social media handles or URLs, keyed by platform. The keys are an engine vocabulary validated directly (no catalog lookup): engines link a handle with the platform's URL pattern and handle prefix (spec/reference/engine-vocabularies.json). Each value is a string, either a full URL or a platform handle (e.g., '@acme'). Brand colours and icons are catalog display metadata for authoring UIs; engines render the profile URL, not icons or brand colours. Used both for organization and speaker records.

Metadata

Definition: #/$defs/Socials
Form: Dictionary
Source: spec/schemas/opf.schema.json

Field index

This definition uses the forms or value constraints below.

Complete definition constraints

Schema constraints

{
  "type": "object",
  "description": "Social media handles or URLs, keyed by platform. The keys are an engine vocabulary validated directly (no catalog lookup): engines link a handle with the platform's URL pattern and handle prefix (spec/reference/engine-vocabularies.json). Each value is a string, either a full URL or a platform handle (e.g., '@acme'). Brand colours and icons are catalog display metadata for authoring UIs; engines render the profile URL, not icons or brand colours. Used both for organization and speaker records.",
  "additionalProperties": {
    "type": "string",
    "description": "Handle or URL for the platform identified by the property key."
  },
  "examples": [
    {
      "linkedin": "https://linkedin.com/in/alice-chen",
      "x": "@alicechen",
      "github": "alicechen"
    },
    {
      "linkedin": "https://linkedin.com/company/acme",
      "bluesky": "acme.bsky.social",
      "mastodon": "https://hachyderm.io/@acme"
    }
  ],
  "propertyNames": {
    "enum": [
      "linkedin",
      "x",
      "github",
      "youtube",
      "instagram",
      "facebook",
      "tiktok",
      "threads",
      "mastodon",
      "bluesky"
    ],
    "description": "Platform key, one of the engine's social platforms."
  }
}