From aa81382704ccec7a8da108ef5c293845a9468c8f Mon Sep 17 00:00:00 2001 From: Vaughan Knight Date: Mon, 17 Jun 2024 10:10:25 +1000 Subject: [PATCH] Removed accidental file Removed accidental file --- .../decisions/0016-watt-time-v3.md | 62 ------------------- 1 file changed, 62 deletions(-) delete mode 100644 docs/architecture/decisions/0016-watt-time-v3.md diff --git a/docs/architecture/decisions/0016-watt-time-v3.md b/docs/architecture/decisions/0016-watt-time-v3.md deleted file mode 100644 index 661f38262..000000000 --- a/docs/architecture/decisions/0016-watt-time-v3.md +++ /dev/null @@ -1,62 +0,0 @@ - -# 0015. WattTime v3 Changes - -## Status - -Proposed - -## Context -As part of the update to Watt Time v3 we are proposing the changes to the underlying API calls. This needs to be tracked so we understand the impacts, and if multiple options are available, which option was selected and why. - -This wll impact the `CarbonAware.DataSources.WattTime` project primarily. - -## Decision - -The proposal is for the outlined WattTime API mapping and changes. - -## WattTime v2, v3 Mapping - -The following document and guidelines was used to understand the impact to the Carbon Aware SDK for the WattTime v3 updates. https://docs.watttime.org/#tag/Transitioning-from-APIv2-to-APIv3 - -### Base URL -The base URL will need to change. -> TODO: Add where this is configured - -|Base URL (v2) | Based URL (v3) | -|---|---| -| /v2 | /v3 | - - -### Paths -The paths will also need to change. - -The following is configured at `CarbonAware.DataSources.WattTime/src/Constants/Paths.cs` - -| API Endpoint | Description | Path (v2) | Path (v3) | Notes | -|--------------|-------------|-----------|-----------|---| -| Data | Get data | /data | /historical | Parameter changes outlined below. Start and End are now mandatory. | -| Forecast | Get forecast| /forecast | /forecast | Forecast parameters have undergone broader changes, and it can no longer be used for historical data -| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | **We need to validate why historical was being used for the API, and what historical used to be, and whether this should be the new /forecast/historical or not.** -| BalancingAuthorityFromLocation | Get balancing authority from location | /ba-from-loc | /region-from-loc | Parameter changes are only `signal_type` | -| Login | User login | https://api2.watttime.org/v2/login | https://api.watttime.org/login | No other changes, but note **the path change is not in the same API path for `login` and other paths** | - -### Query Strings - -#### Signal Type -Everything call takes an optional `signal_type` parameter that defaults to `co2_moer`. - -The following comes from `CarbonAware.DataSources.WattTime/src/Constants/QueryStrings.cs` - -| Query String (v2) | Query String (v3) | Description | -|------------------------------------|----------------------------------|------------------------------| -| ba | region | Balancing Authority / Region | -| starttime | start | Start Time | -| endtime | end | End Time | -| latitude | | Latitude | -| longitude | | Longitude | -| username | | Username | - -## Green Impact - -Neutral -