Skip to content

ORB-233: Deprecate social API (part 1, deprecation) #773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomasluizon merged 2 commits into from
Oct 19, 2026
Merged

ORB-233: Deprecate social API (part 1, deprecation) #773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9726d21
Deprecate social API routes and required profile fields (ORB-233 part 1)
thomasluizon Oct 19, 2026
67237b3
Merge origin/main and consolidate social deprecation coverage (#239)
thomasluizon Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/Orbit.Api/Controllers/FriendsController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ public record BlockUserBody([property: JsonRequired] Guid BlockedUserId);
public record ReportUserBody([property: JsonRequired] Guid ReportedUserId, [property: JsonRequired] ReportReason Reason, string? Details, Guid? CheerId);

[HttpGet]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
public async Task<IActionResult> GetFriends(CancellationToken cancellationToken)
Expand All @@ -33,6 +34,7 @@ public async Task<IActionResult> GetFriends(CancellationToken cancellationToken)
}

[HttpGet("{userId:guid}/profile")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
Expand All @@ -44,6 +46,7 @@ public async Task<IActionResult> GetFriendProfile(Guid userId, CancellationToken
}

[HttpGet("invite-preview")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[DistributedRateLimit("invite-preview")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
Expand All @@ -58,6 +61,7 @@ public async Task<IActionResult> GetInvitePreview(
}

[HttpGet("feed")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
public async Task<IActionResult> GetFeed(
Expand All @@ -71,6 +75,7 @@ public async Task<IActionResult> GetFeed(
}

[HttpGet("cheers")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
public async Task<IActionResult> GetCheers(
Expand All @@ -83,6 +88,7 @@ public async Task<IActionResult> GetCheers(
}

[HttpPost("requests")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[DistributedRateLimit("friend-requests")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
Expand All @@ -103,6 +109,7 @@ public async Task<IActionResult> SendRequest(
}

[HttpPost("requests/{friendshipId:guid}/accept")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[DistributedRateLimit("friend-mutations")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
Expand All @@ -119,6 +126,7 @@ public async Task<IActionResult> AcceptRequest(Guid friendshipId, CancellationTo
}

[HttpDelete("{friendUserId:guid}")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[DistributedRateLimit("friend-mutations")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
Expand All @@ -130,6 +138,7 @@ public async Task<IActionResult> RemoveFriend(Guid friendUserId, CancellationTok
}

[HttpPost("cheers")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[DistributedRateLimit("cheers")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
Expand All @@ -149,6 +158,7 @@ public async Task<IActionResult> SendCheer(
}

[HttpPost("block")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[DistributedRateLimit("block")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
Expand All @@ -167,6 +177,7 @@ public async Task<IActionResult> Block(
}

[HttpDelete("block/{blockedUserId:guid}")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[DistributedRateLimit("unblock")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status403Forbidden)]
Expand All @@ -177,6 +188,7 @@ public async Task<IActionResult> Unblock(Guid blockedUserId, CancellationToken c
}

[HttpPost("report")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[DistributedRateLimit("reports")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
Expand Down
3 changes: 3 additions & 0 deletions src/Orbit.Api/Controllers/ProfileController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,7 @@ public async Task<IActionResult> ResetTour(CancellationToken cancellationToken)
}

[HttpPut("handle")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[DistributedRateLimit("set-handle")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
Expand All @@ -324,6 +325,7 @@ public async Task<IActionResult> SetHandle(
}

[HttpPut("social-opt-in")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status401Unauthorized)]
Expand Down Expand Up @@ -358,6 +360,7 @@ public async Task<IActionResult> UpdateMarketingConsent(
}

[HttpPut("public")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status401Unauthorized)]
Expand Down
1 change: 1 addition & 0 deletions src/Orbit.Api/Controllers/PublicProfileController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ public class PublicProfileController(IMediator mediator, IDistributedCache cache
};

[HttpGet("{slug}")]
[Obsolete("The social API is deprecated and will be removed in part 2 of ORB-233.")]
[AllowAnonymous]
[DistributedRateLimit("public-profile")]
[ProducesResponseType(StatusCodes.Status200OK)]
Expand Down
54 changes: 36 additions & 18 deletions src/Orbit.Api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4708,7 +4708,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/{userId}/profile": {
Expand Down Expand Up @@ -4778,7 +4779,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/invite-preview": {
Expand Down Expand Up @@ -4846,7 +4848,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/feed": {
Expand Down Expand Up @@ -4906,7 +4909,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/cheers": {
Expand Down Expand Up @@ -4955,7 +4959,8 @@
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
Expand Down Expand Up @@ -5034,7 +5039,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/requests": {
Expand Down Expand Up @@ -5135,7 +5141,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/requests/{friendshipId}/accept": {
Expand Down Expand Up @@ -5205,7 +5212,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/{friendUserId}": {
Expand Down Expand Up @@ -5255,7 +5263,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/block": {
Expand Down Expand Up @@ -5336,7 +5345,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/block/{blockedUserId}": {
Expand Down Expand Up @@ -5386,7 +5396,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/friends/report": {
Expand Down Expand Up @@ -5467,7 +5478,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/Gamification/profile": {
Expand Down Expand Up @@ -12670,7 +12682,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/Profile/social-opt-in": {
Expand Down Expand Up @@ -12751,7 +12764,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/Profile/marketing-consent": {
Expand Down Expand Up @@ -12913,7 +12927,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/Profile/reset": {
Expand Down Expand Up @@ -13104,7 +13119,8 @@
}
}
}
}
},
"deprecated": true
}
},
"/api/referrals/code": {
Expand Down Expand Up @@ -18768,10 +18784,12 @@
"type": [
"null",
"string"
]
],
"deprecated": true
},
"socialOptIn": {
"type": "boolean"
"type": "boolean",
"deprecated": true
},
"uses24HourClock": {
"type": "boolean",
Expand Down
Loading
Loading