Skip to content

docs: add ULID notes for every applicable endpoint #76

New issue

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

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

Already on GitHub? # to your account

Merged
merged 3 commits into from
Mar 13, 2025
Merged

Conversation

wescopeland
Copy link
Member

This PR documents ULID support for the following endpoints:

  • API_GetAchievementOfTheWeek
  • API_GetAchievementUnlocks
  • API_GetAchievementsEarnedBetween
  • API_GetAchievementsEarnedOnDay
  • API_GetActiveClaims
  • API_GetClaims
  • API_GetComments
  • API_GetGameExtended
  • API_GetGameInfoAndUserProgress
  • API_GetGameLeaderboards
  • API_GetGameRankAndScore
  • API_GetLeaderboardEntries
  • API_GetRecentGameAwards
  • API_GetTicketData
  • API_GetTopTenUsers
  • API_GetUserAwards
  • API_GetUserClaims
  • API_GetUserCompletedGames
  • API_GetUserCompletionProgress
  • API_GetUserGameLeaderboards
  • API_GetUserGameRankAndScore
  • API_GetUserPoints
  • API_GetUserProgress
  • API_GetUserRecentAchievements
  • API_GetUserRecentlyPlayedGames
  • API_GetUserSetRequests
  • API_GetUserSummary
  • API_GetUserWantToPlayList
  • API_GetUsersFollowingMe
  • API_GetUsersIFollow

Generally, each endpoint now returns a ULID anywhere a username is returned. Additionally, anything that lets a consumer query by u for username now also allows i for ULID. If an endpoint already is using an i param for something else, d is used instead for ULID.

@wescopeland wescopeland merged commit e2a9dc8 into main Mar 13, 2025
2 checks passed
@wescopeland wescopeland deleted the ulids-docs branch March 13, 2025 10:44
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant