TypeScript Feature Reference

Notes

Describe server outside your spec

Support

✅

Docs

config

Notes

Name	Support	Docs
URL Templating	✅	defining
Multiple server	✅	extension
Describe server outside your spec	✅	config

Data Types

Basic Types

Name

Numbers

Support

✅

Docs

Notes

Strings

Support

✅

Docs

Notes

Date Time

Support

✅

Docs

Notes

Boolean

Support

✅

Docs

Notes

Binary

Support

✅

Docs

Notes

Enums

Support

✅

Docs

Notes

Arrays

Support

✅

Docs

Notes

Maps

Support

✅

Docs

Notes

Objects

Support

✅

Docs

Notes

Any

Support

✅

Docs

Notes

Null

Support

✅

Docs

Notes

Name	Support	Docs	Notes
Numbers	✅	data-types	, , ,
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

✅

Docs

Using

Notes

is treated as

and will create a union type object.

Intersection Types

Support

🏗️ Partial

Docs

Using

Notes

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

Methods

Name

Namespacing

Support

✅

Docs

grouping operations

Notes

Multi-level Namespacing

Support

✅

Docs

multi-level grouping

Notes

Custom naming

Support

✅

Docs

Notes

Exclude Methods

Support

✅

Docs

Notes

Deprecation

Support

✅

Docs

the

flag

Notes

Name	Support	Docs
Namespacing	✅	grouping operations
Multi-level Namespacing	✅	multi-level grouping
Custom naming	✅	extension
Exclude Methods	✅	extension
Deprecation	✅	the flag

Parameters

Name

Pass Inline

Support

✅

Docs

flattening parameters

Notes

Pass via Request Object

Support

✅

Docs

request object

Notes

Exclude Parameters

Support

✅

Docs

Notes

Deprecate Parameters

Support

✅

Docs

the

flag

Notes

Define globally

Support

✅

Docs

global parameters

Notes

Name	Support	Docs
Pass Inline	✅	flattening parameters
Pass via Request Object	✅	request object
Exclude Parameters	✅	extension
Deprecate Parameters	✅	the flag
Define globally	✅	global parameters

Path Parameters Serialization

Name

Default (style = simple, explode = false)

Support

✅

Docs

Notes

Basic types

Support

✅

Docs

Notes

Simple objects

Support

✅

Docs

Notes

Support

❌

Docs

Notes

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

Query Parameters Serialization

Name

Support

✅

Docs

Notes

Support

✅

Docs

Notes

Support

✅

Docs

Notes

Support

✅

Docs

Notes

Support

✅

Docs

Notes

Basic types

Support

✅

Docs

Notes

Simple objects

Support

✅

Docs

Notes

Name	Support	Docs
	✅	Swagger Docs
	✅	Swagger Docs
	✅	Swagger Docs
	✅	Swagger Docs
	✅	Swagger Docs
Basic types	✅	Swagger Docs
Simple objects	✅	Swagger Docs

Requests

Name

Request headers

Support

✅

Docs

Notes

Request retries

Support

✅

Docs

retries

Notes

Support

✅

Docs

Notes

Both

and

form data

Support

✅

Docs

Notes

binary

Support

✅

Docs

Notes

raw byte

Support

✅

Docs

Notes

plain text

Support

✅

Docs

Notes

Support

🏗️ Partial

Docs

Notes

Including encoding, but not non-object types

XML

Support

❌

Docs

Notes

Other media types

Support

❌

Docs

Notes

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

Responses

Name

Pagination

Support

✅

Docs

Notes

Custom Errors

Support

✅

Docs

Notes

json

Support

✅

Docs

Notes

plain text

Support

✅

Docs

Notes

binary

Support

✅

Docs

Notes

raw byte

Support

✅

Docs

Notes

XML

Support

❌

Docs

Notes

Other media types

Support

❌

Docs