diff --git a/.github/workflows/1-pr.yaml b/.github/workflows/1-pr.yaml index b38b914d0..581c168af 100644 --- a/.github/workflows/1-pr.yaml +++ b/.github/workflows/1-pr.yaml @@ -128,7 +128,7 @@ jobs: working-directory: ./src/CarbonAware.WebApi/src - name: Upload swagger artifact - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: pr-swagger.yaml path: src/CarbonAware.WebApi/src/wwwroot/api/v1/swagger.yaml @@ -184,11 +184,11 @@ jobs: env: DOTNET_ROLL_FORWARD: LatestMajor - name: Upload dev artifact - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v4 with: name: dev-swagger.yaml path: src/CarbonAware.WebApi/src/wwwroot/api/v1/swagger.yaml - - uses: actions/download-artifact@v3 + - uses: actions/download-artifact@v4 with: name: pr-swagger.yaml path: ./src/CarbonAware.WebApi/src/wwwroot/api/v1/pr-swagger.yaml diff --git a/.github/workflows/dev_carbon-aware-api.yml b/.github/workflows/dev_carbon-aware-api.yml index f1c4dc4ae..5bc799ad6 100644 --- a/.github/workflows/dev_carbon-aware-api.yml +++ b/.github/workflows/dev_carbon-aware-api.yml @@ -32,7 +32,7 @@ jobs: run: dotnet publish -c Release -o ${{env.DOTNET_ROOT}}/myapp - name: Upload artifact for deployment job - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v4 with: name: CarbonAwareApi path: ${{env.DOTNET_ROOT}}/myapp @@ -46,7 +46,7 @@ jobs: steps: - name: Download artifact from build job - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v4 with: name: CarbonAwareApi diff --git a/casdk-docs/docs/architecture/decisions/0016-watt-time-v3.md b/casdk-docs/docs/architecture/decisions/0016-watt-time-v3.md index e585ad37e..30b2b221a 100644 --- a/casdk-docs/docs/architecture/decisions/0016-watt-time-v3.md +++ b/casdk-docs/docs/architecture/decisions/0016-watt-time-v3.md @@ -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_
  • `starttime` is now `start` and mandatory
  • `endtime` is now `end` and mandatory
  • `ba` is now `region`
  • `signal_type` added _Response_
  • `signal_type` added
  • | -| Forecast | Get forecast| /forecast | /forecast | No longer be used for historical data _Request_
  • `ba` is now `region`
  • `extended_forecast` removed
  • `horizon_hours` added
  • `signal_type` added
  • Historical forecasts are now at `/forecast/historical`
    _Response_
  • `signal_type` added
  • -| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | This changed signficantly.
    _Request_
  • `ba` is now `region`
  • `starttime` is now `start` and mandatory
  • `endtime` is now `end` and mandatory
  • `signal_type` added
    _Response_
  • `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

    _Request_
  • `name` is now `region_full_name`
  • `abbrev` is now `region`
  • `signal_type` added
    _Response_
  • `id` removed
  • `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.

    Updated in `WattTimeClient` to now have 2 HTTP clients to decouple versions from the login. | +| Data | Get data | /data | /historical | _Request_
  • `starttime` is now `start` and mandatory
  • `endtime` is now `end` and mandatory
  • `ba` is now `region`
  • `signal_type` added
    _Response_
  • `signal_type` added | +| Forecast | Get forecast| /forecast | /forecast |
    No longer be used for historical data
    _Request_
  • `ba` is now `region`
  • `extended_forecast` removed
  • `horizon_hours` added
  • `signal_type` added
  • Historical forecasts are now at `/forecast/historical`
    _Response_
  • `signal_type` added | +| Historical | Get historical forecast data | /historical (?) | /forecast/historical (?) | This changed signficantly.
    _Request_
  • `ba` is now `region`
  • `starttime` is now `start` and mandatory
  • `endtime` is now `end` and mandatory
  • `signal_type` added
    _Response_
  • `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

    _Request_
  • `name` is now `region_full_name`
  • `abbrev` is now `region`
  • `signal_type` added
    _Response_
  • `id` removed
  • `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.

    Updated in `WattTimeClient` to now have 2 HTTP clients to decouple versions from the login. | ### Query Strings