Skip to content

Commit c3fe284

Browse files
lesebclaude
andauthored
fix(docs): tag connector endpoints as Connectors for API docs page (#5795)
# What does this PR do? The `/docs/api-experimental/connectors` page returned a 404 because the connector endpoints only had the `Admin` tag (inherited from the `v1alpha_router`). The `Connectors` tag was defined in the OpenAPI spec but no endpoints used it, so the docusaurus OpenAPI plugin never generated a page for it. This adds `tags=["Connectors"]` to the four connector route decorators in `src/ogx_api/admin/fastapi_routes.py` and regenerates the OpenAPI specs. The endpoints now carry both `Admin` and `Connectors` tags, so the plugin generates a dedicated Connectors page. ## Test Plan 1. Run `uv run ./scripts/run_openapi_generator.sh` and verify the experimental spec has `- Connectors` under each connector endpoint's tags 2. Run `uv run pre-commit run --all-files` — all checks pass 3. Run `uv run pytest tests/unit/core/ -x` — all 261 tests pass including `test_openapi_schema_has_connectors_endpoints` 4. Generate docs with `npm run gen-api-docs all` and start dev server — verify `/docs/api-experimental/connectors` loads correctly Signed-off-by: Sébastien Han <seb@redhat.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent cd7e63d commit c3fe284

4 files changed

Lines changed: 16 additions & 0 deletions

File tree

client-sdks/stainless/openapi.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3329,6 +3329,7 @@ paths:
33293329
$ref: '#/components/responses/DefaultError'
33303330
tags:
33313331
- Admin
3332+
- Connectors
33323333
summary: List all connectors.
33333334
description: List all configured connectors.
33343335
operationId: list_connectors_v1alpha_admin_connectors_get
@@ -3355,6 +3356,7 @@ paths:
33553356
description: Default Response
33563357
tags:
33573358
- Admin
3359+
- Connectors
33583360
summary: Get a tool by name from a connector.
33593361
description: Get a tool definition by its name from a connector.
33603362
operationId: get_connector_tool_v1alpha_admin_connectors__connector_id__tools__tool_name__get
@@ -3408,6 +3410,7 @@ paths:
34083410
description: Default Response
34093411
tags:
34103412
- Admin
3413+
- Connectors
34113414
summary: List tools from a connector.
34123415
description: List all tools available from a connector.
34133416
operationId: list_connector_tools_v1alpha_admin_connectors__connector_id__tools_get
@@ -3453,6 +3456,7 @@ paths:
34533456
description: Default Response
34543457
tags:
34553458
- Admin
3459+
- Connectors
34563460
summary: Get a connector by its ID.
34573461
description: Get a connector by its ID.
34583462
operationId: get_connector_v1alpha_admin_connectors__connector_id__get

docs/static/experimental-ogx-spec.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,7 @@ paths:
225225
$ref: '#/components/responses/DefaultError'
226226
tags:
227227
- Admin
228+
- Connectors
228229
summary: List all connectors.
229230
description: List all configured connectors.
230231
operationId: list_connectors_v1alpha_admin_connectors_get
@@ -251,6 +252,7 @@ paths:
251252
description: Default Response
252253
tags:
253254
- Admin
255+
- Connectors
254256
summary: Get a tool by name from a connector.
255257
description: Get a tool definition by its name from a connector.
256258
operationId: get_connector_tool_v1alpha_admin_connectors__connector_id__tools__tool_name__get
@@ -304,6 +306,7 @@ paths:
304306
description: Default Response
305307
tags:
306308
- Admin
309+
- Connectors
307310
summary: List tools from a connector.
308311
description: List all tools available from a connector.
309312
operationId: list_connector_tools_v1alpha_admin_connectors__connector_id__tools_get
@@ -349,6 +352,7 @@ paths:
349352
description: Default Response
350353
tags:
351354
- Admin
355+
- Connectors
352356
summary: Get a connector by its ID.
353357
description: Get a connector by its ID.
354358
operationId: get_connector_v1alpha_admin_connectors__connector_id__get

docs/static/stainless-ogx-spec.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3329,6 +3329,7 @@ paths:
33293329
$ref: '#/components/responses/DefaultError'
33303330
tags:
33313331
- Admin
3332+
- Connectors
33323333
summary: List all connectors.
33333334
description: List all configured connectors.
33343335
operationId: list_connectors_v1alpha_admin_connectors_get
@@ -3355,6 +3356,7 @@ paths:
33553356
description: Default Response
33563357
tags:
33573358
- Admin
3359+
- Connectors
33583360
summary: Get a tool by name from a connector.
33593361
description: Get a tool definition by its name from a connector.
33603362
operationId: get_connector_tool_v1alpha_admin_connectors__connector_id__tools__tool_name__get
@@ -3408,6 +3410,7 @@ paths:
34083410
description: Default Response
34093411
tags:
34103412
- Admin
3413+
- Connectors
34113414
summary: List tools from a connector.
34123415
description: List all tools available from a connector.
34133416
operationId: list_connector_tools_v1alpha_admin_connectors__connector_id__tools_get
@@ -3453,6 +3456,7 @@ paths:
34533456
description: Default Response
34543457
tags:
34553458
- Admin
3459+
- Connectors
34563460
summary: Get a connector by its ID.
34573461
description: Get a connector by its ID.
34583462
operationId: get_connector_v1alpha_admin_connectors__connector_id__get

src/ogx_api/admin/fastapi_routes.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ async def version() -> VersionInfo:
135135
response_model=ListConnectorsResponse,
136136
summary="List all connectors.",
137137
description="List all configured connectors.",
138+
tags=["Connectors"],
138139
)
139140
async def list_connectors() -> ListConnectorsResponse:
140141
return await impl.list_connectors()
@@ -144,6 +145,7 @@ async def list_connectors() -> ListConnectorsResponse:
144145
response_model=ToolDef,
145146
summary="Get a tool by name from a connector.",
146147
description="Get a tool definition by its name from a connector.",
148+
tags=["Connectors"],
147149
)
148150
async def get_connector_tool(
149151
connector_id: Annotated[str, Path(description="Identifier for the connector")],
@@ -158,6 +160,7 @@ async def get_connector_tool(
158160
response_model=ListToolsResponse,
159161
summary="List tools from a connector.",
160162
description="List all tools available from a connector.",
163+
tags=["Connectors"],
161164
)
162165
async def list_connector_tools(
163166
request: Annotated[ListConnectorToolsRequest, Depends(list_connector_tools_request)],
@@ -170,6 +173,7 @@ async def list_connector_tools(
170173
response_model=Connector,
171174
summary="Get a connector by its ID.",
172175
description="Get a connector by its ID.",
176+
tags=["Connectors"],
173177
)
174178
async def get_connector(
175179
request: Annotated[GetConnectorRequest, Depends(get_connector_request)],

0 commit comments

Comments
 (0)