Skip to content

chore: improve api definition #12

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

Draft
wants to merge 28 commits into
base: main
Choose a base branch
from
Draft

chore: improve api definition #12

wants to merge 28 commits into from

Conversation

MelvinKl
Copy link
Collaborator

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.

@a-klos a-klos requested a review from Copilot May 23, 2025 05:00
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).
Copy link
Preview

Copilot AI May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants