Module: Lishogi

Defined in:
lib/lishogi/version.rb,
lib/lishogi.rb,
lib/lishogi/api_error.rb,
lib/lishogi/models/ok.rb,
lib/lishogi/api/tv_api.rb,
lib/lishogi/api_client.rb,
lib/lishogi/api/bot_api.rb,
lib/lishogi/models/move.rb,
lib/lishogi/models/perf.rb,
lib/lishogi/models/team.rb,
lib/lishogi/models/user.rb,
lib/lishogi/models/clock.rb,
lib/lishogi/models/count.rb,
lib/lishogi/models/error.rb,
lib/lishogi/models/perfs.rb,
lib/lishogi/models/speed.rb,
lib/lishogi/api/board_api.rb,
lib/lishogi/api/games_api.rb,
lib/lishogi/api/teams_api.rb,
lib/lishogi/api/users_api.rb,
lib/lishogi/configuration.rb,
lib/lishogi/api/simuls_api.rb,
lib/lishogi/models/profile.rb,
lib/lishogi/models/variant.rb,
lib/lishogi/api/account_api.rb,
lib/lishogi/api/puzzles_api.rb,
lib/lishogi/api/studies_api.rb,
lib/lishogi/api/analysis_api.rb,
lib/lishogi/models/game_json.rb,
lib/lishogi/models/game_user.rb,
lib/lishogi/models/not_found.rb,
lib/lishogi/models/perf_type.rb,
lib/lishogi/models/play_time.rb,
lib/lishogi/api/messaging_api.rb,
lib/lishogi/models/light_user.rb,
lib/lishogi/api/challenges_api.rb,
lib/lishogi/models/game_status.rb,
lib/lishogi/models/variant_key.rb,
lib/lishogi/models/o_auth_error.rb,
lib/lishogi/models/team_request.rb,
lib/lishogi/models/user_extended.rb,
lib/lishogi/models/challenge_json.rb,
lib/lishogi/models/challenge_user.rb,
lib/lishogi/models/challenge_event.rb,
lib/lishogi/models/chat_line_event.rb,
lib/lishogi/models/game_event_info.rb,
lib/lishogi/models/game_full_event.rb,
lib/lishogi/models/game_json_clock.rb,
lib/lishogi/models/game_start_event.rb,
lib/lishogi/models/game_state_event.rb,
lib/lishogi/models/light_user_title.rb,
lib/lishogi/models/user_preferences.rb,
lib/lishogi/models/arena_tournaments.rb,
lib/lishogi/models/game_event_player.rb,
lib/lishogi/models/game_finish_event.rb,
lib/lishogi/models/game_json_players.rb,
lib/lishogi/models/puzzle_round_json.rb,
lib/lishogi/api/arena_tournaments_api.rb,
lib/lishogi/models/game_user_analysis.rb,
lib/lishogi/models/account200_response.rb,
lib/lishogi/models/challenge_json_perf.rb,
lib/lishogi/models/game_full_event_perf.rb,
lib/lishogi/models/team_all200_response.rb,
lib/lishogi/models/game_event_info_compat.rb,
lib/lishogi/models/team_request_with_user.rb,
lib/lishogi/models/account_kid200_response.rb,
lib/lishogi/models/challenge_declined_event.rb,
lib/lishogi/models/game_json_analysis_inner.rb,
lib/lishogi/models/account_email200_response.rb,
lib/lishogi/models/challenge_json_time_control.rb,
lib/lishogi/models/api_stream_event200_response.rb,
lib/lishogi/models/board_game_stream200_response.rb,
lib/lishogi/models/game_json_analysis_inner_judgment.rb,
lib/lishogi/models/api_users_status200_response_inner.rb,
lib/lishogi/models/challenge_json_time_control_one_of.rb,
lib/lishogi/models/challenge_json_time_control_one_of1.rb,
lib/lishogi/models/challenge_json_time_control_one_of2.rb,
lib/lishogi/models/board_game_takeback_accept_parameter.rb

Overview

#Lishogi.org API reference

## Introduction Welcome to the reference for the Lishogi API! Lishogi is free/libre, open-source shogi server forked from lichess powered by volunteers and donations. Currently this page is a work in progress, certain information here might be wrong and incorrect! Expect it to be done during 2022. - Get help in the [Lishogi Discord channel](discord.gg/YFtpMGg3rR) - [Contribute to this documentation on Github](github.com/WandererXII/lishogi/blob/master/public/doc/lishogi-api.yaml) - Check out [Lishogi widgets to embed in your website](lishogi.org/developers) ## Endpoint All requests go to ‘lishogi.org` (unless otherwise specified). ## Rate limiting All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a [429 status](en.wikipedia.org/wiki/List_of_HTTP_status_codes#429), please wait a full minute before resuming API usage. ## Streaming with ND-JSON Some API endpoints stream their responses as [Newline Delimited JSON a.k.a. nd-json](ndjson.org/), with one JSON object per line. Here’s a [JavaScript utility function (for lichess)](gist.github.com/ornicar/a097406810939cf7be1df8ea30e94f3e) to help reading NDJSON streamed responses.

The version of the OpenAPI document: 2.0.0 Contact: [email protected] Generated by: openapi-generator.tech Generator version: 7.10.0

Defined Under Namespace

Modules: ApiStreamEvent200Response, BoardGameStream200Response, BoardGameTakebackAcceptParameter, ChallengeJsonTimeControl, LightUserTitle Classes: Account200Response, AccountApi, AccountEmail200Response, AccountKid200Response, AnalysisApi, ApiClient, ApiError, ApiUsersStatus200ResponseInner, ArenaTournaments, ArenaTournamentsApi, BoardApi, BotApi, ChallengeDeclinedEvent, ChallengeEvent, ChallengeJson, ChallengeJsonPerf, ChallengeJsonTimeControlOneOf, ChallengeJsonTimeControlOneOf1, ChallengeJsonTimeControlOneOf2, ChallengeUser, ChallengesApi, ChatLineEvent, Clock, Configuration, Count, Error, GameEventInfo, GameEventInfoCompat, GameEventPlayer, GameFinishEvent, GameFullEvent, GameFullEventPerf, GameJson, GameJsonAnalysisInner, GameJsonAnalysisInnerJudgment, GameJsonClock, GameJsonPlayers, GameStartEvent, GameStateEvent, GameStatus, GameUser, GameUserAnalysis, GamesApi, LightUser, MessagingApi, Move, NotFound, OAuthError, Ok, Perf, PerfType, Perfs, PlayTime, Profile, PuzzleRoundJson, PuzzlesApi, SimulsApi, Speed, StudiesApi, TVApi, Team, TeamAll200Response, TeamRequest, TeamRequestWithUser, TeamsApi, User, UserExtended, UserPreferences, UsersApi, Variant, VariantKey

Constant Summary collapse

VERSION = 
'0.1.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Lishogi.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



104
105
106
107
108
109
110
 
# File 'lib/lishogi.rb', line 104

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end