Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.28.0"
".": "0.28.1"
}
6 changes: 3 additions & 3 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 118
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-49233088b5e73dbb96bf7af27be3d4547632e3db1c2b00f14184900613325bbc.yml
openapi_spec_hash: b34f14b141d5019244112901c5c7c2d8
config_hash: 94e9ba08201c3d1ca46e093e6a0138fa
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-e205b1f2da6a1f2caa229efa9ede63f2d3d2fedeeb2dd6ed3d880bafdcb0ab88.yml
openapi_spec_hash: c8aee2469a749f6a838b40c57e4b7b06
config_hash: 45dcba51451ba532959c020a0ddbf23c
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## 0.28.1 (2025-10-01)

Full Changelog: [v0.28.0...v0.28.1](https://github.com/openai/openai-ruby/compare/v0.28.0...v0.28.1)

### Bug Fixes

* **api:** add status, approval_request_id to MCP tool call ([51622d0](https://github.com/openai/openai-ruby/commit/51622d065828bec248fb765c5bc243a058f0044d))

## 0.28.0 (2025-09-30)

Full Changelog: [v0.27.1...v0.28.0](https://github.com/openai/openai-ruby/compare/v0.27.1...v0.28.0)
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ GIT
PATH
remote: .
specs:
openai (0.28.0)
openai (0.28.1)
connection_pool

GEM
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
<!-- x-release-please-start-version -->

```ruby
gem "openai", "~> 0.28.0"
gem "openai", "~> 0.28.1"
```

<!-- x-release-please-end -->
Expand Down
38 changes: 37 additions & 1 deletion lib/openai/models/conversations/conversation_item.rb
Original file line number Diff line number Diff line change
Expand Up @@ -526,6 +526,14 @@ class McpCall < OpenAI::Internal::Type::BaseModel
# @return [Symbol, :mcp_call]
required :type, const: :mcp_call

# @!attribute approval_request_id
# Unique identifier for the MCP tool call approval request. Include this value in
# a subsequent `mcp_approval_response` input to approve or reject the
# corresponding tool call.
#
# @return [String, nil]
optional :approval_request_id, String, nil?: true

# @!attribute error
# The error from the tool call, if any.
#
Expand All @@ -538,7 +546,14 @@ class McpCall < OpenAI::Internal::Type::BaseModel
# @return [String, nil]
optional :output, String, nil?: true

# @!method initialize(id:, arguments:, name:, server_label:, error: nil, output: nil, type: :mcp_call)
# @!attribute status
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
# `calling`, or `failed`.
#
# @return [Symbol, OpenAI::Models::Conversations::ConversationItem::McpCall::Status, nil]
optional :status, enum: -> { OpenAI::Conversations::ConversationItem::McpCall::Status }

# @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Conversations::ConversationItem::McpCall} for more details.
#
Expand All @@ -552,11 +567,32 @@ class McpCall < OpenAI::Internal::Type::BaseModel
#
# @param server_label [String] The label of the MCP server running the tool.
#
# @param approval_request_id [String, nil] Unique identifier for the MCP tool call approval request.
#
# @param error [String, nil] The error from the tool call, if any.
#
# @param output [String, nil] The output from the tool call.
#
# @param status [Symbol, OpenAI::Models::Conversations::ConversationItem::McpCall::Status] The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `c
#
# @param type [Symbol, :mcp_call] The type of the item. Always `mcp_call`.

# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
# `calling`, or `failed`.
#
# @see OpenAI::Models::Conversations::ConversationItem::McpCall#status
module Status
extend OpenAI::Internal::Type::Enum

IN_PROGRESS = :in_progress
COMPLETED = :completed
INCOMPLETE = :incomplete
CALLING = :calling
FAILED = :failed

# @!method self.values
# @return [Array<Symbol>]
end
end

# @!method self.variants
Expand Down
38 changes: 37 additions & 1 deletion lib/openai/models/responses/response_input_item.rb
Original file line number Diff line number Diff line change
Expand Up @@ -818,6 +818,14 @@ class McpCall < OpenAI::Internal::Type::BaseModel
# @return [Symbol, :mcp_call]
required :type, const: :mcp_call

# @!attribute approval_request_id
# Unique identifier for the MCP tool call approval request. Include this value in
# a subsequent `mcp_approval_response` input to approve or reject the
# corresponding tool call.
#
# @return [String, nil]
optional :approval_request_id, String, nil?: true

# @!attribute error
# The error from the tool call, if any.
#
Expand All @@ -830,7 +838,14 @@ class McpCall < OpenAI::Internal::Type::BaseModel
# @return [String, nil]
optional :output, String, nil?: true

# @!method initialize(id:, arguments:, name:, server_label:, error: nil, output: nil, type: :mcp_call)
# @!attribute status
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
# `calling`, or `failed`.
#
# @return [Symbol, OpenAI::Models::Responses::ResponseInputItem::McpCall::Status, nil]
optional :status, enum: -> { OpenAI::Responses::ResponseInputItem::McpCall::Status }

# @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Responses::ResponseInputItem::McpCall} for more details.
#
Expand All @@ -844,11 +859,32 @@ class McpCall < OpenAI::Internal::Type::BaseModel
#
# @param server_label [String] The label of the MCP server running the tool.
#
# @param approval_request_id [String, nil] Unique identifier for the MCP tool call approval request.
#
# @param error [String, nil] The error from the tool call, if any.
#
# @param output [String, nil] The output from the tool call.
#
# @param status [Symbol, OpenAI::Models::Responses::ResponseInputItem::McpCall::Status] The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `c
#
# @param type [Symbol, :mcp_call] The type of the item. Always `mcp_call`.

# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
# `calling`, or `failed`.
#
# @see OpenAI::Models::Responses::ResponseInputItem::McpCall#status
module Status
extend OpenAI::Internal::Type::Enum

IN_PROGRESS = :in_progress
COMPLETED = :completed
INCOMPLETE = :incomplete
CALLING = :calling
FAILED = :failed

# @!method self.values
# @return [Array<Symbol>]
end
end

class ItemReference < OpenAI::Internal::Type::BaseModel
Expand Down
38 changes: 37 additions & 1 deletion lib/openai/models/responses/response_item.rb
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,14 @@ class McpCall < OpenAI::Internal::Type::BaseModel
# @return [Symbol, :mcp_call]
required :type, const: :mcp_call

# @!attribute approval_request_id
# Unique identifier for the MCP tool call approval request. Include this value in
# a subsequent `mcp_approval_response` input to approve or reject the
# corresponding tool call.
#
# @return [String, nil]
optional :approval_request_id, String, nil?: true

# @!attribute error
# The error from the tool call, if any.
#
Expand All @@ -520,7 +528,14 @@ class McpCall < OpenAI::Internal::Type::BaseModel
# @return [String, nil]
optional :output, String, nil?: true

# @!method initialize(id:, arguments:, name:, server_label:, error: nil, output: nil, type: :mcp_call)
# @!attribute status
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
# `calling`, or `failed`.
#
# @return [Symbol, OpenAI::Models::Responses::ResponseItem::McpCall::Status, nil]
optional :status, enum: -> { OpenAI::Responses::ResponseItem::McpCall::Status }

# @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Responses::ResponseItem::McpCall} for more details.
#
Expand All @@ -534,11 +549,32 @@ class McpCall < OpenAI::Internal::Type::BaseModel
#
# @param server_label [String] The label of the MCP server running the tool.
#
# @param approval_request_id [String, nil] Unique identifier for the MCP tool call approval request.
#
# @param error [String, nil] The error from the tool call, if any.
#
# @param output [String, nil] The output from the tool call.
#
# @param status [Symbol, OpenAI::Models::Responses::ResponseItem::McpCall::Status] The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `c
#
# @param type [Symbol, :mcp_call] The type of the item. Always `mcp_call`.

# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
# `calling`, or `failed`.
#
# @see OpenAI::Models::Responses::ResponseItem::McpCall#status
module Status
extend OpenAI::Internal::Type::Enum

IN_PROGRESS = :in_progress
COMPLETED = :completed
INCOMPLETE = :incomplete
CALLING = :calling
FAILED = :failed

# @!method self.values
# @return [Array<Symbol>]
end
end

# @!method self.variants
Expand Down
38 changes: 37 additions & 1 deletion lib/openai/models/responses/response_output_item.rb
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,14 @@ class McpCall < OpenAI::Internal::Type::BaseModel
# @return [Symbol, :mcp_call]
required :type, const: :mcp_call

# @!attribute approval_request_id
# Unique identifier for the MCP tool call approval request. Include this value in
# a subsequent `mcp_approval_response` input to approve or reject the
# corresponding tool call.
#
# @return [String, nil]
optional :approval_request_id, String, nil?: true

# @!attribute error
# The error from the tool call, if any.
#
Expand All @@ -275,7 +283,14 @@ class McpCall < OpenAI::Internal::Type::BaseModel
# @return [String, nil]
optional :output, String, nil?: true

# @!method initialize(id:, arguments:, name:, server_label:, error: nil, output: nil, type: :mcp_call)
# @!attribute status
# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
# `calling`, or `failed`.
#
# @return [Symbol, OpenAI::Models::Responses::ResponseOutputItem::McpCall::Status, nil]
optional :status, enum: -> { OpenAI::Responses::ResponseOutputItem::McpCall::Status }

# @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call)
# Some parameter documentations has been truncated, see
# {OpenAI::Models::Responses::ResponseOutputItem::McpCall} for more details.
#
Expand All @@ -289,11 +304,32 @@ class McpCall < OpenAI::Internal::Type::BaseModel
#
# @param server_label [String] The label of the MCP server running the tool.
#
# @param approval_request_id [String, nil] Unique identifier for the MCP tool call approval request.
#
# @param error [String, nil] The error from the tool call, if any.
#
# @param output [String, nil] The output from the tool call.
#
# @param status [Symbol, OpenAI::Models::Responses::ResponseOutputItem::McpCall::Status] The status of the tool call. One of `in_progress`, `completed`, `incomplete`, `c
#
# @param type [Symbol, :mcp_call] The type of the item. Always `mcp_call`.

# The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
# `calling`, or `failed`.
#
# @see OpenAI::Models::Responses::ResponseOutputItem::McpCall#status
module Status
extend OpenAI::Internal::Type::Enum

IN_PROGRESS = :in_progress
COMPLETED = :completed
INCOMPLETE = :incomplete
CALLING = :calling
FAILED = :failed

# @!method self.values
# @return [Array<Symbol>]
end
end

class McpListTools < OpenAI::Internal::Type::BaseModel
Expand Down
2 changes: 1 addition & 1 deletion lib/openai/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module OpenAI
VERSION = "0.28.0"
VERSION = "0.28.1"
end
Loading