Iteration isn't just for code: here are our latest API docs

What this post added

This post details the technical implementation of a new API documentation site. Key contributions include: transitioning from JSON hyper-schemas to the OpenAPI specification for API definition, adopting Stoplight Elements (an open-source React framework) for site design and customization, and leveraging Cloudflare Pages with Pages Functions for building, deploying, and optimizing the documentation site. Pages Functions are used to optimize the OpenAPI schema file for Stoplight's UI and cache it on Cloudflare's network. This architecture enables dynamic schema loading, allowing documentation updates to reflect schema changes without full site redeployments.