Skip to content

Commit

Permalink
docs(changelog): clean-up
Browse files Browse the repository at this point in the history
  • Loading branch information
@matthiasschaub
matthiasschaub committed Jun 27, 2023
1 parent 232b39d commit fba1ce6
Showing 1 changed file with 68 additions and 59 deletions.
127 changes: 68 additions & 59 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,91 +4,99 @@

### Breaking Changes

- change API parameter names for POST requests from snake case to lower hyphen ([#398])
- change indicator and report keys from lower camel case to lower hyphen ([#398])
#### API

- change JSON keys in request and response models from snake case to:
- (1) hypen case for identifiers such as indicator, report and topic keys ([#398])
- (2) camel case for other keys ([#603])
- discontinue support GeoJSON Geometry as value for `bpolys` parameters ([#554])
- rename API parameter `layerKey` and `layer` to `topic` ([#501])
- rename `TagsRatio` indicator to `attribute-completeness` ([#500])
- rename `PoiDensity` indicator to `density` ([#544])
- remove GHS POP Comparison indicators: `ghs_pop_comparison_buildings` and `ghs_pop_comparison_roads` ([#515])
- remove JRC related layers and report `jrc_requirements` ([#503])
- rename `TagsRatio` indicator to `attribute-completeness` ([#500])
- requests to the API endpoint `/indicator` for a custom layer/topic need an additional field `key` of type string ([#517])
- remove GET request for indicators and reports ([#516])
- remove all CLI commands except commands for creating all indicators for a given dataset ([#556])
- remove API endpoints `/indicator` and `/report` ([#554])
- remove API endpoints `/indicators`, `/reports`, `/datasets` and `/fid-fields` ([#554])
- discontinue support GeoJSON Geometry as value for `bpolys` parameters ([#554])
- rename `PoiDensity` indicator to `density` ([#544])
- remove API enspoints:
- `/indicator` and `/report` ([#554])
- `/indicators`, `/reports`, `/datasets` and `/fid-fields` ([#554])
- `/regions` ([#583])
- requests to the API endpoint `/indicators` for a custom layer/topic need an additional field `key` of type string ([#517])
- homogenize API response schema for errors ([#562])
- response of `/indicators` is always a FeatureCollections ([#598])

#### CLI

- remove all CLI commands except commands for creating all indicators for a given dataset ([#556])

#### Website

- remove website from repository ([#578])
- api: remove `/regions` endpoint ([#583])
- api: use lower camel case instead of hyphen-case for all non-dynamic JSON keys (e.g. not indicator keys) ([#603])
- api: response of `indicator` is always a FeatureCollections ([#598])

### Bug Fixes

#### Reports

- sketch-map-fitness: use `landmarks` instead of `poi` topic ([#544])

#### Indicators

- mapping-saturation: add missing edge case detection for too few data points. ([#512])
- currentness: fix wrong count of contributions due to multiple requests ([#535])
- doctors topic: use correct filter ([#540])
- currentness: exclude deletions when requesting contributions ([#535])
- currentness: aggregate on an annual basis instead of per calendar year ([#535])

#### Topics

- tidy up and fix filters of core topic definitions ([#520])
- doctors: use correct filter ([#540])
- landmarks: add `density` indicator to `landmarks` topic ([#544])

### New Features

- disable size limit for Mapping Saturation ([#498])
- add `project` attribute to topics ([#504])
- add `project` attribute to indicators, reports and topics ([#504], [#563], [#601], [#601])
- add `quality-dimensions` attribute to indicators ([#561])
- layer/topic are now pydantic models instead of dataclasses ([#517])
- add plot creation via plotly to `MappingSaturation` indicator ([#499])
- api: add `/metadata/topic` endpoint ([#519])
- api: add `/metadata/indicators` endpoint ([#533])
- api: add `/metadata/reports` endpoint ([#545])
- api: add `/metadata` endpoint ([#545])
- api: add `/indicators/{key}` and `/reports/{key}` endpoints ([#554])
- add quality dimensions to indicators ([#561])
- add project names and descriptions ([#563])
- api: allow multiple projects per topic/indicator/report ([#601])
- api: add possibility to query all metadata (independent of project) ([#601])
- api: support responses in JSON format for `/indicators/{key}` ([#582])
- substitute indicator result figure creation with `plotly` instead of `matplotlib` ([#499], [#536], [#559], [#535], [#552], [#544], [#551])

#### API

- add `/indicators/{key}` and `/reports/{key}` endpoints ([#554])
- support JSON in addition to GeoJSON responses (#582)
- add `/metadata/topic` endpoint ([#519])
- add `/metadata/indicators` endpoint ([#533])
- add `/metadata/reports` endpoint ([#545])
- add `/metadata` endpoint ([#545], [#601])
- disable size limit for Mapping Saturation ([#498])

### Other Changes

- fix pre-commit hooks ([#482])
- update asyncpg from 0.25 to 0.27 ([#481])
- build(docker): overhaul docker compose setup ([#483])
- build: fix pre-commit hooks ([#482])
- build: update dependencies ([#481], [#488], [#531], [#531], [#576], [#576])
- api: remove unnecessary newlines from API output and internal definitions ([#529])
- api: serve Swagger UI files not via CDN ([#581], [#593], [#605])
- api: fix attribution URL path ([#543])
- refactor(db): remove artifacts as well as old init scripts and restructure directories ([#388])
- overhaul docker compose setup ([#483])
- build(deps): update FastAPI to version 0.92.0 ([#488])
- topics: tidy up and fix filters of core topic definitions ([#520])
- refactor(topic): rename layer to topic ([#521])
- refactor(topic): move `base/topic.py` to `topics/models.py` and `layer_defintions.yaml` to `topics/presets.yaml` ([#523])
- refactor: factor out validators from pydantic models to own validators module. Add validation exceptions. ([#554])
- refactor: move base classes to related modules ([#524])
- refactor: move topic-indicator-combinations to topic definition ([#528])
- fix: remove unnecessary newlines from API output and internal definitions ([#529])
- build: update minimal python version to 3.10 ([#531])
- build: update dev dependencies ([#531])
- mapping-saturation: substitute matplotlib SVG with plotly SVG ([#536])
- base indicator: substitute matplotlib SVG with plotly SVG ([#559])
- api: fix attribution URL path ([#543])
- currentness: substitute matplotlib SVG with plotly SVG ([#535])
- currentness: exclude deletions when requesting contributions ([#535])
- currentness: aggregate on an annual basis instead of per calendar year ([#535])
- building-completeness: substitute matplotlib SVG with plotly SVG ([#552])
- factor out validators from pydantic models to own validators module. Add validation exceptions. ([#554])
- density: substitute matplotlib SVG with plotly SVG ([#544])
- add density indicator to `landmarks` topic ([#544])
- SketchMapFitness: now uses `landmarks` for density indicator instead of `poi`topic ([#544])
- attribute-completeness: substitute matplotlib SVG with plotly SVG ([#551])
- build(poetry): add primary and supplemental source ([#576])
- build: update `requests` to "^2.31.0" ([#576])
- build: remove unused dependency `dacite` ([#576])
- swagger: serve Swagger UI files not via CDN ([#581], [#593], [#605])
- refactor: move topic-indicatt of group members topic definition ([#528])
- tests(vcr): don't record local requests and change cassettes directory structure ([#579])

### How to Upgrade

- rename indicator keys from camel case to lower hyphen ([#398]): E.g. `MappingSaturation` to `mapping-saturation`
- rename API parameters for POST requests from camel case to lower hyphen ([#398])
- rename API parameter `layerKey` and `layer` to `topic` ([#501])
- for requests to the API endpoint `/indicator` for a custom topic add an additional field `key` of type string ([#517])
- E.g. `{"name": "mapping-saturation", "bpolys": {...}, "topic": {"key": "my-key", "name": "my-name", "description": "my-description", "data": {...}}"`
- API endpoint `/indicator` and `/report` do not support GET request anymore. Change request to those endpoints to use the POST method ([#516]).
- to compute an indicator or report request the new API endpoints `/indicators/{key}` and `/reports/{key}` ([#554])
- all error message have following schema ([#562]):
#### API
- use endpoint `/indicators/{key}` and `/reports/{key}` instead of `/indicator` and `/report`
- use endpoint `/metadata` to retrieve metadata
- rename request parameter `layerKey` and `layer` to `topic` ([#501]) change
- JSON keys in rtOther gequests and responses from snake case and lower camel
- case to: (1) hypen case for identifiers such as indicator, report and topic
- keys (E.g.`MappingSaturation` to `mapping-saturation`) ([#398]) (2) camel
- case for other keys ([#603])
- for requests to the API endpoint `/indicators/{key}` for a custom topic add an additional field `key` of type string ([#517])
- E.g. `{"bpolys": {...}, "topic": {"key": "my-key", "name": "my-name", "description": "my-description", "data": {...}}"`
- change parsing of error messages to work with following schema ([#562]):
```json
{
"apiVersion": "__version__",
Expand Down Expand Up @@ -372,6 +380,7 @@
- Update `poi` layer based on ([`openpoiservice`]) [#246])
- Remove `ideal_vgi_poi` layer in favor of new `poi` layer ([#246])


### New Features

- Add new parameter `includeHtml` to the API endpoints `/indicator` and `/report` to include a HTML snippets with the results in the response ([#242])
Expand Down

0 comments on commit fba1ce6

Please sign in to comment.