OpenMetadata · Schema

Topic

Data CatalogMetadataData GovernanceData LineageData QualityOpen-SourceData DiscoveryData Observability

Properties

Name Type Description
id string
name string
fullyQualifiedName string
displayName string
description string
version number
updatedAt integer
updatedBy string
impersonatedBy string
service object
serviceType string
messageSchema object
partitions integer
cleanupPolicies array
retentionTime number
replicationFactor integer
maximumMessageSize integer
minimumInSyncReplicas integer
retentionSize number
topicConfig object
sampleData object
owners array
followers array
tags array
href string
changeDescription object
incrementalChangeDescription object
deleted boolean
extension object
sourceUrl string
domains array
dataProducts array
dataContract object
votes object
lifeCycle object
certification object
sourceHash string
entityStatus string
provider string
children array
style object
experts array
reviewers array
usageSummary object
View JSON Schema on GitHub

JSON Schema

topic.json Raw ↑
{
  "required": [
    "id",
    "name",
    "partitions",
    "service"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "pattern": "^((?!::).)*$",
      "type": "string"
    },
    "fullyQualifiedName": {
      "maxLength": 3072,
      "minLength": 1,
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "version": {
      "type": "number",
      "format": "double"
    },
    "updatedAt": {
      "type": "integer",
      "format": "int64"
    },
    "updatedBy": {
      "type": "string"
    },
    "impersonatedBy": {
      "type": "string"
    },
    "service": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "serviceType": {
      "type": "string",
      "enum": [
        "Kafka",
        "Redpanda",
        "Kinesis",
        "PubSub",
        "CustomMessaging"
      ]
    },
    "messageSchema": {
      "$ref": "#/components/schemas/MessageSchema"
    },
    "partitions": {
      "minimum": 1,
      "exclusiveMinimum": false,
      "type": "integer",
      "format": "int32"
    },
    "cleanupPolicies": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "delete",
          "compact"
        ]
      }
    },
    "retentionTime": {
      "type": "number",
      "format": "double"
    },
    "replicationFactor": {
      "type": "integer",
      "format": "int32"
    },
    "maximumMessageSize": {
      "type": "integer",
      "format": "int32"
    },
    "minimumInSyncReplicas": {
      "type": "integer",
      "format": "int32"
    },
    "retentionSize": {
      "type": "number",
      "format": "double"
    },
    "topicConfig": {
      "$ref": "#/components/schemas/TopicConfig"
    },
    "sampleData": {
      "$ref": "#/components/schemas/TopicSampleData"
    },
    "owners": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "followers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TagLabel"
      }
    },
    "href": {
      "type": "string",
      "format": "uri"
    },
    "changeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "incrementalChangeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "deleted": {
      "type": "boolean"
    },
    "extension": {
      "type": "object"
    },
    "sourceUrl": {
      "type": "string"
    },
    "domains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "dataProducts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "dataContract": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "votes": {
      "$ref": "#/components/schemas/Votes"
    },
    "lifeCycle": {
      "$ref": "#/components/schemas/LifeCycle"
    },
    "certification": {
      "$ref": "#/components/schemas/AssetCertification"
    },
    "sourceHash": {
      "maxLength": 32,
      "minLength": 1,
      "type": "string"
    },
    "entityStatus": {
      "type": "string",
      "enum": [
        "Draft",
        "In Review",
        "Approved",
        "Archived",
        "Deprecated",
        "Rejected",
        "Unprocessed"
      ]
    },
    "provider": {
      "type": "string",
      "enum": [
        "system",
        "user",
        "automation"
      ]
    },
    "children": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "style": {
      "$ref": "#/components/schemas/Style"
    },
    "experts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "reviewers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "usageSummary": {
      "$ref": "#/components/schemas/UsageDetails"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/openmetadata/main/json-schema/topic.json"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/topic"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.