Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/algo config api update #54

Merged
merged 17 commits into from
Oct 4, 2024
Merged

Conversation

cbrinson-rise8
Copy link
Collaborator

@cbrinson-rise8 cbrinson-rise8 commented Oct 1, 2024

Description

Update the API link-record endpoint to only accept one argument for specifying the algorithm, and create a new endpoint to list the available algorithms.

  • create a new endpoint, algorithms that will list the available algorithms based on the database configuration
  • update the link-record endpoint to accept just 1 parameter for the algorithm to use
  • test cases for the changes above
  • update OpenAPI docs for the endpoint changes

Related Issues

closes #15

Additional Notes

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.
  • I have notified teammates in the review thread to build awareness.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

@cbrinson-rise8 cbrinson-rise8 added the enhancement New feature or request label Oct 1, 2024
@cbrinson-rise8 cbrinson-rise8 self-assigned this Oct 1, 2024
@ericbuckley
Copy link
Collaborator

@cbrinson-rise8 make sure to add your name to the authors list in this PR!

Copy link
Collaborator

@ericbuckley ericbuckley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for all the unit tests!

@cbrinson-rise8 cbrinson-rise8 merged commit e1951f5 into main Oct 4, 2024
4 checks passed
@cbrinson-rise8 cbrinson-rise8 deleted the feat/algo-config-api-update branch October 4, 2024 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update API with Algorithm configuration changes
2 participants