Skip to content

deprecated

# Copyright 2026 The Bitol Contributors
# SPDX-License-Identifier: Apache-2.0

# Demonstrates RFC-0051: the optional `deprecated` boolean on schema objects
# and properties (including nested properties). Defaults to false.

version: 1.0.0
apiVersion: v3.2.0
kind: DataContract
id: 3e8a1b6c-4d2f-4a90-b1c7-5e9f0a2b3c4d
status: active
schema:
  - name: legacy_orders
    physicalType: table
    deprecated: true
    description: "DEPRECATED: use 'orders' instead. Will be removed in the next major version."
    properties:
      - name: order_id
        logicalType: integer
        required: true
      - name: category_id
        logicalType: integer
        deprecated: true
        description: "DEPRECATED: use the nested 'category' object instead."
      - name: category
        logicalType: object
        properties:
          - name: id
            logicalType: integer
          - name: legacy_code
            logicalType: string
            deprecated: true
            description: "DEPRECATED: retained for backward compatibility only."