Skip to content

Commit d665c5d

Browse files
lesebclaude
andauthored
docs: update stale /v1/tools references to /v1/admin/tools (ogx-ai#5816)
# What does this PR do? Updates three documentation pages that still referenced the old `/v1/tools` endpoint path after ogx-ai#5787 moved it to `/v1/admin/tools`. Files updated: - `docs/src/pages/index.js` — landing page API grid - `docs/docs/api-overview.mdx` — API reference overview - `docs/docs/building_applications/tools.mdx` — tools guide prose ## Test Plan 1. Run the docs dev server: `cd docs && npm install && npx docusaurus gen-api-docs all && npx docusaurus start` 2. Verify the landing page API grid shows `/v1/admin/tools` 3. Verify `/docs/api-overview` shows `/v1/admin/tools` in the stable section 4. Verify `/docs/building_applications/tools` prose references `/v1/admin/tools` Signed-off-by: Sébastien Han <seb@redhat.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 6c83f19 commit d665c5d

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/docs/api-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ OGX implements the OpenAI API and organizes endpoints by stability level. Use an
2020
{ title: 'Files', endpoint: '/v1/files', href: '/docs/api/files', blurb: 'File upload and management' },
2121
{ title: 'Vector IO', endpoint: '/v1/vector_stores', href: '/docs/api/vector-io', blurb: 'Document storage and semantic search' },
2222
{ title: 'Batches', endpoint: '/v1/batches', href: '/docs/api/batches', blurb: 'Offline batch processing' },
23-
{ title: 'Tools', endpoint: '/v1/tools', href: '/docs/api/tools', blurb: 'Tool listing and management' },
23+
{ title: 'Tools', endpoint: '/v1/admin/tools', href: '/docs/api/tools', blurb: 'Tool listing and management' },
2424
{ title: 'Conversations', endpoint: '/v1/conversations', href: '/docs/api/conversations', blurb: 'Conversation state management' },
2525
{ title: 'Prompts', endpoint: '/v1/prompts', href: '/docs/api/prompts', blurb: 'Prompt templates and versioning' },
2626
],

docs/docs/building_applications/tools.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
1111
# Tools
1212

1313
:::note[Tool Configuration Simplified]
14-
Built-in tools (web search, RAG, WolframAlpha) are now auto-registered based on your provider configuration. The `/v1/tools` and `/v1/toolgroups` endpoints are available for tool discovery and management. For MCP servers, use the [Connectors API](/docs/concepts/apis/).
14+
Built-in tools (web search, RAG, WolframAlpha) are now auto-registered based on your provider configuration. The `/v1/admin/tools` and `/v1/toolgroups` endpoints are available for tool discovery and management. For MCP servers, use the [Connectors API](/docs/concepts/apis/).
1515
:::
1616

1717
Tools are functions that can be invoked by an agent to perform tasks. They are organized into tool groups and registered with specific providers. Each tool group represents a collection of related tools from a single provider. They are organized into groups so that state can be externalized: the collection operates on the same state typically.

docs/src/pages/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ const API_SURFACE = [
155155
]},
156156
{ category: 'Moderation & Tools', endpoints: [
157157
{ label: 'Moderations', path: '/v1/moderations' },
158-
{ label: 'Tools', path: '/v1/tools' },
158+
{ label: 'Tools', path: '/v1/admin/tools' },
159159
{ label: 'Connectors', path: '/v1/connectors' },
160160
]},
161161
];

0 commit comments

Comments
 (0)