Back to blog
Other

Integrate with Your Favorite Docs Provider!

Nolan Sullivan

Nolan Sullivan

April 16, 2024 ยท 2 min read

Integrate with Your Favorite Docs Provider!

As we roll into summer, the days are getting longer but your APIs' time to 200 will be getting shorter thanks to our new integration with API documentation providers! More on this exciting new feature below, as well as the regular deluge of updates to our code generator!

Let's get into it ๐Ÿ‘‡

SDK Docs Integration

Production integration involves a lot more than just making an HTTP request. So why does your API reference have a generic fetch call? Authentication, error handling, pagination parsing, request retries, all need to be considered.

Thankfully, SDKs abstract a lot of these concerns for users, making it possible to provide a code snippet that is both concise and useful to your users. And with our new docs integration, it's now possible to automatically update your SDK code snippets with every new version of your SDKs!

Building a production-ready integration is as easy as โŒ˜C, โŒ˜V.

Head to our docs to start integrating SDKs into your docs!

๐Ÿšข Improvements and Bug Fixes ๐Ÿ›

Note

Based on the most recent CLI version: Speakeasy v1.253.3

The Platform

๐Ÿšข Speed up validation runs by skipping name resolution
๐Ÿšข Global parameters can now be hidden from method signatures by configuring maxMethodParams with extensions
๐Ÿšข Support for flattened globals
๐Ÿšข deprecated OpenAPI keyword now respected for globals

Terraform

๐Ÿšข Always instantiate arrays to empty slices to avoid null being sent over the wire
๐Ÿšข Capability to generate resource state upgraders
๐Ÿšข Custom set validators, bump terraform-plugin-framework to 1.7.0 with custom dependencies
๐Ÿšข Set types in Terraform, x-speakeasy-xor-with / x-speakeasy-required-with validators
๐Ÿ› Fix: extensions being ignored when under an allOf
๐Ÿ› Fix Terraform support in quickstart command
๐Ÿ› Fix: only hoist union subtypes that are primitive to avoid a provider error

C#

๐Ÿšข Support multi-level package naming and non-camel case namespaces

Python

๐Ÿšข Bump pylint version to 3.1.0 in Python
๐Ÿšข Better additionalDeps validation in your gen.yaml file

Last updated on

AI everywhere.

Control here.