Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace openapi3 library with our own implementation #7613

Open
Tracked by #7729
vblagoje opened this issue Apr 29, 2024 · 0 comments
Open
Tracked by #7729

Replace openapi3 library with our own implementation #7613

vblagoje opened this issue Apr 29, 2024 · 0 comments
Labels
2.x Related to Haystack v2.0 P2 Medium priority, add to the next sprint if no P1 available

Comments

@vblagoje
Copy link
Member

Description:
We are currently using an open-source OpenAPI invocation library that appears to be in maintenance mode, with a growing backlog of unmerged pull requests and unresolved bugs. These issues have caused significant challenges, particularly related to the inflexible response validation mechanism and various schema-related bugs. The current library's limitations hinder our ability to control and fix bugs in the API interaction layer, which is critical for our operations, especially as these do not align with the requirements of LLMs where schema validation is not a priority.

Proposed Solution:
Replace the existing OpenAPI library with our custom code which offers better error handling, eliminates outdated authentication mechanisms, and removes unnecessary JSON parsing processes. This change aims to provide a more robust, flexible, and maintainable framework for API interactions within our services.

Expected Benefits:

  • Increased control and flexibility in handling API interactions and validations, allowing for optional response schema validation.
  • Improved error handling with structured JSON error responses, enhancing the robustness of our service connectors.
  • Simplified codebase by removing obsolete authentication mechanisms and redundant parsing logic, making the system easier to maintain and extend.

Impact:
This change will require updates to existing unit tests and the addition of a new integration test. It is crucial to verify that the transition retains all intended functionalities and integrates seamlessly with existing systems.

@vblagoje vblagoje added the 2.x Related to Haystack v2.0 label Apr 29, 2024
@vblagoje vblagoje changed the title Replace openapi3 library with our own implementation of OpenAPI Replace openapi3 library with our own implementation Apr 29, 2024
@masci masci added the P2 Medium priority, add to the next sprint if no P1 available label May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Related to Haystack v2.0 P2 Medium priority, add to the next sprint if no P1 available
Projects
None yet
Development

No branches or pull requests

2 participants