Platform APIs
Treating the platform's own interfaces as contracts with consumers and compatibility rules.
4 to work through
-
beginner
A platform team argues that their internal API needs no versioning because every caller is inside the company and can be found with a code search. What is wrong with that reasoning?
2 min answer -
intermediate
A platform exposes APIs to internal teams. How should these differ from APIs exposed to external customers?
2 min answer -
intermediate Multiple choice
Product teams need a Kafka topic and an object-storage bucket per service with quotas and retention that change over time. Should the platform expose a synchronous provisioning call that returns when the resource exists or a declarative resource reconciled by a controller or a pull request into a shared Terraform repository?
3 min answer -
intermediate
The Hugging Face Hub stored large model and dataset files with Git LFS which versions whole files - appending 1 MB to a 5 GB file re-uploads 5 GB. In 2025 the Hub began moving repositories onto Xet storage which splits content into roughly 64 KB content-defined chunks aggregated into roughly 64 MB blocks so only changed chunks travel. The API developers call did not change. What forced the change and what had to stay stable and where would copying it be a mistake?
3 min answer
3 terms in this topic
Compatibility Window
The period during which two versions of a caller or message must both work, set by deployment and queue mechanics rather than by how many consumers t…
conceptPlatform API
The programmatic contract through which teams consume platform capabilities, and the thing that must stay stable while everything behind it changes.
conceptPlatform Contract
The platform's promise to its consumers about interface stability, behaviour and support, treated with the same seriousness as an external API.
Neighbouring topics
Platform Engineering
General material on internal platforms as products with users, adoption and lifecycles.
Internal Developer Platform
The assembled surface teams actually touch, and what belongs behind it.
Paved Road & Golden Path
A supported default route that is easier than the alternatives rather than mandatory.
Self-Service Provisioning
Teams getting infrastructure without a ticket, and the guardrails that make that safe.
Service Templates
Scaffolding new services with observability, CI and security already wired in.
Platform Tenancy
Isolating teams sharing a cluster, account or pipeline fleet, and where isolation must be hard.
Cluster Architecture
How many clusters, split by what, and the blast radius each split buys.
Service Mesh Operations
What a mesh genuinely solves, its failure modes, and the cost of running one.
Container Image Strategy
Base images, layer hygiene, rebuild cadence, and patching a fleet of images.
Developer Environments
Local, remote and ephemeral environments, and the fidelity each can honestly claim.
Inner Loop & Outer Loop
Where an engineer's time actually goes, and which loop a platform investment shortens.
Abstraction Level Choice
How much to hide, and the leak that turns a helpful abstraction into a trap.
Platform SLOs
Committing to reliability for internal consumers who cannot choose another provider.
Platform Adoption
Migrating existing teams onto a platform without a mandate, and reading the adoption curve.
Platform Funding
Central cost, showback, chargeback, and justifying a team that ships no customer feature.
Platform API Deprecation
Removing something dozens of internal teams depend on, on a timeline that holds.
Guardrails vs Gates
Preventing a class of mistake automatically versus stopping to ask a human.
Platform Telemetry
Instrumenting the platform itself: usage, friction, and where teams leave the paved road.
Platform Team Topologies
Stream-aligned, enabling, complicated-subsystem and platform teams, and their interactions.