Announcement issue for breaking API changes

TUM-Dev / NavigaTUM

Navigating around TUM with excellence – A website and API to search for rooms, buildings and other places

https://nav.tum.de

GNU General Public License v3.0

40 stars 8 forks source link

Announcement issue for breaking API changes #130

Open CommanderStorm opened 2 years ago

CommanderStorm commented 2 years ago

This Issue tracks:

who uses the API,
what features you are using and
what change-timelines ("I need 3 Weeks at minimum, because ...") you would prefer.

If you have implemented a part of the API, please note down in the comments which ones. Doing so will indicate, that we will have to keep this API in a stable state and cannot do breaking changes without the change-timeline you require.

We will use this Issue to note breaking API changes.

There are some things about compatibility and assumptions we are making:

Adding fields should never break your Application
If we differ from the openapi spec this is a bug! Please report it ^^
Undocumented behaviour is not relied upon (tell us if something is undocumented)

CommanderStorm commented 2 years ago

We have renamed nb_hits to estimatedTotalHits in https://github.com/TUM-Dev/navigatum/pull/162/commits/9564038ae53dc7e2f6b849dc3c33e3c0eb9e7bb1

Since nobody has commented on this issue, this is change is going online immediately and without any backwards compatability.

PiotrKedra commented 2 years ago

Implemented more information endpoint (nav.tum.sexy/api/get/:id ) and search endpoint (nav.tum.sexy/api/search?q=querry) in https://github.com/TUM-Dev/Campus-Android/pull/1462.

CommanderStorm commented 1 year ago

We have added the localization of the details' endpoint via the ?lang=en query parameter

COM8 commented 1 year ago

Implemented api/search, api/get/{id} and /api/preview/{id} in the UWP TUM Campus-App.

CommanderStorm commented 1 year ago

We have merged the /health and the /source_code endpoints into the /status endpoints See this PR for the full discussion. Given that nobody has indicated that he/she is using this API, this is going into production this evening.

CommanderStorm commented 2 months ago

After looking into what https://github.com/TUM-Dev/NavigaTUM/pull/472 needs I have come to the conclusion that this feature would be simpler if we did not have to have two details-responses (one for /api/get/root and one for /api/get/{id}). => /api/get/root is slated for removal in https://github.com/TUM-Dev/NavigaTUM/pull/1154

Given that nobody has indicated that he/she is using this API, this is going into production at the end of the day.

CommanderStorm commented 1 day ago

poi.nearby_public_transport.mvg was moved into the dedicated /locations/{id}/nearby endpoint. Reason:

nobody currently uses that data and it is somewhat large => not worth transmitting for everybody