I have searched the existing issues and discussions.
Problem Description
Hi, there are some great OpenAPI compatible projects out there like Obsidian, but their OpenAPI.json is often published elsewhere not via the endpoint. The OpenAPI standard does not require the OpenAPI.json or OpenAPI.yaml to be available via the endpoint.
Wondering if it would be possible to allow custom paths to the OpenAPI.json for tool servers to better cope with these naughty projects.
This approach may also allow some customisation \ tuning as to what commands are exposed.
Alternatives Considered
Currently overcoming via a reverse proxy and intercepting the /openapi.json
Additional Context
No response
Originally created by @spammenotinoz on GitHub (Apr 23, 2025).
Original GitHub issue: https://github.com/open-webui/open-webui/issues/13160
Originally assigned to: @tjbck on GitHub.
### Check Existing Issues
- [x] I have searched the existing issues and discussions.
### Problem Description
Hi, there are some great OpenAPI compatible projects out there like Obsidian, but their OpenAPI.json is often published elsewhere not via the endpoint. The OpenAPI standard does not require the OpenAPI.json or OpenAPI.yaml to be available via the endpoint.
Eg: for the Obsidian Rest API the OpenAPI.yaml is located on github.io and not via the endpoint.
https://[coddingtonbear.github.io/obsidian-local-rest-api/openapi.yaml](https://coddingtonbear.github.io/obsidian-local-rest-api/openapi.yaml)
### Desired Solution you'd like
Wondering if it would be possible to allow custom paths to the OpenAPI.json for tool servers to better cope with these naughty projects.
This approach may also allow some customisation \ tuning as to what commands are exposed.
### Alternatives Considered
Currently overcoming via a reverse proxy and intercepting the /openapi.json
### Additional Context
_No response_
Agreed this must be supported, PR welcome here but eventually I'll be taking a look.
<!-- gh-comment-id:2823136938 -->
@tjbck commented on GitHub (Apr 23, 2025):
Agreed this must be supported, PR welcome here but eventually I'll be taking a look.
Might as well also support uploading the openapi.json as a file. For example todoist don't even expose their openapi.json endpoint, but require you to download it https://developer.todoist.com/api/v1 (top)
<!-- gh-comment-id:2902509133 -->
@Lutherwaves commented on GitHub (May 22, 2025):
Might as well also support uploading the openapi.json as a file. For example todoist don't even expose their openapi.json endpoint, but require you to download it https://developer.todoist.com/api/v1 (top)
<img width="1384" alt="Image" src="https://github.com/user-attachments/assets/19bbe852-e52d-4ac6-9e06-baee424d3c33" />
Might as well also support uploading the openapi.json as a file. For example todoist don't even expose their openapi.json endpoint, but require you to download it https://developer.todoist.com/api/v1 (top)
@tjbck should I open a sepratae issue for supporting uploading the openapi spec?
<!-- gh-comment-id:2910626152 -->
@Lutherwaves commented on GitHub (May 26, 2025):
> Might as well also support uploading the openapi.json as a file. For example todoist don't even expose their openapi.json endpoint, but require you to download it https://developer.todoist.com/api/v1 (top)
>
> <img width="1384" alt="Image" src="https://github.com/user-attachments/assets/19bbe852-e52d-4ac6-9e06-baee424d3c33" />
@tjbck should I open a sepratae issue for supporting uploading the openapi spec?
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Originally created by @spammenotinoz on GitHub (Apr 23, 2025).
Original GitHub issue: https://github.com/open-webui/open-webui/issues/13160
Originally assigned to: @tjbck on GitHub.
Check Existing Issues
Problem Description
Hi, there are some great OpenAPI compatible projects out there like Obsidian, but their OpenAPI.json is often published elsewhere not via the endpoint. The OpenAPI standard does not require the OpenAPI.json or OpenAPI.yaml to be available via the endpoint.
Eg: for the Obsidian Rest API the OpenAPI.yaml is located on github.io and not via the endpoint.
https://coddingtonbear.github.io/obsidian-local-rest-api/openapi.yaml
Desired Solution you'd like
Wondering if it would be possible to allow custom paths to the OpenAPI.json for tool servers to better cope with these naughty projects.
This approach may also allow some customisation \ tuning as to what commands are exposed.
Alternatives Considered
Currently overcoming via a reverse proxy and intercepting the /openapi.json
Additional Context
No response
@tjbck commented on GitHub (Apr 23, 2025):
Agreed this must be supported, PR welcome here but eventually I'll be taking a look.
@Lutherwaves commented on GitHub (May 22, 2025):
Might as well also support uploading the openapi.json as a file. For example todoist don't even expose their openapi.json endpoint, but require you to download it https://developer.todoist.com/api/v1 (top)
@tjbck commented on GitHub (May 26, 2025):
Added with
2c7ccc69fe@Lutherwaves commented on GitHub (May 26, 2025):
@tjbck should I open a sepratae issue for supporting uploading the openapi spec?
@tjbck commented on GitHub (May 26, 2025):
Sounds good!
@Lutherwaves commented on GitHub (May 28, 2025):
https://github.com/open-webui/open-webui/issues/14446