Long term: Migration to UUIDs in API Objects

[MrKrisKrisu]

Dear @Traewelling/api-consumer,

we want to inform you about an upcoming change in our API. Over the long term, we plan to replace the numeric id field in all objects with a UUID. This migration will be done gradually to ensure a smooth transition.

Migration Process

1. Initial Phase:

   • A new uuid field will be added to some models alongside the existing id field.
   • We begin with Status and User.

2. Usage:

   • During this phase, API endpoints will accept either the numeric id or the uuid field as input.

3. Future Phase:

   • Eventually, the id field will be fully replaced by the uuid field.

Action Required

To prepare for this transition, we kindly ask you to:

• Update your systems to support UUIDs in all object id fields.
• Ensure your application logic can handle id values as strings/UUIDs.

There will be no functional changes required at this stage, but it’s important to make this adjustment to avoid potential issues later.

Tip

Continue using the id field as usual. It will remain functional throughout the migration, and the uuid field will be removed once the migration is complete.

Communication and Support

We will provide updates as the migration progresses and communicate timelines for subsequent phases. If you have any questions or need further clarification, don’t hesitate to reach out.

Processdocumentation

Model	UUID added?	API endpoints updated?	UUID -> ID migrated?	UUID column removed?
Checkin	⏳	⏳	⏳	⏳
Follow	⏳	⏳	⏳	⏳
FollowRequest	⏳	⏳	⏳	⏳
Event	⏳	⏳	⏳	⏳
EventSuggestion	⏳	⏳	⏳	⏳
HafasOperator	⏳	⏳	⏳	⏳
IcsToken	⏳	⏳	⏳	⏳
Like	⏳	⏳	⏳	⏳
MastodonServer	⏳	⏳	⏳	⏳
Mention	⏳	⏳	⏳	⏳
OAuthClient	⏳	⏳	⏳	⏳
PolyLine	⏳	⏳	⏳	⏳
PrivacyAgreement	⏳	⏳	⏳	⏳
Report	⏳	⏳	⏳	⏳
Session	⏳	⏳	⏳	⏳
SocialLoginProfile	⏳	⏳	⏳	⏳
Station	⏳	⏳	⏳	⏳
StationName	⏳	⏳	⏳	⏳
Status	⏳	⏳	⏳	⏳
StatusTag	⏳	⏳	⏳	⏳
Stopover	⏳	⏳	⏳	⏳
Trip	⏳	⏳	⏳	⏳
TrustedUser	⏳	⏳	⏳	⏳
User	⏳	⏳	⏳	⏳
UserBlock	⏳	⏳	⏳	⏳
UserMute	⏳	⏳	⏳	⏳
Webhook	⏳	⏳	⏳	⏳
WebhookCreationRequest	⏳	⏳	⏳	⏳
WebhookEvent	⏳	⏳	⏳	⏳
WikidataEntity	⏳	⏳	⏳	⏳