0.0.4
版本发布时间: 2023-10-07 04:46:17
Dataherald/dataherald最新发布版本:1.0.3(2024-04-30 23:22:47)
What's Changed https://github.com/Dataherald/dataherald/commit/f57fde563ba336f304ecb244aaec35d1ac2dc53e
1. Endpoint Renaming We have streamlined our API endpoints for better consistency and clarity:
Renamed Endpoints:
- POST /api/v1/nl-query-responses is now POST /api/v1/responses.
- POST /api/v1/question is now POST /api/v1/questions.
2. Endpoint Removal In this version, we have removed the following endpoint:
- PATCH /api/v1/nl-query-responses/{query_id}.
Note: Responses resources are now immutable, so you can only create new responses and not update existing ones.
3. MongoDB Collection and Field Renaming To improve consistency and readability, we have renamed MongoDB collection and field names:
Collection Name Changes:
- nl_questions collection has been renamed to questions.
- nl_query_responses collection has been renamed to responses.
Field Name Changes (within the responses collection):
- nl_question_id has been renamed to question_id.
- nl_response has been renamed to response.
4. Use of ObjectId for Foreign Keys To enhance data integrity and relationships, we have transitioned to using ObjectId types for foreign keys, providing stronger data typing.
5. Migration Script We've created a migration script to help you smoothly transition your data from version 0.0.3 to version 0.0.4. This script updates collection names, field names, and foreign keys data type to ObjectId. To run the migration script, use the following command:
docker-compose exec app python3 -m dataherald.scripts.migrate_v003_to_v004
Upgrade Instructions:
To upgrade to Version 0.0.4, follow these steps:
- Ensure you have Docker Compose installed.
- Pull the latest version of the application.
- Run the provided migration script as shown above.
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.