GIScience / GIScience/openrouteservice

Deprecate summary elements in (Geo)JSON response formats

Open
#735 0 comments 0 reactions 0 assignees View on GitHub
API v3 api-response
Dominant language
Java
Stars
2k
Forks
481
Avg merge
1d 15h
Merged PRs (30d)
45

Description

There are some major inconsistencies in all response formats which don't come unnoticed (#734). We need to redesign a clean solution and deploy at some point as API v3.

Back in February 2020 we agreed in our internal discussions that the `summary` element in JSON/GeoJSON is redundant. The fields within the summary should be moved to top-level and the summary-element itself removed in v3.

Any newly introduced fields in the response (such as e.g. `departure` and `arrival`) should be already put on the top level. We will start transitioning by duplicating fields and deprecating the bad positions.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no files, tests, or entry points. Start by locating the JSON/GeoJSON response-format implementation and API versioning path; done means summary fields are transitioned to top-level positions and the summary element is removed in API v3, with newly introduced fields kept at the top level.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.