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

Use RalphStatementsQuery model for query parameters in API get signature #433

Open
quitterie-lcs opened this issue Sep 12, 2023 · 0 comments

Comments

@quitterie-lcs
Copy link
Contributor

Purpose

The signature of get statements method in API router is highly descriptive and can be quite long and confusing to read and understand for developers. Most part of this signature is the LRS query parameter for Statements Resource.

Furthermore, a recent refacto of the LRS query parameter used in Ralph backend was applied on the API router to parse query parameters.

Proposal

An improvement would be to reuse the RalphStatementsQuery model to specify the signature of the LRS query statements resource router methods. This would be beneficial to avoid redefinition and respecification for the same data and reduce typing errors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

2 participants