[GH-ISSUE #14688] feat: Remote references in OpenAPI specs for Tool Servers #17333

Closed
opened 2026-04-19 23:04:16 -05:00 by GiteaMirror · 1 comment
Owner

Originally created by @flange-ipb on GitHub (Jun 5, 2025).
Original GitHub issue: https://github.com/open-webui/open-webui/issues/14688

Check Existing Issues

  • I have searched the existing issues and discussions.

Problem Description

OpenAPI specifications may reference other files via $ref, in particular remote and URL references.

Online example: https://msbi.ipb-halle.de/MassBank-api/ui/openapi.yaml (permalink)
When loading this openapi.yaml I end up in the catch block at AddServerModal.svelte#L58 (this is a very unspecific error message BTW). The exception is thrown somewhere in getToolServerData.

Desired Solution you'd like

Maybe it is a good idea to look at the inner workings of the Swagger UI to find reusable code components. Swagger UI is able to lazy-load remote references, for instance open the endpoint specifications in my online example.

Alternatives Considered

No response

Additional Context

Open WebUI version: v0.6.13

Originally created by @flange-ipb on GitHub (Jun 5, 2025). Original GitHub issue: https://github.com/open-webui/open-webui/issues/14688 ### Check Existing Issues - [x] I have searched the existing issues and discussions. ### Problem Description OpenAPI specifications may reference other files via [$ref](https://swagger.io/docs/specification/v3_0/using-ref/#ref-syntax), in particular remote and URL references. Online example: https://msbi.ipb-halle.de/MassBank-api/ui/openapi.yaml ([permalink](https://github.com/MassBank/MassBank3/blob/68e678ed65df7a4ddd17824c0fbd29a8afe7668e/api/openapi.yaml)) When loading this openapi.yaml I end up in the catch block at [AddServerModal.svelte#L58](https://github.com/open-webui/open-webui/blob/main/src/lib/components/AddServerModal.svelte#L58) (this is a very unspecific error message BTW). The exception is thrown somewhere in [getToolServerData](https://github.com/open-webui/open-webui/blob/53764fe64884da147359e54ed6d9607fe57f1600/src/lib/apis/index.ts#L295). ### Desired Solution you'd like Maybe it is a good idea to look at the inner workings of the [Swagger UI](https://github.com/swagger-api/swagger-ui) to find reusable code components. Swagger UI is able to lazy-load remote references, for instance open the endpoint specifications in my [online example](https://msbi.ipb-halle.de/MassBank-api/ui/). ### Alternatives Considered _No response_ ### Additional Context Open WebUI version: v0.6.13
Author
Owner

@tjbck commented on GitHub (Jun 5, 2025):

PR Welcome.

<!-- gh-comment-id:2945246335 --> @tjbck commented on GitHub (Jun 5, 2025): PR Welcome.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#17333