Skip to content

CHANGELOG.md

Latest commit

 

History

History
60 lines (43 loc) · 4.35 KB

CHANGELOG.md

File metadata and controls

60 lines (43 loc) · 4.35 KB
Raw

Changelog

All notable changes to this package are documented in this file. The format follows Keep a Changelog, and versions follow Semantic Versioning.

Compatibility promise: the public API is additive-only. Anything public is deprecated before it is removed, and every pull request is compared with the latest release by swift package diagnose-api-breaking-changes in CI. See the API stability section of CONTRIBUTING.md.

Unreleased

Added

  • CI: an API Breakage workflow fails a pull request that changes the public API compared with the latest release tag. Consciously accepted breaks are listed in .github/api-breakage-allowlist.txt with a matching changelog entry.
  • CI: the Swift Build workflow now builds and tests on Linux with Swift 5.10, 6.0 and 6.3 containers, tests on macOS and the iOS Simulator, and builds for tvOS, watchOS and visionOS with Xcode. Tests written with Swift Testing only exist on toolchains that ship it (Swift 6); the XCTest suite runs everywhere.
  • CONTRIBUTING.md: API stability policy, including how new endpoint groups are added as namespaces and how generated Components.Schemas types are treated.
  • This changelog.

Fixed

  • Build warning in ModelResponseEventsStreamInterpreter when logging a failed stream event decode in debug builds.
  • The test target compiles for the package's minimum iOS deployment target again; it used Regex, which requires iOS 16.
  • Building on Linux with Swift 5.10 works again. swift-corelibs-foundation gained the async URLSession APIs only in Swift 6, so the async client now bridges the completion-handler API on older Linux toolchains.

0.5.1 - 2026-07-21

Added

  • refusal field on the streaming chat completion delta (#408).
  • reasoningContent on assistant chat messages for providers that return reasoning (#402).
  • annotations on ChatStreamResult (#399).

Changed

  • Regenerated Components.Schemas from the updated OpenAPI spec (#433). This changed public generated types: transcription segment and word timestamps moved from Float to Double, ImageGenTool.SizePayload lost its fixed cases, responseId was removed from the response audio events, and ChatResult.Choice.Message.Annotation moved to a top-level Annotation type. Two ChatCompletionMessageParam initializers were removed.
  • swift-openapi-runtime 1.11.0 → 1.12.0 (#424).

0.5.0 - 2026-06-05

Added

  • model is optional in CreateModelResponseQuery for the stored-prompt (prompt_id) flow (#419).

Changed

  • Regenerated Components.Schemas from the fresh OpenAPI spec (#423); the release notes flagged possible breaking changes.
  • swift-openapi-runtime 1.8.2 → 1.11.0 (#416).

Fixed

  • Missing name field on ResponseFunctionCallArgumentsDoneEvent (#420).

0.4.9 - 2026-04-30

Added

  • completion_tokens_details on CompletionUsage (#411).
  • prompt_cache_key on CreateModelResponseQuery (#412).
  • Dependabot configuration for GitHub Actions and Swift dependencies (#414).

Changed

  • ChoiceDeltaToolCall.index is required again (#388).
  • ChatQuery description output is easier to read (#394).
  • Documentation: response_format versus text for structured outputs (#413); security policy points to the private reporting channel (#410).

Older releases are documented on the GitHub Releases page.