What's Changed

1. Endpoint Update

• Affected Endpoints: The changes impact two API endpoints: -- POST /api/v1/database-connections: This endpoint is used to create a database connection. -- PUT /api/v1/database-connections/{db_connection_id}: This endpoint is used to update a database connection.

• Change Description: The llm_credentials object in these endpoints has been replaced with the llm_api_key field, which now only accepts strings as its value. In other words, the llm_credentials field has been removed, and it has been replaced with a simpler llm_api_key field that can only hold string values. This change suggests a more straightforward approach to managing API keys or credentials within the system.

5. Migration Script

• Purpose: A migration script has been introduced to assist users in smoothly transitioning their data from version 0.0.4 to version 0.0.5.

• Data Modification: This script operates on the data_connections collection and performs the following action: It replaces the llm_credentials field with the llm_api_key field but only if the llm_credentials field is populated in the data. In other words, if there is data in the llm_credentials field, the script will transfer it to the new llm_api_key field.

To run the migration script, use the following command:

docker-compose exec app python3 -m dataherald.scripts.migrate_v004_to_v005

These changes will improve the consistency and maintainability of your application's data structures and APIs. If you encounter any issues during the upgrade process, please don't hesitate to reach out to our support team.

New Contributors

• @roy-moven https://github.com/roy-moven/dataherald/commit/09f5fe895d9eb37ebf8056b75aeeab48a70a058d
• @ppmarkus https://github.com/Dataherald/dataherald/pull/226/files
• @ishaan-jaff https://github.com/Dataherald/dataherald/pull/154/files
• @lpxiangyan9 https://github.com/Dataherald/dataherald/issues/196
• @mrtunguyen https://github.com/Dataherald/dataherald/issues/187