feat(api)!: deprecate toolgroup and tool_runtime apis (#4249)

# What does this PR do?
marks `toolgroup` and `tool_runtime` APIs for deprecation 

<!-- If resolving an issue, uncomment and update the line below -->
Closes #4233 and #4061 (partially)

How long do we wait before we remove deprecated APIs?

## Test Plan
<!-- Describe the tests you ran to verify your changes with result
summaries. *Provide clear instructions so the plan can be easily
re-executed.* -->

Signed-off-by: Jaideep Rao <jrao@redhat.com>
This commit is contained in:
Jaideep Rao 2025-12-02 01:13:58 +05:30 committed by GitHub
parent 618c03405c
commit 89807dc117
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 175 additions and 234 deletions

View file

@ -378,6 +378,91 @@ paths:
type: string
description: 'Path parameter: identifier'
deprecated: true
/v1/tool-runtime/invoke:
post:
responses:
'200':
description: A ToolInvocationResult.
content:
application/json:
schema:
$ref: '#/components/schemas/ToolInvocationResult'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
tags:
- Tool Runtime
summary: Invoke Tool
description: Run a tool with the given arguments.
operationId: invoke_tool_v1_tool_runtime_invoke_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InvokeToolRequest'
required: true
deprecated: true
/v1/tool-runtime/list-tools:
get:
responses:
'200':
description: A ListToolDefsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListToolDefsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
tags:
- Tool Runtime
summary: List Runtime Tools
description: List all tools in the runtime.
operationId: list_runtime_tools_v1_tool_runtime_list_tools_get
parameters:
- name: authorization
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
- name: tool_group_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Tool Group Id
- name: mcp_endpoint
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/URL'
- type: 'null'
title: Mcp Endpoint
deprecated: true
/v1/toolgroups:
get:
responses:
@ -404,6 +489,7 @@ paths:
summary: List Tool Groups
description: List tool groups with optional provider.
operationId: list_tool_groups_v1_toolgroups_get
deprecated: true
post:
responses:
'400':
@ -465,6 +551,7 @@ paths:
schema:
type: string
description: 'Path parameter: toolgroup_id'
deprecated: true
delete:
responses:
'400':
@ -494,6 +581,76 @@ paths:
type: string
description: 'Path parameter: toolgroup_id'
deprecated: true
/v1/tools:
get:
responses:
'200':
description: A ListToolDefsResponse.
content:
application/json:
schema:
$ref: '#/components/schemas/ListToolDefsResponse'
'400':
$ref: '#/components/responses/BadRequest400'
description: Bad Request
'429':
$ref: '#/components/responses/TooManyRequests429'
description: Too Many Requests
'500':
$ref: '#/components/responses/InternalServerError500'
description: Internal Server Error
default:
$ref: '#/components/responses/DefaultError'
description: Default Response
tags:
- Tool Groups
summary: List Tools
description: List tools with optional tool group.
operationId: list_tools_v1_tools_get
parameters:
- name: toolgroup_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Toolgroup Id
deprecated: true
/v1/tools/{tool_name}:
get:
responses:
'200':
description: A ToolDef.
content:
application/json:
schema:
$ref: '#/components/schemas/ToolDef'
'400':
description: Bad Request
$ref: '#/components/responses/BadRequest400'
'429':
description: Too Many Requests
$ref: '#/components/responses/TooManyRequests429'
'500':
description: Internal Server Error
$ref: '#/components/responses/InternalServerError500'
default:
description: Default Response
$ref: '#/components/responses/DefaultError'
tags:
- Tool Groups
summary: Get Tool
description: Get a tool by its name.
operationId: get_tool_v1_tools__tool_name__get
parameters:
- name: tool_name
in: path
required: true
schema:
type: string
description: 'Path parameter: tool_name'
deprecated: true
/v1beta/datasets:
get:
responses: