Equipment Service API (v1)

Download OpenAPI specification:

Operations for managing equipments.

Equipments

List Equipments

List Equipments owned by a user. Supports filtering by equipped status.

query Parameters
filter
any

Filter.

orderBy
any

OrderBy.

page
any

Page number for the pagination request.

limit
any

Number of Equipment to return per page.

Responses

Create an Equipment

Creates a new Equipment for a user.

query Parameters
itemId
required
any

The item to create equipment from.

Responses

Update an Equipment

Updates an Equipment. Use field mask to specify updatable fields (e.g., is_equipped, level).

path Parameters
equipment.id
required
any

The unique ID of the equipment.

Responses

Delete an Equipment

Deletes an Equipment by its ID.

path Parameters
equipmentId
required
any

The ID of the equipment to delete.

Responses

Get an Equipment

Retrieve Equipment details by its ID.

path Parameters
equipmentId
required
any

The ID of the equipment.

Responses

Stream Equipments

Streams equipment updates for a given user. Emits updates when equipment is equipped or unequipped in real-time.

query Parameters
userId
required
any

The ID of the user whose equipments will be streamed.

Responses

Items

List Items

Lists all available Items in the system.

query Parameters
filter
any

Filter.

orderBy
any

OrderBy.

page
any

Page number for the pagination request.

limit
any

Number of Items to return per page.

Responses

Get an Item

Retrieves Item details by item ID.

path Parameters
itemId
required
any

ID of the item to fetch.

Responses

Lobbies

List Lobbies

Lists all Lobbies.

query Parameters
filter
any

Filter.

orderBy
any

OrderBy.

page
any

Page number for the pagination request.

limit
any

Number of Lobbies to return per page.

Responses

Confirm game start

Confirms the start of a game in a Lobby.

path Parameters
gameId
required
any

The ID of the game to confirm.

Responses

Notify game end

Notifies the server about the end of a game in a Lobby.

path Parameters
gameId
required
any

The ID of the game that has ended.

Responses

Update a Lobby

Updates an existing Lobby. Use field mask to specify updatable fields (e.g., owner_user_id).

path Parameters
lobby.id
required
any

Unique identifier for the lobby

Responses

Enter Lobby queue

Enters the matchmaking queue for a specific Lobby.

path Parameters
lobbyId
required
any

The ID of the lobby to enter queue for.

Responses

Exit Lobby queue

Exits the matchmaking queue for a specific Lobby.

path Parameters
lobbyId
required
any

The ID of the lobby to exit queue from.

Responses

Join a Lobby

Joins an existing Lobby using a lobby code.

Responses

Leave a Lobby

Leaves an existing Lobby.

Responses

Stream Lobby updates

Streams real-time updates for a specific Lobby.

query Parameters
lobbyId
required
any

The ID of the lobby to stream updates for.

Responses

LobbyInvites

List LobbyInvites

Lists all LobbyInvites.

query Parameters
filter
any

Filter.

orderBy
any

OrderBy.

page
any

Page number for the pagination request.

limit
any

Number of Lobby Invites to return per page.

Responses

Create a LobbyInvite

Creates a new LobbyInvite for a user.

Responses

Accept a LobbyInvite

Accepts an existing LobbyInvite using the invite code.

Responses

Decline a LobbyInvite

Declines a LobbyInvite.

Responses

Stream LobbyInvites

Streams lobby invite updates for a given user. Emits when a lobby invite is created or updated in real-time.

query Parameters
userId
required
any

The ID of the user whose lobby invites will be streamed.

Responses

Users

List Users

List Users with optional filters and pagination.

query Parameters
filter
any

Filter.

orderBy
any

OrderBy.

page
any

Page number for the pagination request.

limit
any

Number of Users to return per page.

Responses

Create a User

Creates a new User in the system.

query Parameters
password
required
any

New password for the User.

validateOnly
any

If true, the system will validate the request but not create the User.

Responses

Update a User

Update the details of an existing User with update mask and validate-only option.

path Parameters
user.id
required
any

Unique identifier for the user.

query Parameters
validateOnly
any

If true, the system will validate the update but not apply it.

Responses

Delete a User

Delete a specific User by their unique ID.

path Parameters
userId
required
any

Unique identifier of the User to delete.

Responses

Get a User

Retrieve the details of a specific User by their unique ID.

path Parameters
userId
required
any

Unique identifier of the User to retrieve.

Responses

Ping

Simple ping to indicate that a User is online.

path Parameters
userId
required
any

Unique identifier of the User to ping server.

Responses

Reset a User's password

Request a password reset for a specific User.

path Parameters
userId
required
any

Unique identifier of the User requesting a password reset.

Responses

Authenticate a User

Authenticate a User by their credentials (e.g., email/password).

Responses

Stream User updates

Server-side streaming RPC for real-time User updates.

query Parameters
userId
any

Optional filters.

Responses