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

API inputs endpoint should validate and inform whether inputs are available #1322

Open
mabijkerk opened this issue Feb 8, 2023 · 2 comments
Assignees
Labels
API Enhancement Pinned Will never be marked as stale or auto-closed.

Comments

@mabijkerk
Copy link
Member

mabijkerk commented Feb 8, 2023

Problem
The current implementation of the inputs endpoint of the API extracts all the inputs that are available on ETSource. The issue is that users do not know whether they should use all these inputs:

  • Some of those inputs however may be outdated and have long been removed from the frontend of ETModel. There is therefore no guarantee that these inputs still function properly. In some cases, specifying values for these inputs may cause unintended results, as in Remove aggregated inputs etsource#2839.
  • Some of those inputs may only be relevant for certain specific modules, such as the external coupling module to the CTM, or specific inputs for the Holon project.

Solution
The goal of this enhancement is therefore twofold:

  1. Allow ETEngine to validate whether inputs are available for a certain scenario
  2. Present the user with information about this validation, and present information where relevant for other modules. An example may be to add an attribute that can attain the values available, unavailable and external module

@noracato I think there are multiple possible solutions for this issue. For example, we could also simply remove all inputs that are not marked as available, or we could remove all the inputs that are outdated from ETSource etc. I'm happy to brainstorm what solution would be best to implement.

Notifying @ChaelKruip

@github-actions
Copy link

This issue has had no activity for 60 days and will be closed in 7 days. Removing the "Stale" label or posting a comment will prevent it from being closed automatically. You can also add the "Pinned" label to ensure it isn't marked as stale in the future.

@github-actions github-actions bot added the Stale Issue had no activity for 60 days and will be, or has been, closed. label Apr 10, 2023
@mabijkerk mabijkerk removed the Stale Issue had no activity for 60 days and will be, or has been, closed. label Apr 11, 2023
@mabijkerk
Copy link
Member Author

See also quintel/etsource#2858

@mabijkerk mabijkerk added the Pinned Will never be marked as stale or auto-closed. label Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Enhancement Pinned Will never be marked as stale or auto-closed.
Projects
None yet
Development

No branches or pull requests

2 participants