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

Streamline CarbonAware Model classes and remove redundancy/ambiguity #254

Open
5 of 8 tasks
shineyk opened this issue Feb 9, 2023 · 1 comment
Open
5 of 8 tasks
Assignees

Comments

@shineyk
Copy link

shineyk commented Feb 9, 2023

Description

As a Carbon Aware Application Developer, I want to clean the code to remove redundant classes and establish clear boundaries between different models thereby reducing complexity and bringing clarity to the repo.

Currently, there are similar model classes in the GSF library, CarbonAware project and the Consumer layers as listed below -

<style> </style>
CarbonAware project GSF library WebAPI CLI
EmissionsData EmissionsData EmissionsDataDTO EmissionsDataDTO
EmissionsForecast EmissionsForecast EmissionsForecastDTO EmissionsForecastDTO

Each Consumer layer should have its own DTO that may not be identical to another consumer layer to help normalize the data. The common model should only contain fields received from the data source response and the user input fields should reside in the consumer DTO models.

Acceptance Criteria

Checklist

  • Ensure that the consumers (CLI and WebAI) return data in their own format
  • User-input parameters should be set in the response by the consumer layer
  • A list of the fields retrieving from the backend and the list of fields that are returning user-inputted values - added to Class documentation

Documentation:

Dependencies

Green-Software-Foundation#269

Sprint-Ready Checklist

  • Acceptance criteria defined
  • Acceptance criteria is verifiable / testable
  • External / 3rd Party dependencies identified
  • Engineering team understands acceptance criteria
  • Is the user story small enough to be implemented in a short amount of time, but large enough to provide value?
@pritipath pritipath self-assigned this Feb 9, 2023
@pritipath pritipath changed the title Reconcile DTO for CLI and WebAPI Streamline CarbonAware Model classes and remove redundancy/ambiguity Feb 10, 2023
@juzuluag
Copy link

PR: Green-Software-Foundation#297

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants