From e468b848ed2e326b1fcf2b96d01fdf69f27c065b Mon Sep 17 00:00:00 2001 From: Andre Date: Wed, 22 Nov 2023 12:43:07 +0100 Subject: [PATCH 1/3] Update PSR Capcity and Transmission Capacity Update endpoint schema to improve readibility Signed-off-by: Andre --- specifications/cdsc-wg2-03.md | 77 ++++++++++++++++++++--------------- 1 file changed, 45 insertions(+), 32 deletions(-) diff --git a/specifications/cdsc-wg2-03.md b/specifications/cdsc-wg2-03.md index 3288519..e51c750 100644 --- a/specifications/cdsc-wg2-03.md +++ b/specifications/cdsc-wg2-03.md @@ -457,14 +457,15 @@ The capacity endpoint provides a means for providing capacity information by fue ##### Response Object - `id` - _string_ - REQUIRED - The `id` of the PowerSystemResource associated with this location. -- `unit` - _string_ - (REQUIRED) - For electricity, SHOULD be one of: [`MW`, `kW`, `W`] -- `capacity` - _Array_ - - `fuelSource` - _Object_ - - `technology` - _String_ - (OPTIONAL) - *id* of the technology for generating this fuel. - - `type` - _String_ - (REQUIRED) - *id* of the fuel type used for generation. - - `value` - _float_ - A value of the amount of generation that took place at this PSR using the given *technology* and *fuel_source*. - - `startDatetime` - _ISO8601 Datetime_ - (REQUIRED) - The datetime MUST be timezone aware. This allows for the defining of historical capacity values and to indicate when new resources came online. - - `endDatetime` - _ISO8601 Datetime_ - (OPTIONAL) - The datetime MUST be timezone aware. This allows for the defining of historical capacity values and to indicate when old resources came offline. An empty value assumes it is still operational. + +- `fuelSource` - _Array_ - Generating units in the given PowerSystemResource + - `technology` - _String_ - (OPTIONAL) - *id* of the technology for generating this fuel. + - `type` - _String_ - (REQUIRED) - *id* of the fuel type used for generation. + - `unit` - _string_ - (REQUIRED) - For electricity, SHOULD be one of: [`MW`, `kW`, `W`] + - `capacity` - _Array_ + - `value` - _float_ - A value of the amount of generation that took place at this PSR using the given *technology* and *fuel_source*. + - `startDatetime` - _ISO8601 Datetime_ - (REQUIRED) - The datetime MUST be timezone aware. This allows for the defining of historical capacity values and to indicate when new resources came online. + - `endDatetime` - _ISO8601 Datetime_ - (OPTIONAL) - The datetime MUST be timezone aware. This allows for the defining of historical capacity values and to indicate when old resources came offline. An empty value assumes it is still operational. ``` ==Request== @@ -479,26 +480,35 @@ Content-Type: application/json;charset=UTF-8 ```json { "id": "US-WECC-CISO", - "unit": "MW", - "capacity": [ + "fuelSource": [ { - "fuelSource": { - "technology": "Thermal - Steam engine - Unspecified", - "type": "Fossil - Solid - Hard Coal - Unspecified" - }, - "value": 500, - "startDatetime": "2015-06-01 00:00:00+00", - "endDatetime": "2021-06-01T00:00:00+00" + "technology": "Thermal - Steam engine - Unspecified", + "type": "Fossil - Solid - Hard Coal - Unspecified", + "unit": "MW", + "capacity":[ + { + "value":500, + "startDatetime": "2021-06-01T00:00:00+00", + }, + { + "value":200, + "startDatetime": "2015-06-01 00:00:00+00", + "endDatetime": "2021-06-01T00:00:00+00" + } + ] }, { - "fuelSource": { - "technology": "Thermal - Steam engine - Unspecified", - "type": "Fossil - Solid - Hard Coal - Unspecified" + "technology": "Renewable-Heat-Solar-Unespecified", + "type": "Solar-Photovoltaic-Classic silicon", + "unit": "MW", + "capacity":[ + { + "value": 200, + "startDatetime": "2010-06-01 00:00:00+00" + } + ] }, - "startDatetime": "2010-06-01 00:00:00+00", - "value": 300 - } - ], + ] "next": null, "previous": null } @@ -520,6 +530,7 @@ The transmission capacity endpoint provides a means for providing transmission l `unit` - _String_ - (REQUIRED) - For electricity, SHOULD be one of: [`MW`, `kW`, `W`] - `transmissionCapacity` - _Array_ - `connectedPSR` - _Object_ + - `unit` - _String_ - (REQUIRED) - For electricity, SHOULD be one of: [`MW`, `kW`, `W`] - `id` - _String_ The unique identifier representing the *id* of the PSR connected to the requested PSR. - `value` - _float_ - A value of the amount of transmission capacity available between the two PSRs. @@ -538,14 +549,16 @@ Content-Type: application/json;charset=UTF-8 "id": "US-WECC-CISO", "unit": "MW", "transmissionCapacity": [ - { - "connectedPSR": {"id": "US-WECC-NEVP"}, - "value": 100 - }, - { - "connectedPSR": {"id": "US-WECC-ABCD"}, - "value": 50 - },... + { + "unit":"MW", + "connectedPSR": {"id": "US-WECC-NEVP"}, + "value": 100 + }, + { + "unit":"MW", + "connectedPSR": {"id": "US-WECC-ABCD"}, + "value": 50 + },... ], "next": null, "previous": null From 947e9c7122a6cce1dea9e8ace35fb63222735da2 Mon Sep 17 00:00:00 2001 From: Andre Date: Wed, 22 Nov 2023 12:48:41 +0100 Subject: [PATCH 2/3] Fix minor typo in Request URL Signed-off-by: Andre --- specifications/cdsc-wg2-03.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specifications/cdsc-wg2-03.md b/specifications/cdsc-wg2-03.md index e51c750..1e99675 100644 --- a/specifications/cdsc-wg2-03.md +++ b/specifications/cdsc-wg2-03.md @@ -469,7 +469,7 @@ The capacity endpoint provides a means for providing capacity information by fue ``` ==Request== -GET /power-system-resources/US-WECC-CISO/topology?numLevels=2 HTTP/1.1 +GET /power-system-resources/US-WECC-CISO/capacity HTTP/1.1 Host: demoutility.com ==Response== From 92d982b36ffeb2b19983720edf78c86d28ea776e Mon Sep 17 00:00:00 2001 From: Andre Date: Wed, 22 Nov 2023 12:57:23 +0100 Subject: [PATCH 3/3] Fix indentation in PSR Transmission Capacity Signed-off-by: Andre --- specifications/cdsc-wg2-03.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specifications/cdsc-wg2-03.md b/specifications/cdsc-wg2-03.md index 1e99675..7b3df00 100644 --- a/specifications/cdsc-wg2-03.md +++ b/specifications/cdsc-wg2-03.md @@ -530,9 +530,9 @@ The transmission capacity endpoint provides a means for providing transmission l `unit` - _String_ - (REQUIRED) - For electricity, SHOULD be one of: [`MW`, `kW`, `W`] - `transmissionCapacity` - _Array_ - `connectedPSR` - _Object_ - - `unit` - _String_ - (REQUIRED) - For electricity, SHOULD be one of: [`MW`, `kW`, `W`] - `id` - _String_ The unique identifier representing the *id* of the PSR connected to the requested PSR. - - `value` - _float_ - A value of the amount of transmission capacity available between the two PSRs. + - `unit` - _String_ - (REQUIRED) - For electricity, SHOULD be one of: [`MW`, `kW`, `W`] + - `value` - _float_ - A value of the amount of transmission capacity available between the two PSRs. ``` ==Request==