Skip to content

CHANGELOG.md

Latest commit

 

History

History
497 lines (261 loc) · 9.33 KB

CHANGELOG.md

File metadata and controls

497 lines (261 loc) · 9.33 KB

Change Log - @typespec/openapi

1.10.0

Features

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

Bump dependencies

  • #9838 Upgrade dependencies

Bug Fixes

  • #9686 [API] Expose setOperationId

1.9.0

No changes, version bump only.

1.8.0

Bump dependencies

  • #9223 Upgrade dependencies

1.7.0

Bump dependencies

  • #9046 Upgrade dependencies

1.6.0

Bump dependencies

  • #8823 Upgrade dependencies

1.5.0

No changes, version bump only.

1.4.0

Bump dependencies

  • #8317 Upgrade dependencies

Bug Fixes

  • #8192 update @info decorator documentation to the latest

1.3.0

Bump dependencies

  • #7978 Upgrade dependencies

1.2.0

Bump dependencies

  • #7674 Upgrade dependencies

1.1.0

Bug Fixes

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

1.0.0

No changes, version bump only.

1.0.0-rc.1

Bug Fixes

  • #6947 Fix crash when using enum values in extension

1.0.0-rc.0

Bump dependencies

  • #6595 Upgrade dependencies

Bug Fixes

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

0.67.0

Breaking Changes

  • #5977 Minimum node version is now 20

Bump dependencies

  • #6266 Update dependencies

0.66.0

Deprecations

  • #6078 Updates the @extension decorator with 3 changes:
  1. Removes the extension name starts with x- constraint.
  2. Adds support for passing in values to emit raw data.
  3. 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

0.49.0

Wed, 11 Oct 2023 23:31:35 GMT

Updates

  • Removes @typespec/rest as a peerDependency. Relates to #2391
  • Add support for http status code ranges
  • Changed namespace from OpenAPI to TypeSpec.OpenAPI.
  • Update dependencies

0.48.0

Tue, 12 Sep 2023 21:47:11 GMT

Version update only

0.47.0

Tue, 08 Aug 2023 22:32:10 GMT

Updates

  • Add new @info decorator providing the ability to specify the additional fields from openapi info object.

0.46.0

Tue, 11 Jul 2023 22:06:00 GMT

Updates

  • Fix repo name in package.json
  • Update dependencies

0.45.0

Tue, 06 Jun 2023 22:44:16 GMT

Updates

  • Update decorators to use valueof

0.44.0

Wed, 10 May 2023 21:24:00 GMT

Updates

  • Update decorator declaration to use Model instead of object
  • Update dependencies

0.43.0

Tue, 11 Apr 2023 18:49:17 GMT

Version update only

0.42.0

Mon, 13 Mar 2023 21:30:44 GMT

Version update only

0.41.0

Fri, 03 Mar 2023 19:59:17 GMT

Updates

  • Revert back changelog
  • Use new @typespec/http library
  • Update package.json entrypoint to tspMain
  • Rename to TypeSpec
  • Update homepage link

0.40.0

Tue, 07 Feb 2023 21:56:17 GMT

Version update only

0.39.0

Fri, 13 Jan 2023 00:05:26 GMT

Version update only

0.38.0

Wed, 07 Dec 2022 17:21:52 GMT

Minor changes

  • Internal: update to use new getTypeName and getNamespaceString helper
  • Add support for multiple services
  • Uptake changes to compiler api with new scalar type

Patches

  • Add cadl docs on decorators
  • Update dependencies

0.14.0

Sat, 12 Nov 2022 00:14:04 GMT

Minor changes

  • Declare decorators in cadl using extern dec

0.13.0

Wed, 12 Oct 2022 21:12:35 GMT

Minor changes

  • Implement automatic visibility transformations

Patches

  • Remove workaround for issue with KeysOf #462
  • Add/update docs for openapi3 emitter

0.12.0

Thu, 08 Sep 2022 01:04:53 GMT

Minor changes

  • Update decororator state key to allow multiple instance of library to work together.
  • React to Type suffix removal

Patches

  • Api: Operation id resolver takes projection into account

0.11.0

Thu, 11 Aug 2022 19:05:23 GMT

Minor changes

  • Uptake changes to type relations
  • Inline generic instantiations without @friendlyName
  • Added helper to resolve operation id
  • Internal: Uptake new compiler helpers to work with template types

0.10.1

Fri, 08 Jul 2022 23:22:57 GMT

Version update only

0.10.0

Mon, 13 Jun 2022 23:42:28 GMT

Minor changes

  • Uptake changes to decorator context

Updates

  • Upgrade to TS4.7

0.9.0

Fri, 06 May 2022 17:19:57 GMT

Minor changes

  • Move decorators into OpenAPI namespace
  • Remove node 14 support
  • Add shared helpers for OpenAPI 2 and 3 emit

0.8.0

Thu, 31 Mar 2022 17:10:49 GMT

Minor changes

  • Update @extension to allow value to be a complex object or array
  • @defaultResponse set status code for model

0.7.0

Wed, 09 Mar 2022 17:42:09 GMT

Minor changes

  • Added @externalDocs decorator to specify externalDocs OpenAPI field

0.6.1

Tue, 15 Feb 2022 22:35:02 GMT

Version update only

0.6.0

Mon, 14 Feb 2022 03:01:07 GMT

Minor changes

  • refactor status code handling to http library
  • Validate @extension decorator extension name start with x-
  • Update decorators to take in api change

Patches

  • Bump dependency versions

0.5.1

Fri, 04 Feb 2022 18:00:18 GMT

Initial release