Implement backend endpoint for simulated search results based on GitHub Finesse Data

[CFIALeronB]

Summary

Create a Flask endpoint /search in the Finesse-Backend to serve simulated search results. The endpoint should fetch JSON file contents from a specified GitHub repository and return the file that matches the search query included in the POST request. It should also distinguish between requests for simulated data and requests for real data, which should be fetched from a different source.

Details

• The endpoint should only return simulated data if a specific flag (useSimulatedData) is set to True in the POST request's JSON payload.
• When useSimulatedData is True, the server should:
  • Fetch the list of files from the GitHub repository at https://api.github.com/repos/ai-cfia/finesse-data/contents.
  • Iterate over the files to find a match for the query (case-insensitive).
  • Fetch the content of the matched file using the download_url and return it as the response.
• If no matching file is found, return a 404 response with an appropriate error message.
• If useSimulatedData is False, or the parameter is missing, the server should not attempt to fetch simulated data. Instead, it should:
  • Indicate that real data fetching is not yet implemented (return a 501 response).
  • In the future, this should be replaced with logic to fetch real data from Louis-DB.

Acceptance Criteria

• Endpoint /search accepts a POST request with JSON payload containing query and useSimulatedData.
• Returns matching JSON content from the GitHub repository when useSimulatedData is True.
• Returns an error message when no match is found or when fetching real data.
• Proper error handling for GitHub API interaction.
• Unit tests for new endpoint logic.

[rngadam]

thanks for taking the time to create very complete issues!

[rngadam]

@k-allagbe I see the checklist is not updated. were all the tasks completed or some things postponed to future issues?

[k-allagbe]

@k-allagbe I see the checklist is not updated. were all the tasks completed or some things postponed to future issues?

The implementation is a little different: we have a separate endpoint for each search option. I missed the useSimulateData requirement. In my opinion, separate endpoints is probably okay for now as we don't know which search option is the "default" one yet. But I could definitely come back to this later if required.