[ROMM-2874] Feature/updated-after-query-param

[BrandonKowalski]

Description
^{Explain the changes or enhancements you are proposing with this pull request.}
For #2874

Adds updated_after as a query parameter to the /api/platforms and /api/roms endpoints.

Additionally, added a DB migration to add indexes to the updated_at field on the respective tables.

It has been a while since I've python-ed. I tried to follow existing examples (especially for the migration stuff as I've never used Alembic).

This will allow client applications to perform more efficient updates to their local caches by only pulling a delta.

Checklist
^{Please check all that apply.}

• I've tested the changes locally
• I've updated relevant comments (in the OpenAPI spec)
• I've assigned reviewers for this PR
• I've added unit tests that cover the changes

[gemini-code-assist]

Summary of Changes

Hello @BrandonKowalski, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the API by introducing an updated_after query parameter to the /api/platforms and /api/roms endpoints. This allows client applications to request only data that has been modified since a specified timestamp, significantly improving the efficiency of local cache synchronization. To support these new filtering capabilities, a database migration has been included to add indexes to the updated_at fields on the roms and platforms tables, ensuring optimal query performance.

Highlights

• New Query Parameter: Introduced an updated_after query parameter for the /api/platforms and /api/roms endpoints, allowing clients to fetch only data modified after a specific timestamp for efficient delta updates.
• Database Migration for Indexing: Added a new Alembic database migration (0064_add_updated_at_indexes) to create non-unique indexes on the updated_at columns of the roms and platforms tables, enhancing query performance for the new updated_after filter.
• API Endpoint Logic Update: Modified the internal logic of the get_platforms and get_roms endpoint handlers to accept and apply the updated_after filtering condition to database queries.
• OpenAPI Specification Update: Updated relevant comments in the OpenAPI specification to reflect the addition of the new updated_after query parameter.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a useful updated_after query parameter to the /api/platforms and /api/roms endpoints, allowing for more efficient data synchronization. The database migration to add indexes on the updated_at columns is also a great addition for performance. The implementation is clean and follows existing patterns in the codebase.

I've added a couple of suggestions to clarify the API documentation regarding timezone handling for the new parameter, which will help prevent potential bugs.

Additionally, I noticed that unit tests for this new functionality haven't been added yet. It would be beneficial to include tests that verify the updated_after filter works correctly to ensure long-term stability of this feature.

Overall, great work on this feature!

[gantoine]

try and run npm run generete to see if the openapi files change