Log in

Documentation Examples Guides

TypeScript Feature Reference

Authentication

Name	Support	Docs	Notes
HTTP Basic	✅	Docs
API Key (bearer, header, cookie, query)	✅	Docs
oAuth implicit flow	✅	Docs
oAuth refresh token flow	✅ using security callbacks	Docs
oAuth client credentials flow	✅ using hooks	Docs
mTLS	🏗️ Partial	Docs

Server Configuration

Name	Support	Docs	Notes
URL Templating	✅	defining `variables`
Multiple server	✅	`x-speakeasy-server-id` extension
Describe server outside your spec	✅	`serverUrl` config

Data Types

Basic Types

Name	Support	Docs	Notes
Numbers	✅	data-types (opens in a new tab)	`float`, `double`, `int32`, `int64`
Strings	✅	data-types (opens in a new tab)
Date Time	✅	data-types (opens in a new tab)
Boolean	✅	data-types (opens in a new tab)
Binary	✅	data-types (opens in a new tab)
Enums	✅	data-types (opens in a new tab)
Arrays	✅	data-types (opens in a new tab)
Maps	✅	data-types (opens in a new tab)
Objects	✅	data-types (opens in a new tab)
Any	✅	data-types (opens in a new tab)
Null	✅	data-types (opens in a new tab)

Polymorphism

Name	Support	Docs	Notes
Union Types	✅	Using `oneOf` (opens in a new tab)	`anyOf` is treated as `oneOf` and will create a union type object.
Intersection Types	🏗️ Partial	Using `allOf` (opens in a new tab)

Methods

Name	Support	Docs	Notes
Namespacing	✅	grouping operations
Multi-level Namespacing	✅	multi-level grouping
Custom naming	✅	`x-speakeasy-name-override` extension
Exclude Methods	✅	`x-speakeasy-ignore` extension
Deprecation	✅	the `deprecate` flag

Parameters

Name	Support	Docs	Notes
Pass Inline	✅	flattening parameters
Pass via Request Object	✅	request object
Exclude Parameters	✅	`x-speakeasy-ignore` extension
Deprecate Parameters	✅	the `deprecate` flag
Define globally	✅	global parameters

Path Parameters Serialization

Name	Support	Docs	Notes
Default `(style = simple, explode = false)`	✅	Swagger Docs (opens in a new tab)
Basic types	✅	Swagger Docs (opens in a new tab)
Simple objects	✅	Swagger Docs (opens in a new tab)
`label` & `matrix`	❌	Swagger Docs (opens in a new tab)

Query Parameters Serialization

Name	Support	Docs	Notes
`json`	✅	Swagger Docs (opens in a new tab)
`form`	✅	Swagger Docs (opens in a new tab)
`spaceDelimited`	✅	Swagger Docs (opens in a new tab)
`pipeDelimited`	✅	Swagger Docs (opens in a new tab)
`deepObject`	✅	Swagger Docs (opens in a new tab)
Basic types	✅	Swagger Docs (opens in a new tab)
Simple objects	✅	Swagger Docs (opens in a new tab)

Requests

Name	Support	Docs	Notes
Request headers	✅	Swagger Docs (opens in a new tab)
Request retries	✅	retries
`json`	✅	Swagger Docs (opens in a new tab)	Both `application/json` and `text/json`
form data	✅	Swagger Docs (opens in a new tab)
binary	✅	Swagger Docs (opens in a new tab)
raw byte	✅	Swagger Docs (opens in a new tab)
plain text	✅	Swagger Docs (opens in a new tab)
`x-www-form-urlencoded`	🏗️ Partial	Swagger Docs (opens in a new tab)	Including encoding, but not non-object types
XML	❌	Swagger Docs (opens in a new tab)
Other media types	❌	Swagger Docs (opens in a new tab)

Responses

Name	Support	Docs	Notes
Pagination	✅	`x-speakeasy-pagination` extension
Custom Errors	✅	`x-speakeasy-errors` extension
json	✅	Swagger Docs (opens in a new tab)
plain text	✅	Swagger Docs (opens in a new tab)
binary	✅	Swagger Docs (opens in a new tab)
raw byte	✅	Swagger Docs (opens in a new tab)
XML	❌	Swagger Docs (opens in a new tab)
Other media types	❌	Swagger Docs (opens in a new tab)

Documentation

Name	Support	Docs	Notes
`README` generation	✅	README generation
Usage Snippet generation	✅	snippet generation
Documentation generation	✅	documentation generation
`CHANGELOG` generation	✅	changelog generation