OpenVibe.Play API

Generated at from openvibe-contracts v0.177.0 and openvibe-sdk v0.44.0.

Server https://play.openvibe.network. 5 routes performing 3 capabilities. OpenAPI 3.1 document.

PUT /api/v1/titles/{title}

Register or update a title the caller manages on OpenVibe.Play (PUT /api/v1/titles/:title): its name, address and summary, its achievements (id, name, description, hidden) and its leaderboards (id, na

Capabilities
play.title.manage
Visibility
public
Parameters
  • title (path, required)
Request body
application/json play.title-definition@1
Response
application/json play.title-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>play.title.manage</strong> (public): Register or update a title the caller manages on OpenVibe.Play (PUT /api/v1/titles/:title): its name, address and summary, its achievements (id, name, description, hidden) and its leaderboards (id, name, kind best or sum). The principal that registers a title is its only writer; another one is told it does not exist (404) or, registering it, 409 play.title_taken. A definition left out is retired, never deleted: what players earned stays. A board&#39;s kind never changes (409 play.board_kind_fixed).</p>

POST /api/v1/titles/{title}/players/{guest}/adopt

Post what players did in a title the caller manages: scores for a round to one of its boards (POST /api/v1/titles/:title/scores, up to 100 entries, idempotent by ref), achievements unlocked by a playe

Capabilities
play.result.write
Visibility
public
Parameters
  • title (path, required)
  • guest (path, required)
Request body
application/json play.result-request@1
Response
application/json play.result-response@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>play.result.write</strong> (public): Post what players did in a title the caller manages: scores for a round to one of its boards (POST /api/v1/titles/:title/scores, up to 100 entries, idempotent by ref), achievements unlocked by a player (POST /api/v1/titles/:title/unlocks, answering the new ones), and a guest&#39;s progress moved to the person who signed in (POST /api/v1/titles/:title/players/:guest/adopt). A player is a person&#39;s subject (usr_) or a guest the title names (guest:&lt;opaque&gt;).</p>

GET /api/v1/titles/{title}/players/{player}/achievements

Read one player's unlocked achievements in a title the caller manages (GET /api/v1/titles/:title/players/:player/achievements): how a game shows a guest or a person what they have.

Capabilities
play.player.read
Visibility
public
Parameters
  • title (path, required)
  • player (path, required)
Response
application/json play.player-achievements@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>play.player.read</strong> (public): Read one player&#39;s unlocked achievements in a title the caller manages (GET /api/v1/titles/:title/players/:player/achievements): how a game shows a guest or a person what they have. The boards and titles themselves are public reads that need no capability.</p>

POST /api/v1/titles/{title}/scores

Post what players did in a title the caller manages: scores for a round to one of its boards (POST /api/v1/titles/:title/scores, up to 100 entries, idempotent by ref), achievements unlocked by a playe

Capabilities
play.result.write
Visibility
public
Parameters
  • title (path, required)
Request body
application/json play.result-request@1
Response
application/json play.result-response@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>play.result.write</strong> (public): Post what players did in a title the caller manages: scores for a round to one of its boards (POST /api/v1/titles/:title/scores, up to 100 entries, idempotent by ref), achievements unlocked by a player (POST /api/v1/titles/:title/unlocks, answering the new ones), and a guest&#39;s progress moved to the person who signed in (POST /api/v1/titles/:title/players/:guest/adopt). A player is a person&#39;s subject (usr_) or a guest the title names (guest:&lt;opaque&gt;).</p>

POST /api/v1/titles/{title}/unlocks

Post what players did in a title the caller manages: scores for a round to one of its boards (POST /api/v1/titles/:title/scores, up to 100 entries, idempotent by ref), achievements unlocked by a playe

Capabilities
play.result.write
Visibility
public
Parameters
  • title (path, required)
Request body
application/json play.result-request@1
Response
application/json play.result-response@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>play.result.write</strong> (public): Post what players did in a title the caller manages: scores for a round to one of its boards (POST /api/v1/titles/:title/scores, up to 100 entries, idempotent by ref), achievements unlocked by a player (POST /api/v1/titles/:title/unlocks, answering the new ones), and a guest&#39;s progress moved to the person who signed in (POST /api/v1/titles/:title/players/:guest/adopt). A player is a person&#39;s subject (usr_) or a guest the title names (guest:&lt;opaque&gt;).</p>