Skip to content

API Schemas Overview

OpenMetadata API schemas define request and response formats for all REST API operations.

Overview

API schemas follow OpenAPI 3.0 specification and provide type-safe contracts for all operations.

Schema Categories

CRUD Operations

  • Create operations
  • Read/Get operations
  • Update/Patch operations
  • Delete operations

Request Schemas

  • Path parameters
  • Query parameters
  • Request bodies

Response Schemas

  • Success responses
  • Error responses
  • Pagination