TypeScript Feature Reference

Authentication

Name

HTTP Basic

Support

✅

Notes

Docs

API Key (bearer, header, cookie, query)

Support

✅

Notes

Docs

OAuth implicit flow

Support

✅

Notes

Docs

OAuth refresh token flow

Support

✅ using security callbacks

Notes

Docs

OAuth client credentials flow

Support

✅ using hooks

Notes

Docs

OAuth resource owner password flow

Support

✅

Notes

Docs

mTLS

Support

🏗️ Partial

Notes

Docs

Name	Support	Docs
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
OAuth resource owner password flow	✅	Docs
mTLS	🏗️ Partial	Docs

Server Configuration

Name

URL Templating

Support

✅

Notes

Docs

defining variables

Multiple server

Support

✅

Notes

Docs

x-speakeasy-server-id extension

Describe server outside your spec

Support

✅

Notes

Docs

serverUrl config

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

Data Types

Basic Types

Name

Numbers

Support

✅

Notes

float, double, int32, int64

Docs

data-types

Strings

Support

✅

Notes

Docs

data-types

Date Time

Support

✅

Notes

Docs

data-types

Boolean

Support

✅

Notes

Docs

data-types

Binary

Support

✅

Notes

Docs

data-types

Enums

Support

✅

Notes

Docs

data-types

Arrays

Support

✅

Notes

Docs

data-types

Maps

Support

✅

Notes

Docs

data-types

Objects

Support

✅

Notes

Docs

data-types

Any

Support

✅

Notes

Docs

data-types

Null

Support

✅

Notes

Docs

data-types

Name	Support	Docs	Notes
Numbers	✅	data-types	`float`, `double`, `int32`, `int64`
Strings	✅	data-types
Date Time	✅	data-types
Boolean	✅	data-types
Binary	✅	data-types
Enums	✅	data-types
Arrays	✅	data-types
Maps	✅	data-types
Objects	✅	data-types
Any	✅	data-types
Null	✅	data-types

Polymorphism

Name

Union Types

Support

✅

Notes

anyOf is treated as oneOf and will create a union type object.

Docs

Using oneOf

Intersection Types

Support

🏗️ Partial

Notes

Docs

Using allOf

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

Methods

Name

Namespacing

Support

✅

Notes

Docs

grouping operations

Multi-level Namespacing

Support

✅

Notes

Docs

multi-level grouping

Custom naming

Support

✅

Notes

Docs

x-speakeasy-name-override extension

Exclude Methods

Support

✅

Notes

Docs

x-speakeasy-ignore extension

Deprecation

Support

✅

Notes

Docs

the deprecate flag

Name	Support	Docs
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

Pass Inline

Support

✅

Notes

Docs

flattening parameters

Pass via Request Object

Support

✅

Notes

Docs

request object

Exclude Parameters

Support

✅

Notes

Docs

x-speakeasy-ignore extension

Deprecate Parameters

Support

✅

Notes

Docs

the deprecate flag

Define globally

Support

✅

Notes

Docs

global parameters

Name	Support	Docs
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

Default (style = simple, explode = false)

Support

✅

Notes

Docs

Swagger Docs

Basic types

Support

✅

Notes

Docs

Swagger Docs

Simple objects

Support

✅

Notes

Docs

Swagger Docs

label & matrix

Support

❌

Notes

Docs

Swagger Docs

Name	Support	Docs
Default (style = simple, explode = false)	✅	Swagger Docs
Basic types	✅	Swagger Docs
Simple objects	✅	Swagger Docs
`label` & `matrix`	❌	Swagger Docs

Query Parameters Serialization

Name

json

Support

✅

Notes

Docs

Swagger Docs

form

Support

✅

Notes

Docs

Swagger Docs

spaceDelimited

Support

✅

Notes

Docs

Swagger Docs

pipeDelimited

Support

✅

Notes

Docs

Swagger Docs

deepObject

Support

✅

Notes

Docs

Swagger Docs

Basic types

Support

✅

Notes

Docs

Swagger Docs

Simple objects

Support

✅

Notes

Docs

Swagger Docs

Name	Support	Docs
`json`	✅	Swagger Docs
`form`	✅	Swagger Docs
`spaceDelimited`	✅	Swagger Docs
`pipeDelimited`	✅	Swagger Docs
`deepObject`	✅	Swagger Docs
Basic types	✅	Swagger Docs
Simple objects	✅	Swagger Docs

Requests

Name

Request headers

Support

✅

Notes

Docs

Swagger Docs

Request retries

Support

✅

Notes

Docs

retries

json

Support

✅

Notes

Both application/json and text/json

Docs

Swagger Docs

form data

Support

✅

Notes

Docs

Swagger Docs

binary

Support

✅

Notes

Docs

Swagger Docs

raw byte

Support

✅

Notes

Docs

Swagger Docs

plain text

Support

✅

Notes

Docs

Swagger Docs

x-www-form-urlencoded

Support

🏗️ Partial

Notes

Including encoding, but not non-object types

Docs

Swagger Docs

XML

Support

❌

Notes

Docs

Swagger Docs

Other media types

Support

❌

Notes

Docs

Swagger Docs

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

Responses

Name

Pagination

Support

✅

Notes

Docs

x-speakeasy-pagination extension

Custom Errors

Support

✅

Notes

Docs

x-speakeasy-errors extension

json

Support

✅

Notes

Docs

Swagger Docs

plain text

Support

✅

Notes

Docs

Swagger Docs

binary

Support

✅

Notes

Docs

Swagger Docs

raw byte

Support

✅

Notes

Docs

Swagger Docs

XML

Support

❌

Notes

Docs

Swagger Docs

Other media types

Support

❌

Notes

Docs

Swagger Docs

Name	Support	Docs
Pagination	✅	`x-speakeasy-pagination` extension
Custom Errors	✅	`x-speakeasy-errors` extension
json	✅	Swagger Docs
plain text	✅	Swagger Docs
binary	✅	Swagger Docs
raw byte	✅	Swagger Docs
XML	❌	Swagger Docs
Other media types	❌	Swagger Docs

Documentation

Name

README generation

Support

✅

Notes

Docs

README generation

Usage Snippet generation

Support

✅

Notes

Docs

snippet generation

Documentation generation

Support

✅

Notes

Docs

documentation generation

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