chore: improve api definition #12
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the API definition by replacing confluence-specific endpoints and models with more general source upload endpoints, enabling the system to support arbitrary knowledge sources. Key changes include the removal of confluence parameters and loader code, the renaming and refactoring of extractor API methods, and corresponding updates to the OpenAPI specification and README documentation.
Reviewed Changes
Copilot reviewed 79 out of 79 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| extraction_parameters.py | Introduces ExtractionParameters for general source uploads. |
| content_type.py | Minor clean-up of imports and formatting. |
| confluence_parameters.py | Removed to deprecate confluence-specific functionality. |
| init.py (models) | Updated to only import relevant models. |
| exceptions.py, configuration.py, api_response.py, api_client.py | Reordering and minor adjustments to imports and logging. |
| extractor_api.py | Renamed and refactored extractor API methods from confluence to source/file endpoints. |
| admin_api_base.py, admin_api.py | Renamed endpoints and updated parameters for source and file uploads. |
| dependency_container.py | Updated dependency injection to replace confluence loader with source uploader. |
| openapi.yaml | Adjusted endpoint definitions and schema references to match the new API design. |
| README.md | Updated documentation to reflect the new endpoints and extractor changes. |
| API endpoint files (source_uploader.py, file_uploader.py) | Introduced abstract classes for handling source and file uploads. |
|
|
||
| Loads all the content of a confluence space using the [document-extractor](#3-extractor-api-lib). | ||
| Loads all the content from an abritrary non-file source using the [document-extractor](#3-extractor-api-lib). |
There was a problem hiding this comment.
The word 'abritrary' appears to be misspelled; please correct it to 'arbitrary'.
Suggested change
| Loads all the content from an abritrary non-file source using the [document-extractor](#3-extractor-api-lib). | |
| Loads all the content from an arbitrary non-file source using the [document-extractor](#3-extractor-api-lib). |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change the confluence upload endpoint to a general source upload endpoint.
This will make it easier to add arbitrary knowledge sources and their respective extractors.
This PR will make breaking changes to the definition of the extractor and the admin backend.