Our API has transformed significantly starting with the adoption of Swagger, now known as OpenAPI v2. The integration of the OpenAPI Specification has been crucial in streamlining our API development process and crafting a seamless experience for developers. We're taking a significant leap forward by adopting the OpenAPI v3 Specification. This significant update is a testimony to our commitment to fostering a high-quality API contract and equipping our developer community with the most up-to-date tools and technologies.
Key Improvements
The transition to OpenAPI v3 brings a lot of great stuff and new possibilities for developers. Here are some of the initial improvements we're implementing out of the gate:
- Callback Support for Async Operations: The introduction of callbacks in v3 paves the way for better handling of complex, multi-step operations and outgoing 'callback' webhooks for asynchronous APIs and push notifications. This empowers developers to manage intricate, time-consuming tasks more efficiently, improving overall performance. Stay tuned as we adopt some of these new features into the Dashboard API (hint: liveTools & actionBatches).
- Enhanced API Definitions: Providing API response schemas are critical for strongly typed languages to ensure the data and types are as expected. OASv3 has enhanced these capabilities by providing flexible options to define dynamic, additive, and conditional properties which the Dashboard API is taking advantage of. Creating SDKs for your favorite language should be easier and more reliable than ever before.
- Improved Tooling and Validations: v3 introduces improved tools and validation mechanisms that streamline the API design, development, and testing processes. These enhancements ensure that the API's implementation aligns with its design, leading to a robust and reliable API experience.
Learn more here ➡️ OpenAPI v3 Officially Supported!
