Change Log - @typespec/openapi

July 14, 2026 · View on GitHub

1.14.0

Deprecations

#10964 Deprecate old testing framework (createTestHost, createTestRunner, createTestWrapper, createTestLibrary, BasicTestRunner, TypeSpecTestLibrary, etc.). Use createTester from @typespec/compiler/testing instead.

1.13.0

Features

#10769 Add summary and kind fields to @tagMetadata decorator.

For OpenAPI 3.2, these fields are emitted as native tag object fields. For OpenAPI 3.0/3.1, they are emitted as x-oai-summary and x-oai-kind extensions. The OpenAPI converter also supports importing x-oai-summary, x-oai-kind (from 3.0/3.1) and native summary, kind (from 3.2) back to TypeSpec.
```
@tagMetadata("foo", #{ summary: "all operations that allow doing Foo", kind: "FooGroup" })
```
#10770 Add array form for @tagMetadata decorator to allow explicit control of tag declaration order.
```
@service
@tagMetadata(#[
  #{ name: "First Tag", description: "First tag description" },
  #{ name: "Second Tag", description: "Second tag description" },
])
namespace PetStore {}
```
Using @tagMetadata(#[...]) and @tagMetadata("name", #{...}) on the same namespace is a diagnostic error.
#10555 Added a warning diagnostic when @defaultResponse is used on a model that already has a @statusCode property or is marked with @error.

Bug Fixes

#10919 Reject duplicate tag names in @tagMetadata array form.
#10776 Fix tagMetadata extension diagnostic targets

1.10.0

Features

#9577 Add support for OpenAPI 3.2 nested tags via parent field in @tagMetadata decorator

1.4.0

Bug Fixes

#8192 update @info decorator documentation to the latest

1.1.0

Bug Fixes

#7509 Fix @tagMetadata decorator emitting error when incorrectly not finding @service decorator

1.0.0-rc.1

Bug Fixes

#6947 Fix crash when using enum values in extension

1.0.0-rc.0

Bug Fixes

#6651 Adds diagnostic when passing in a Type to the $extension decorator function directly

0.67.0

0.66.0

Deprecations

#6078 Updates the @extension decorator with 3 changes:

Removes the extension name starts with x- constraint.
Adds support for passing in values to emit raw data.
Adds a deprecation warning for passing in types. Passed in types will emit Open API schemas in a future release.

Scalar literals (e.g. string, boolean, number values) are automatically treated as values. Model or tuple expression usage needs to be converted to values to retain current behavior in future releases.

-@extension("x-obj", { foo: true })
+@extension("x-obj", #{ foo: true })
-@extension("x-tuple", [ "foo" ])
+@extension("x-tuple", #[ "foo" ])
model Foo {}

#6108 Migrate @info decorator to expect a value

-@info({ version: "1.0.0" })
+@info(#{ version: "1.0.0" })

-@info({
+@info(#{
  termsOfService: "http://example.com/terms/",
-  contact: {
+  contact: #{
    name: "API Support",
    url: "http://www.example.com/support",
    email: "support@example.com"
  },
})

0.65.0

Bump dependencies

#5690 Upgrade dependencies

Features

#5699 Promote unsafe_useStateMap and unsafe_useStateSet experimental APIs to stable version useStateMap and useStateSet. Old ones are deprecated

0.64.0

No changes, version bump only.

0.63.0

No changes, version bump only.

0.62.0

Bump dependencies

#4679 Upgrade dependencies - October 2024

Features

#4834 Add new @tagMetadata decorator to specify OpenAPI tag properties

0.61.0

Bug Fixes

#4505 @info decorator validate no extra properties not starting with x- are provided.
#4483 @info decorator validate termsOfService is a valid url

Bump dependencies

#4424 Bump dependencies

0.60.0

Features

#4139 Internals: Migrate to new api for declaring decorator implementation

0.59.0

Bump dependencies

#3948 Update dependencies

0.58.0

Bump dependencies

#3718 Dependency updates July 2024

Features

#3626 Adds public function for setting info object

0.57.0

Bump dependencies

#3401 Update dependencies - May 2024

0.56.0

Bump dependencies

#3169 Update dependencies

0.55.0

Bump dependencies

#3027 Update dependencies

0.54.0

Bump dependencies

#2900 Update dependencies

Features

#2902 Add support for all properties of openapi info object on the @info decorator

0.53.0

Patch Changes

0.52.0

Wed, 24 Jan 2024 05:46:53 GMT

Updates

Update dependencies

0.51.0

Wed, 06 Dec 2023 19:40:58 GMT

Version update only

0.50.0

Wed, 08 Nov 2023 00:07:17 GMT

Updates

TypeScript use types entry under exports of package.json instead of legacy typesVersions to provide the definition files
BREAKING CHANGE Dropped support for node 16, minimum node version is now 18