docs: module call response, error codes, remove scenarios
CI / build (push) Successful in 13s

This commit is contained in:
edmand46
2026-09-17 12:27:51 +03:00
parent f3eda1e8b7
commit 2f672b861f
8 changed files with 136 additions and 252 deletions
+47 -73
View File
@@ -49,9 +49,9 @@ wire-формат, в прикладном коде его импортиров
## Handles
`client.Player(id)` и `client.Leaderboard(slug)` создают handle без
HTTP-запроса. Handles — сахар над batch-методами сервисов: каждая операция
отправляет batch из одного элемента с подставленным playerID/slug.
`client.Player(id)` создаёт handle без HTTP-запроса. Handle — сахар над
batch-методами сервисов: каждая операция отправляет batch из одного элемента
с подставленным playerID.
```go
player := client.Player("p1")
@@ -64,13 +64,6 @@ wallet, err := player.Wallet().Adjust(ctx, rudder.AdjustPlayerWalletParameters{
})
history, err := player.Wallet().History(ctx, rudder.WalletHistoryParameters{Limit: 50})
item, err := player.Inventory().Adjust(ctx, rudder.AdjustPlayerInventoryParameters{
Slug: "sword",
Amount: 1,
Reason: "quest reward",
})
inventory, err := player.Inventory().List(ctx, rudder.ListInventoryParameters{Limit: 50})
storage, err := player.Storage().Get(ctx, "settings")
updated, err := player.Storage().Upsert(ctx, rudder.UpsertPlayerStorageParameters{
Type: "settings",
@@ -78,10 +71,6 @@ updated, err := player.Storage().Upsert(ctx, rudder.UpsertPlayerStorageParameter
})
err = player.Storage().Delete(ctx, rudder.DeletePlayerStorageParameters{Type: "settings"})
quests, err := player.Quests().List(ctx)
err = player.Quests().Reset(ctx, rudder.PlayerQuestParameters{QuestSlug: "daily-1"})
// ForceComplete и ForceClaim — аналогично
updatedPlayer, err := player.Update(ctx, rudder.UpdatePlayerParameters{Nickname: "Neo"})
banned, err := player.Ban(ctx, rudder.BanPlayerParameters{
Reason: "cheating",
@@ -89,18 +78,6 @@ banned, err := player.Ban(ctx, rudder.BanPlayerParameters{
})
unbanned, err := player.Unban(ctx, "")
err = player.Delete(ctx, "")
board := client.Leaderboard("weekly")
entries, err := board.List(ctx, rudder.ListLeaderboardEntriesParameters{Limit: 100})
// entries.Entries []rudder.Rank, entries.NextCursor
entry, err := board.Get(ctx, "p1") // *rudder.Rank с rank
around, err := board.GetAround(ctx, "p1", 10) // []rudder.Rank вокруг игрока
err = board.Submit(ctx, []rudder.LeaderboardScore{{PlayerID: "p1", Score: 1500}})
err = board.Update(ctx, []rudder.LeaderboardScore{{PlayerID: "p1", Score: 1600}})
err = board.Delete(ctx, []string{"p1", "p2"})
```
## Batch-first API
@@ -118,12 +95,6 @@ wallets, err := client.Wallet.Adjust(ctx, rudder.AdjustWalletParameters{
},
})
items, err := client.Inventory.Adjust(ctx, rudder.AdjustInventoryParameters{
Items: []rudder.InventoryAdjustment{
{PlayerID: "p1", Slug: "sword", Amount: 1, Reason: "quest reward"},
},
})
updated, err := client.Players.Update(ctx, rudder.UpdatePlayersParameters{
Items: []rudder.PlayerUpdate{
{PlayerID: "p1", Nickname: "Neo"},
@@ -143,8 +114,42 @@ unbanned, err := client.Players.Unban(ctx, rudder.UnbanPlayersParameters{
err = client.Players.Delete(ctx, rudder.DeletePlayersParameters{
PlayerIDs: []string{"p3"},
})
err = client.Storage.Upsert(ctx, rudder.UpsertStorageParameters{
Items: []rudder.ProjectStorageInput{
{Type: "config", Data: `{"event":"x2"}`},
},
})
err = client.Storage.Delete(ctx, rudder.DeleteStorageParameters{
Types: []string{"config"},
})
rows, err := client.Resources.Create(ctx, "entries", []rudder.ResourceBatchItem{
{PlayerID: "p1", Data: map[string]any{"board": "weekly", "score": 1500}},
})
// Update и Delete — аналогично, строка задаётся полем ID
```
## Модули
Игровые фичи (инвентарь, квесты, лидерборды, магазины, battle pass, remote
config) — это установленные модули. Их данные доступны через
`client.Resources`, а функции с триггером `admin` вызываются через
`client.Modules.Call` (`POST /game/v1/modules/{module}/{fn}`):
```go
out, err := client.Modules.Call(ctx, rudder.CallParameters{
Module: "leaderboards",
Fn: "resetNow",
Args: map[string]any{"row": map[string]any{"id": boardID}},
})
// out.Result, out.Error, out.Log, out.Console; DryRun: true всегда откатывает транзакцию
```
Бизнес-ошибка модуля приходит как `*rudder.APIError` со статусом 422 и
`Code`, который задаёт сам модуль (произвольная строка, констант для неё нет).
## Верификация авторизации
`Players.VerifyAuth` — одиночный (не batch) вызов `POST /players/auth/verify`:
@@ -165,60 +170,26 @@ if !rudder.VerifyWebhookSignature(secret, body, r.Header.Get("X-Signature")) {
}
```
err = client.Quests.Reset(ctx, rudder.PlayerQuestsParameters{
Items: []rudder.PlayerQuestRef{
{PlayerID: "p1", QuestSlug: "daily-1"},
},
})
// ForceComplete и ForceClaim — аналогично
err = client.Leaderboards.Submit(ctx, "weekly", []rudder.LeaderboardScore{
{PlayerID: "p1", Score: 1500},
})
// Update и Delete — аналогично
err = client.Storage.Upsert(ctx, rudder.UpsertStorageParameters{
Items: []rudder.ProjectStorageInput{
{Type: "config", Data: `{"event":"x2"}`},
},
})
err = client.Storage.Delete(ctx, rudder.DeleteStorageParameters{
Types: []string{"config"},
})
```
## Каталоги и read-операции
Курсорная пагинация: передавайте `Limit`/`Cursor`, следующую страницу
запрашивайте по `NextCursor` из ответа.
```go
boards, err := client.Leaderboards.List(ctx, rudder.ListLeaderboardsParameters{Limit: 100})
// boards.Items []rudder.Leaderboard, boards.NextCursor
quests, err := client.Quests.List(ctx, rudder.ListQuestsParameters{
Status: &status, // "active" или "archived", optional
Limit: 100,
})
// quests.Items []rudder.Quest, quests.NextCursor
history, err := client.Wallet.History(ctx, playerID, rudder.WalletHistoryParameters{
Currency: &currency, // optional
Limit: 50,
})
// history.Entries []rudder.WalletTransaction, history.NextCursor
inventory, err := client.Inventory.List(ctx, playerID, rudder.ListInventoryParameters{
Limit: 50,
})
// inventory.Items []rudder.InventoryItem, inventory.NextCursor
storage, err := client.Storage.List(ctx, rudder.ListStorageParameters{
Limit: 100,
Search: "config", // optional
})
item, err := client.Storage.Get(ctx, "config")
rows, err := client.Resources.List(ctx, "boards")
// rows.Items, rows.Total
```
## Ошибки
@@ -227,13 +198,16 @@ item, err := client.Storage.Get(ctx, "config")
var apiErr *rudder.APIError
if errors.As(err, &apiErr) {
apiErr.Status // HTTP status
apiErr.Code // машинный код из тела ошибки gateway
apiErr.RequestID // корреляция с логами gateway
apiErr.Code // машинный код из тела ошибки
apiErr.RequestID // корреляция с логами сервера
}
```
Сгенерированные коды сервера — `forbidden` и `row_referenced`. Бизнес-ошибки
модулей (422) несут собственный код модуля.
## Генерация
`models/` генерируется apigen'ом из `liveops-gateway/openapi.yaml`
(`make generate-openapi` в liveops-gateway). Руками не править.
`models/` генерируется apigen'ом из `liveops-backend/openapi/openapi.yaml`
(`make generate-openapi` в liveops-backend). Руками не править.
Публичные имена — aliases в корне пакета `rudder` (`types.go`).