Skip to content

Commit

Permalink
fixed docusaurus (strict) compilation error
Browse files Browse the repository at this point in the history
  • Loading branch information
danuw committed Aug 6, 2024
1 parent e73897e commit 53e120c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
26 changes: 13 additions & 13 deletions casdk-docs/blog/2024-02-13-release-1.5.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,25 @@ This is the WattTime v3 update. Most notable changes that may require action ar

WattTime v3 API support. This is an inplace upgrade for v2.

- [PR #532] Watt Time v3 Support ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/532)
- [PR #340] Add example for 'podman play kube' ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/340)
- [PR #536] Updated azure-regions.json with new regions ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/536)
- [#519] Remove hackathon sentence from our website banner ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/519)
- [#510] Gap Analysis for WattTime v3 ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/510)
- [#262] [Feature Contribution]: Publish the docker file in a docker registry ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/262)
- [PR #532 Watt Time v3 Support ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/532)
- [PR #340 Add example for 'podman play kube' ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/340)
- [PR #536 Updated azure-regions.json with new regions ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/536)
- [#519 Remove hackathon sentence from our website banner ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/519)
- [#510 Gap Analysis for WattTime v3 ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/510)
- [#262 Feature Contribution: Publish the docker file in a docker registry ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/262)

### Removed

WattTime v2 API support due to v3 in place replacement.

### Fixed

- [PR #522] Remove Hack mention from the Docs's banner ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/522)
- [#535] [Bug]: Configuration for locations loads twice ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/535)
- [PR #516] Update published documentation to .NET 8 ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/516)
- [PR #515] overview.md: Fixed three broken links Signed-off-by: joecus1 <joecusa… ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/515)
- [#506] Check our published documentation to identify any references to .NET7 ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/506)
- [#512] [Bug]: Broken links in overview.md file ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/512)
- [PR #522 Remove Hack mention from the Docs's banner ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/522)
- [#535 Bug: Configuration for locations loads twice ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/535)
- [PR #516 Update published documentation to .NET 8 ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/516)
- [PR #515 overview.md: Fixed three broken links Signed-off-by: joecus1 ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/pull/515)
- [#506 Check our published documentation to identify any references to .NET7 ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/506)
- [#512 Bug: Broken links in overview.md file ](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/512)

### Changed

Expand Down Expand Up @@ -75,4 +75,4 @@ No changes
No changes


For more details, checkout [/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503)
For more details, checkout [/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503](/~https://github.com/Green-Software-Foundation/carbon-aware-sdk/issues/503)
10 changes: 5 additions & 5 deletions casdk-docs/docs/architecture/decisions/0016-watt-time-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ The `Login` is now at a different base URL, and to avoid any future issues a dif

| API Endpoint | Description | Path (v2) | Path (v3) | Notes |
|--------------|-------------|-----------|-----------|---|
| Data | Get data | /data | /historical | _Request_ <li> `starttime` is now `start` and mandatory <li> `endtime` is now `end` and mandatory <li> `ba` is now `region` <li> `signal_type` added <br> _Response_ <li> `signal_type` added
| Forecast | Get forecast| /forecast | /forecast | <br> No longer be used for historical data <br> _Request_ <li> `ba` is now `region` <li> `extended_forecast` removed <li> `horizon_hours` added <li> `signal_type` added <li> Historical forecasts are now at `/forecast/historical` <br> _Response_ <li> `signal_type` added
| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | This changed signficantly. <br> _Request_ <li> `ba` is now `region` <li> `starttime` is now `start` and mandatory <li> `endtime` is now `end` and mandatory <li> `signal_type` added <br> _Response_ <li> `signal_type` added
| Balancing Authority From Location | Get balancing authority from location | /ba-from-loc | /region-from-loc | Check if the CA SDK uses BA at all <br><br> _Request_ <li> `name` is now `region_full_name` <li> `abbrev` is now `region` <li> `signal_type` added <br> _Response_ <li> `id` removed <li> `signal_type` added |
| Login | User login | https://api2.watttime.org/v2/login | https://api.watttime.org/login | Path has changed from being version specific to being no longer related to the API version. <br><br> Updated in `WattTimeClient` to now have 2 HTTP clients to decouple versions from the login.
| Data | Get data | /data | /historical | _Request_ <li> `starttime` is now `start` and mandatory </li> <li> `endtime` is now `end` and mandatory </li><li> `ba` is now `region` </li><li> `signal_type` added _Response_ </li><li> `signal_type` added</li>|
| Forecast | Get forecast| /forecast | /forecast | No longer be used for historical data _Request_ <li> `ba` is now `region` </li><li> `extended_forecast` removed </li><li> `horizon_hours` added </li><li> `signal_type` added </li><li> Historical forecasts are now at `/forecast/historical` <br /> _Response_ </li><li> `signal_type` added </li>
| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | This changed signficantly. <br /> _Request_ <li> `ba` is now `region` </li><li> `starttime` is now `start` and mandatory </li><li> `endtime` is now `end` and mandatory </li><li> `signal_type` added <br /> _Response_ </li><li> `signal_type` added </li>
| Balancing Authority From Location | Get balancing authority from location | /ba-from-loc | /region-from-loc | Check if the CA SDK uses BA at all <br /><br /> _Request_ <li> `name` is now `region_full_name` </li><li> `abbrev` is now `region` </li><li> `signal_type` added <br /> _Response_ </li><li> `id` removed </li><li> `signal_type` added </li> |
| Login | User login | https://api2.watttime.org/v2/login | https://api.watttime.org/login | Path has changed from being version specific to being no longer related to the API version. <br /><br /> Updated in `WattTimeClient` to now have 2 HTTP clients to decouple versions from the login.

### Query Strings

Expand Down

0 comments on commit 53e120c

Please sign in to comment.