Update endpoints and repo structure to support versioning #9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AbidemiAdio
reviewed
Sep 24, 2025
AbidemiAdio
reviewed
Sep 24, 2025
AbidemiAdio
reviewed
Sep 24, 2025
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://eaflood.atlassian.net/browse/SFD2-293
Refactor
This PR refactors the endpoints to use a consistent approach with each route using the
repos/metadatafunctions to interact with the database.Versioning
The API now supports versioning for future proofing the service as it evolves, currently this gives endpoints a
v1prefix but will evolve over time.Documentation
Openapi documentation has been created but this is a WIP due to not knowing enough about the metadata. The contract and documentation will evolve over the next few PRs.
The openapi documentation is available on the
/documentationendpoint