dify
dify copied to clipboard
Add OpenAPI Schema to App/Knowledge Base API for Easier Client Dev & Integration
Self Checks
- [x] I have searched for existing issues search for existing issues, including closed ones.
- [x] I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
- [x] [FOR CHINESE USERS] 请务必使用英文提交 Issue,否则会被关闭。谢谢!:)
- [x] Please do not modify this template :) and fill in all the required fields.
1. Is this request related to a challenge you're experiencing? Tell me about your story.
Yes, this request stems from challenges I've encountered. I've been searching for a platform that supports agent workflows for the development of my small project. When I discovered this project, I was quite thrilled as it appeared to have great potential. Kudos to the developers and contributors who've made this amazing project possible!
However, when I attempted to utilize the provided APIs for my project, I ran into difficulties. The official SDK doesn't support the programming language I intended to use in my project. Also, the Node.js SDK lacks the knowledge - base related APIs, which are essential for my project's functionality. This lack of support and incomplete API coverage made it challenging for me to progress with the development smoothly.
To address these issues, I came up with the idea of leveraging the openapi generator tool to generate more universal code. Since I was eager to quickly verify the feasibility of using these APIs in my project, I went ahead and developed a project (https://github.com/StrayDragon/dify-openapi) based on this concept. It has out of box swagger ui support and can intergrate quickly. I'm really hoping it could be beneficial to the entire community and that it can identify and fix some errors and issues in the schema in advance.
2. Additional context or comments
I am quite interested in the prospect of contributing my project to this community. But I'm aware that this is a decision that requires careful deliberation. There are multiple ways I could contribute, such as directly adding the schema files to the appropriate section of the repository or transferring the repository permissions to the community. And hey, who knows, there's even a chance my offer could get the ol' "thanks, but no thanks" treatment :) But it's worth a shot, right?
It would be wonderful to have a discussion about the best approach for this contribution. I'm receptive to all suggestions and ideas from community members and maintainers. This will ensure that the contribution fits well with the project's objectives and existing infrastructure.
I hope my project can add value to the community, and I'm looking forward to having a productive conversation about how we can collaborate moving forward.
3. Can you help us with this feature?
- [x] I am interested in contributing to this feature.
ref/fix:
- https://github.com/langgenius/dify/issues/4045