hiper-backend
  1. game
hiper-backend
  • API Conventions
  • user
    • before login
      • login
      • register a user
      • request verification code
      • reset email
      • reset password
    • search users
      GET
    • get the user
      GET
    • get current user
      GET
    • update current user
      PATCH
  • game
    • create
      • create a game
    • administer
      • get settings related info about the game
      • update the game's game logic
      • update the game's match detail
    • get games
      GET
  • contest
    • create
      • create a contest
    • administer
      • get settings related info about the contest
      • update the registration password
    • get contests
      GET
    • register for contest
      PUT
    • exit contest
      DELETE
  • permission
    • grant creation permission
      PUT
    • revoke creation permission
      DELETE
  • base contest
    • administer
      • delete the game
      • add admin
      • relinquish admin
      • update contest script
      • update metadata
      • add a sdk
      • get a sdk
      • delete a sdk
      • update a sdk
      • update states
    • get the game
      GET
    • get AIs
      GET
    • commit an AI
      POST
    • get the ai
      GET
    • download the AI
      GET
    • edit ai note
      PUT
    • get contestants
      GET
    • assign an AI
      PUT
    • get current contestant
      GET
    • revoke the assigned AI
      DELETE
    • get matches
      GET
    • get a match
      GET
    • get sdks
      GET
  1. game

get games

Developing
GET
/games

Request

Header Params
Authorization
string 
optional
Example:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE3MDM1MTA5MjYsImlzcyI6Imp3dCJ9.VgfuWIag0g-pkA2eDkK4bmFE-F6tII9Zjqe1T9IyO9c

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/games' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE3MDM1MTA5MjYsImlzcyI6Imp3dCJ9.VgfuWIag0g-pkA2eDkK4bmFE-F6tII9Zjqe1T9IyO9c'

Responses

🟢200OK
application/json
Body
array of:
base_contest
object (base_contest) 
required
id
integer 
required
game_id
integer 
required
states
object (contest_states) 
required
id
integer 
required
the same with game_id
metadata
object (metadata) 
required
cover_url
string 
required
readme
string 
required
Markdown
title
string 
required
Example
[
  {
    "base_contest": {
      "id": 0,
      "game_id": 0,
      "states": {
        "assign_ai_enabled": true,
        "commit_ai_enabled": true,
        "contest_script_environment_enabled": true,
        "private_match_enabled": true,
        "public_match_enabled": true,
        "test_match_enabled": true
      }
    },
    "id": 0,
    "metadata": {
      "cover_url": "string",
      "readme": "string",
      "title": "string"
    }
  }
]
Modified at 2023-12-25 08:24:46
Previous
update the game's match detail
Next
create a contest
Built with