Migrate to GraphQL

[BredeD]

OTP has several APIs.

PLC decided on March 2023

• the REST API will be deprecated and rebranded the "OTP Legacy API"
• the HSL (legacy) GraphQL API will move out of the sandbox and rebranded the "OTP GTFS GraphQL API v1"
• the Transmodel GraphQL will also move out of the sandbox and rebranded the "OTP Transmodel GraphQL API v1"

the debug UI will be updated to use the OTP GTFS GraphQL API v1

Later, we will create a new "Unified GraphQL API" to replace those three old APIs. New GraphQL APIs

Linked issues:

• Deprecating the REST API and making the HSL (legacy) GraphQL API the default one #4828

[BredeD]

Migrate existing instances to the GraphQL api

[leonardehrenfried]

Isn't HSL already using GraphQL very heavily? I think it's IBI who is the last institutional user of the REST API.

[optionsome]

Yes I think there have been some misunderstanding. We are interested about having a new GraphQL API that has been planned for a while now. The state of the current GraphQL API we use is ok but there are some issues that we would like to fix. Currently, there isn't an official GraphQL API in the OTP project and we have a lot of maintenance burden from having 3 different APIs (2 GraphQL, 1 REST). Therefore, creating a new API the replace those 3 old APIs would make sense.

[BredeD]

@leonardehrenfried @optionsome, yes, there where a misunderstanding. Updated the issue text.
Made this issue as an example of a joint roadmap from the PO meeting.

Do you have access to edit the issue text? If you do, please change it to make it clearer if needed.