FlexMeasures / flexmeasures / 20731950024

74%

push

github

add `fields` param to the asset-listing endpoints, controlling fields in response (#1884)

* feat: index assets with a given root asset

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

* feat: index assets up to a certain level

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

* fix: in case of None max_level

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

* fix: in case of None asset

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

* refactor: rename max_level to max_depth

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

* feat: rely on max recursion setting of db

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

* fix: OpenAPI specs generation

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

* chore: OpenAPI specs

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

* docs: change order of query parameters explained

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

* style: fix double spaces

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

* refactor: rename new query parameter from 'asset' to 'root'

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

* docs: API changelog entry

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

* docs: main changelog entry

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

* docs: attempt to clarify a confusing endpoint summary

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

* add included-fields param to the asset-listing endpoint; (the endpoint for pubic for now returns a default set); also improve some parameter descriptions

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* make asset listing pages say which fields they do need

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* do not use hyphen

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* add changelog entries

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* Add new field also to public assets endpoint

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* simplify name of the parameter to just 'fields'

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* check if fields ... (continued)

1417 of 2080 branches covered (68.13%)

Branch coverage included in aggregate %.

24 of 39 new or added lines in 3 files covered. (61.54%)

10456 of 14066 relevant lines covered (74.34%)

5.94 hits per line