From 8480f1e2a01733e7c667ed4b3ff33f71cb53a208 Mon Sep 17 00:00:00 2001 From: Andre Date: Mon, 20 Nov 2023 16:03:50 +0100 Subject: [PATCH 1/4] Unify naming convetion for EECS rules reference Signed-off-by: Andre --- specifications/cdsc-wg2-03.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specifications/cdsc-wg2-03.md b/specifications/cdsc-wg2-03.md index 3288519..94478bc 100644 --- a/specifications/cdsc-wg2-03.md +++ b/specifications/cdsc-wg2-03.md @@ -1,4 +1,4 @@ -# _CDSC-WG2-03 - Endpoints_ +># _CDSC-WG2-03 - Endpoints_ Version: _0.0.1_ Status: Pre-Draft @@ -200,13 +200,13 @@ Content-Type: application/json;charset=UTF-8 "types": [ { "name": "Solar - Photovoltaic - Unspecified", - "external_reference": "EECS Rules Fact Sheet 5 TYPES OF ENERGY INPUTS AND TECHNOLOGIES", - "external_id": "T010100" + "sourceDocument": "EECS Rules Fact Sheet 5 TYPES OF ENERGY INPUTS AND TECHNOLOGIES", + "aibCode": "T010100" }, { "name": "Fossil - Solid - Hard Coal - Unspecified", "external_reference": "EECS Rules Fact Sheet 5 TYPES OF ENERGY INPUTS AND TECHNOLOGIES", - "external_id": "F02010100" + "aibCode": "F02010100" }, ], "next": null, From 47f905192e6cf212940f74b0a2e4e2edc6a279f0 Mon Sep 17 00:00:00 2001 From: Andre Date: Mon, 20 Nov 2023 16:12:10 +0100 Subject: [PATCH 2/4] Fix fuel source and technology examples Some of the types and technologies were wrongly assigned according to the convention given at EECS Rules Fact Sheet 5 TYPES OF ENERGY INPUTS AND TECHNOLOGIES Signed-off-by: Andre --- specifications/cdsc-wg2-03.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/specifications/cdsc-wg2-03.md b/specifications/cdsc-wg2-03.md index 94478bc..56a36a6 100644 --- a/specifications/cdsc-wg2-03.md +++ b/specifications/cdsc-wg2-03.md @@ -198,16 +198,17 @@ Content-Type: application/json;charset=UTF-8 ```json { "types": [ - { - "name": "Solar - Photovoltaic - Unspecified", - "sourceDocument": "EECS Rules Fact Sheet 5 TYPES OF ENERGY INPUTS AND TECHNOLOGIES", - "aibCode": "T010100" - }, { "name": "Fossil - Solid - Hard Coal - Unspecified", "external_reference": "EECS Rules Fact Sheet 5 TYPES OF ENERGY INPUTS AND TECHNOLOGIES", "aibCode": "F02010100" }, + { + "name": "Mechanical source or other - Wind - Unspecified", + "sourceDocument": "EECS Rules Fact Sheet 5 TYPES OF ENERGY INPUTS AND TECHNOLOGIES", + "aibCode": "F01050100" + }, + ], "next": null, "previous": null @@ -242,13 +243,6 @@ Content-Type: application/json;charset=UTF-8 ```json { "technologies": [ - { - "name": "Mechanical source or other - Wind - Unspecified", - "externalReference": { - "sourceDocument": "EECS Rules Fact Sheet 5 TYPES OF ENERGY INPUTS AND TECHNOLOGIES", - "aibCode": "F01050100" - } - }, { "name": "Thermal - Steam engine - Unspecified", "externalReference": { @@ -256,6 +250,14 @@ Content-Type: application/json;charset=UTF-8 "aibCode": "T050900" } }, + + { + "name": "Solar - Photovoltaic - Unspecified", + "externalReference": { + "sourceDocument": "EECS Rules Fact Sheet 5 TYPES OF ENERGY INPUTS AND TECHNOLOGIES", + "aibCode": "T010100" + } + }, ], "next": null, "previous": null From 89f5a0862baab1d7f705cfb58598cf984d1cb378 Mon Sep 17 00:00:00 2001 From: Andre Date: Mon, 20 Nov 2023 16:17:25 +0100 Subject: [PATCH 3/4] Update PSR List location and reference in spec Signed-off-by: Andre --- specifications/cdsc-wg2-03.md | 103 +++++++++++++++++----------------- 1 file changed, 52 insertions(+), 51 deletions(-) diff --git a/specifications/cdsc-wg2-03.md b/specifications/cdsc-wg2-03.md index 56a36a6..cbc69ff 100644 --- a/specifications/cdsc-wg2-03.md +++ b/specifications/cdsc-wg2-03.md @@ -42,8 +42,8 @@ The following is a list of the endpoints that will be subsequently defined in th /metadata/topology-levels (LIST) /metadata/fuel-source/types (LIST) /metadata/fuel-source/technologies (LIST) -/power-system-resources (LIST) # PSR-Specific Metadata +/power-system-resources (LIST) /power-system-resources/{id}/describe (GET) /power-system-resources/{id}/capacity (GET) /power-system-resources/{id}/transmission-capacity (GET) @@ -268,7 +268,57 @@ Content-Type: application/json;charset=UTF-8 The primary set of endpoints reference PowerSystemResource (PSR) objects. These objects contain several metadata fields about these PSRs. -#### 3.2.1 PSR Topology (List) `/power-system-resources/{id}/topology` +#### 3.2.1 PSR (List) `/power-system-resources` + +##### Description +The primary set of endpoints reference PowerSystemResource (PSR) objects. These objects contain several metadata fields as well as **historical timeseries** information such as capacity. + +##### Request Object +- `level`: _Integer_ - (OPTIONAL) - An optional filter to only return PSR objects with the given *topology level*. + +##### Response Object +- `id` - _string_ - (REQUIRED) - The unique identifier representing this resource. It SHOULD be human-readable, and where appropriate, MAY incorporate the `id` of its parent objects in order to easily understand its place in the topology. An example of such an id is `US-WECC-CISO`. The `id` MUST be URL safe. +- `level` - _string_ - (REQUIRED) - The id of the topology level for this PSR. +- `name` - _string_ - (OPTIONAL) - A descriptive name to provide additional context to the PSR. + +#### Example +The following is an example of the endpoint that returns a list of power system resources. This LIST endpoint SHOULD only includes the `id`, `name`, and `type` fields. It MUST not contain fields of undefined size (such as fields that con contain lists or dicts), as this endpoint is meant to be capable of returning several entries. + +``` +==Request== +GET /power-system-resources HTTP/1.1 +Host: demoutility.com + +==Response== +HTTP/1.1 200 OK +Content-Type: application/json;charset=UTF-8 +``` + +```json +{ + "power_system_resources": [ + { + "id": "US-WECC", + "name": "Western Electricity Coordinating Council", + "level": 0 + }, + { + "id": "US-WECC-CISO", + "name": "California ISO", + "level": 1 + }, + { + "id": "US-WECC-CISO-ABC-HYDRO", + "name": "Hydropower Plant in ABC", + "level": 2 + } + ], + "next": null, + "previous": null +} +``` + +#### 3.2.2 PSR Topology (List) `/power-system-resources/{id}/topology` ##### Description @@ -328,55 +378,6 @@ Content-Type: application/json;charset=UTF-8 }` ``` -#### 3.2.2 PSR (List) `/power-system-resources` - -##### Description -The primary set of endpoints reference PowerSystemResource (PSR) objects. These objects contain several metadata fields as well as **historical timeseries** information such as capacity. - -##### Request Object -- `level`: _Integer_ - (OPTIONAL) - An optional filter to only return PSR objects with the given *topology level*. - -##### Response Object -- `id` - _string_ - (REQUIRED) - The unique identifier representing this resource. It SHOULD be human-readable, and where appropriate, MAY incorporate the `id` of its parent objects in order to easily understand its place in the topology. An example of such an id is `US-WECC-CISO`. The `id` MUST be URL safe. -- `level` - _string_ - (REQUIRED) - The id of the topology level for this PSR. -- `name` - _string_ - (OPTIONAL) - A descriptive name to provide additional context to the PSR. - -#### Example -The following is an example of the endpoint that returns a list of power system resources. This LIST endpoint SHOULD only includes the `id`, `name`, and `type` fields. It MUST not contain fields of undefined size (such as fields that con contain lists or dicts), as this endpoint is meant to be capable of returning several entries. - -``` -==Request== -GET /power-system-resources HTTP/1.1 -Host: demoutility.com - -==Response== -HTTP/1.1 200 OK -Content-Type: application/json;charset=UTF-8 -``` - -```json -{ - "power_system_resources": [ - { - "id": "US-WECC", - "name": "Western Electricity Coordinating Council", - "level": 0 - }, - { - "id": "US-WECC-CISO", - "name": "California ISO", - "level": 1 - }, - { - "id": "US-WECC-CISO-ABC-HYDRO", - "name": "Hydropower Plant in ABC", - "level": 2 - } - ], - "next": null, - "previous": null -} -``` #### 3.2.3 PSR Describe `/power-system-resources/{id}/describe` From 1807a78f104f4a2144adedbaf8265523f3297255 Mon Sep 17 00:00:00 2001 From: Stephen Suffian Date: Fri, 24 Nov 2023 16:15:46 -0500 Subject: [PATCH 4/4] Update cdsc-wg2-03.md --- 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 2cc83f3..90e2b02 100644 --- a/specifications/cdsc-wg2-03.md +++ b/specifications/cdsc-wg2-03.md @@ -1,4 +1,4 @@ -># _CDSC-WG2-03 - Endpoints_ +# _CDSC-WG2-03 - Endpoints_ Version: _0.0.1_ Status: Pre-Draft