FlexMeasures / flexmeasures / 19781146930

74%

push

github

Docs/field descriptions (#1777)

* feat: describe 'start' field

Signed-off-by: F.N. Claessen <felix@seita.nl>

* refactor: less verbose

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: document fields used in /api/v3_0/sensors/{id}

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: document authentication_token

Signed-off-by: F.N. Claessen <felix@seita.nl>

* fix: include changes to openapi-specs.json

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: comment on DST transitions

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: two explicit examples for /api/v3_0/sensors/{id}; otherwise, the default units serve as an example, but those do not yield a coherent example (for instance, it mixes the power-sensor-specific consumption_is_positive attribute with a EUR/kWh price unit)

Signed-off-by: F.N. Claessen <felix@seita.nl>

* fix: indentation

Signed-off-by: F.N. Claessen <felix@seita.nl>

* fix: valid YAML identifiers

Signed-off-by: F.N. Claessen <felix@seita.nl>

* fix: indentation and typos

Signed-off-by: F.N. Claessen <felix@seita.nl>

* fix: cross-reference

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: document fields used in /api/v3_0/sensors/{id}/data

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: open OpenAPI Docs in new window

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: reference definition of belief time from timely-beliefs

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: reference internal documentation instead (which already links further to timely-beliefs)

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: document fields for get_schedule

Signed-off-by: F.N. Claessen <felix@seita.nl>

* fix: update openapi-specs.json

Signed-off-by: F.N. Claessen <felix@seita.nl>

* docs: describe default as absolute duration

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: describe fields in TriggerScheduleKwargsSchema

Signed-off-by: F.N. Claessen <felix@seita.nl>

* feat: add n... (continued)

1383 of 2028 branches covered (68.2%)

Branch coverage included in aggregate %.

156 of 179 new or added lines in 12 files covered. (87.15%)

10234 of 13757 relevant lines covered (74.39%)

5.95 hits per line