Guides · Engineering

API Schema Versioning Basics

Version schemas safely

This guide explains how to version API schemas: backward compatibility, additive changes, deprecation notices, separate versions or namespaces, and clear schema docs.

api schema
versioning
compatibility
deprecation
namespaces

Prefer additive changes

Add fields instead of removing; make breaking changes rare and planned.

Version clearly

Use versioned namespaces or endpoints; document differences.

Deprecate carefully

Announce timelines and support overlap; provide migration guidance.

Test both versions

Validate old and new schemas in CI to prevent regressions.

Keep Exploring

Guides

Intro to CAD Modeling

Learn the core CAD workflow for turning simple sketches into precise, editable 3D parts.

How it works

Air Traffic Control

Air traffic control coordinates aircraft movements to maintain safe separation.

Comparison

Hydrogen Car vs EV

Hydrogen cars make electricity from fuel onboard, while EVs store electricity directly in batteries.

Examples

Lever Simple Machine

A lever multiplies force by pivoting around a fulcrum, trading distance for mechanical advantage.