github.com/openai/openai-go breaking changes

go

26 curated breaking changes across major versions of github.com/openai/openai-go. Use this as a migration checklist before bumping dependencies.

26
changes
Breaking changes by transition
  • 3.27.0 \u2192 3.28.0api

    **api:** The `voice` param and resouce has changed from a `string` to a `string | {id: string}`. This is a breaking change for Go.

  • 2.7.1 \u2192 3.0.0api

    **api:** `ResponseFunctionToolCallOutputItem.output` and `ResponseCustomToolCallOutput.output` now return `string | Array<ResponseInputText | ResponseInputImage | ResponseInputFile>` instead of `string` only. This may break existing callsites that assume `output` is always a string.

  • 2.1.1 \u2192 2.2.0api

    **api:** Add connectors support for MCP tool ([35888bc](https://github.com/openai/openai-go/commit/35888bcd26c7633e8ea68f9213cc3977b8ac49eb))

  • 2.1.1 \u2192 2.2.0api

    **api:** add web search filters ([6f2c71d](https://github.com/openai/openai-go/commit/6f2c71d4e28971fc73e7e291d40f3b875d9cc42a))

  • 2.1.1 \u2192 2.2.0api

    **api:** adding support for /v1/conversations to the API ([5b7c31b](https://github.com/openai/openai-go/commit/5b7c31bde9c1086d3fb71c88dfdf74228845b22e))

  • 2.1.1 \u2192 2.2.0api

    **api:** realtime API updates ([130fc8e](https://github.com/openai/openai-go/commit/130fc8ea5ba39e6c1457ed6d26ef827d931a6242))

  • 2.1.1 \u2192 2.2.0api

    **client:** add support for verifying signatures on incoming webhooks ([f7c8dbb](https://github.com/openai/openai-go/commit/f7c8dbb6b5bd5bab72b7d146dc255d543b0b5a71))

  • 2.1.1 \u2192 2.2.0breaking

    **azure:** compatibility with edit image endpoint ([#477](https://github.com/openai/openai-go/issues/477)) ([d156eec](https://github.com/openai/openai-go/commit/d156eeca37bc86a5d8e1c973063a8425744810f1))

  • 2.1.1 \u2192 2.2.0breaking

    close body before retrying ([8dfed35](https://github.com/openai/openai-go/commit/8dfed35f11a00970ad804ab985cf393c2332ea8f))

  • 2.1.1 \u2192 2.2.0breaking

    **internal/ci:** setup breaking change detection ([0af0cd0](https://github.com/openai/openai-go/commit/0af0cd01302d3859a4e43554ed8e665007f69aad))

  • 2.1.1 \u2192 2.2.0breaking

    **internal:** version bump ([3265795](https://github.com/openai/openai-go/commit/3265795fffa44fb40d65a800b300807d9f1e7b2b))

  • 1.12.0 \u2192 2.0.0breaking

    openai.ChatCompletionToolParam{

  • 1.12.0 \u2192 2.0.0breaking

    Function: openai.FunctionDefinitionParam{

  • 1.7.0 \u2192 1.8.0api

    **api:** webhook and deep research support ([f6a7e7d](https://github.com/openai/openai-go/commit/f6a7e7dcd8801facc4f8d981f1ca43786c10de1e))

  • 1.7.0 \u2192 1.8.0breaking

    **internal:** add tests for breaking change detection ([339522d](https://github.com/openai/openai-go/commit/339522d38cd31b0753a8df37b8924f7e7dfb0b1d))

  • 0.1.0-beta.11 \u2192 1.0.0breaking

    **accumulator:** update casing ([#401](https://github.com/openai/openai-go/issues/401))

  • 0.1.0-beta.11 \u2192 1.0.0removed

    **api:** improve naming and remove assistants

  • 0.1.0-beta.11 \u2192 1.0.0renamed

    **client:** rename file array param variant

  • 0.1.0-beta.2 \u2192 0.1.0-beta.3breaking

    **client:** add enums ([#327](https://github.com/openai/openai-go/issues/327))

  • 0.1.0-beta.10 \u2192 0.1.0-beta.11breaking

    **client:** improve core function names

  • 0.1.0-beta.10 \u2192 0.1.0-beta.11breaking

    **client:** clearer array variant names

  • 0.1.0-beta.10 \u2192 0.1.0-beta.11breaking

    **client:** improve union variant names

  • 0.1.0-beta.10 \u2192 0.1.0-beta.11breaking

    **client:** improve param subunions & deduplicate types

  • 0.1.0-beta.10 \u2192 0.1.0-beta.11renamed

    **client:** rename resp package

  • 0.1.0-alpha.67 \u2192 0.1.0-beta.1breaking

    **docs:** clarify breaking changes ([#306](https://github.com/openai/openai-go/issues/306)) ([db4bd1f](https://github.com/openai/openai-go/commit/db4bd1f5304aa523a6b62da6e2571487d4248518))

  • unknown \u2192 0.1.0-alpha.67api

    **api:** migrate to v2

API access

Get this data programmatically \u2014 free, no authentication.

curl https://depscope.dev/api/breaking/go/github.com/openai/openai-go
github.com/openai/openai-go breaking changes — Go migration guide | DepScope