forked from loafle/openapi-generator-original
* Revert "v7.12.0 release" This reverts commit 073723cb4d41187f839fbb46565d109293fa22d7. * set version to v7.13.0-SNAPSHOT * update samples * update doc
OpenDota API - Jetbrains API Client
General API description
Introduction The OpenDota API provides Dota 2 related data including advanced match data extracted from match replays. You can find data that can be used to convert hero and ability IDs and other information provided by the API from the dotaconstants repository. Beginning 2018-04-22, the OpenDota API is limited to 50,000 free calls per month and 60 requests/minute We offer a Premium Tier with unlimited API calls and higher rate limits. Check out the API page to learn more.
- API basepath : https://api.opendota.com/api
- Version : 20.0.0
Documentation for API Endpoints
All URIs are relative to https://api.opendota.com/api, but will link to the .http
file that contains the endpoint definition.
There may be multiple requests for a single endpoint, one for each example described in the OpenAPI specification.
Class | Method | HTTP request | Description |
---|---|---|---|
BenchmarksApi | benchmarksGet | GET /benchmarks | GET /benchmarks |
ConstantsApi | constantsGet | GET /constants | GET /constants |
ConstantsApi | constantsResourceGet | GET /constants/{resource} | GET /constants |
DistributionsApi | distributionsGet | GET /distributions | GET /distributions |
ExplorerApi | explorerGet | GET /explorer | GET /explorer |
FindMatchesApi | findMatchesGet | GET /findMatches | GET / |
HealthApi | healthGet | GET /health | GET /health |
HeroStatsApi | heroStatsGet | GET /heroStats | GET /heroStats |
HeroesApi | heroesGet | GET /heroes | GET /heroes |
HeroesApi | heroesHeroIdDurationsGet | GET /heroes/{hero_id}/durations | GET /heroes/{hero_id}/durations |
HeroesApi | heroesHeroIdItemPopularityGet | GET /heroes/{hero_id}/itemPopularity | GET /heroes/{hero_id}/itemPopularity |
HeroesApi | heroesHeroIdMatchesGet | GET /heroes/{hero_id}/matches | GET /heroes/{hero_id}/matches |
HeroesApi | heroesHeroIdMatchupsGet | GET /heroes/{hero_id}/matchups | GET /heroes/{hero_id}/matchups |
HeroesApi | heroesHeroIdPlayersGet | GET /heroes/{hero_id}/players | GET /heroes/{hero_id}/players |
LeaguesApi | leaguesGet | GET /leagues | GET /leagues |
LeaguesApi | leaguesLeagueIdGet | GET /leagues/{league_id} | GET /leagues/{league_id} |
LeaguesApi | leaguesLeagueIdMatchesGet | GET /leagues/{league_id}/matches | GET /leagues/{league_id}/matches |
LeaguesApi | leaguesLeagueIdTeamsGet | GET /leagues/{league_id}/teams | GET /leagues/{league_id}/teams |
LiveApi | liveGet | GET /live | GET /live |
MatchesApi | matchesMatchIdGet | GET /matches/{match_id} | GET /matches/{match_id} |
MetadataApi | metadataGet | GET /metadata | GET /metadata |
ParsedMatchesApi | parsedMatchesGet | GET /parsedMatches | GET /parsedMatches |
PlayersApi | playersAccountIdCountsGet | GET /players/{account_id}/counts | GET /players/{account_id}/counts |
PlayersApi | playersAccountIdGet | GET /players/{account_id} | GET /players/{account_id} |
PlayersApi | playersAccountIdHeroesGet | GET /players/{account_id}/heroes | GET /players/{account_id}/heroes |
PlayersApi | playersAccountIdHistogramsFieldGet | GET /players/{account_id}/histograms/{field} | GET /players/{account_id}/histograms |
PlayersApi | playersAccountIdMatchesGet | GET /players/{account_id}/matches | GET /players/{account_id}/matches |
PlayersApi | playersAccountIdPeersGet | GET /players/{account_id}/peers | GET /players/{account_id}/peers |
PlayersApi | playersAccountIdProsGet | GET /players/{account_id}/pros | GET /players/{account_id}/pros |
PlayersApi | playersAccountIdRankingsGet | GET /players/{account_id}/rankings | GET /players/{account_id}/rankings |
PlayersApi | playersAccountIdRatingsGet | GET /players/{account_id}/ratings | GET /players/{account_id}/ratings |
PlayersApi | playersAccountIdRecentMatchesGet | GET /players/{account_id}/recentMatches | GET /players/{account_id}/recentMatches |
PlayersApi | playersAccountIdRefreshPost | POST /players/{account_id}/refresh | POST /players/{account_id}/refresh |
PlayersApi | playersAccountIdTotalsGet | GET /players/{account_id}/totals | GET /players/{account_id}/totals |
PlayersApi | playersAccountIdWardmapGet | GET /players/{account_id}/wardmap | GET /players/{account_id}/wardmap |
PlayersApi | playersAccountIdWlGet | GET /players/{account_id}/wl | GET /players/{account_id}/wl |
PlayersApi | playersAccountIdWordcloudGet | GET /players/{account_id}/wordcloud | GET /players/{account_id}/wordcloud |
PlayersByRankApi | playersByRankGet | GET /playersByRank | GET /playersByRank |
ProMatchesApi | proMatchesGet | GET /proMatches | GET /proMatches |
ProPlayersApi | proPlayersGet | GET /proPlayers | GET /proPlayers |
PublicMatchesApi | publicMatchesGet | GET /publicMatches | GET /publicMatches |
RankingsApi | rankingsGet | GET /rankings | GET /rankings |
RecordsApi | recordsFieldGet | GET /records/{field} | GET /records/{field} |
ReplaysApi | replaysGet | GET /replays | GET /replays |
RequestApi | requestJobIdGet | GET /request/{jobId} | GET /request/{jobId} |
RequestApi | requestMatchIdPost | POST /request/{match_id} | POST /request/{match_id} |
ScenariosApi | scenariosItemTimingsGet | GET /scenarios/itemTimings | GET /scenarios/itemTimings |
ScenariosApi | scenariosLaneRolesGet | GET /scenarios/laneRoles | GET /scenarios/laneRoles |
ScenariosApi | scenariosMiscGet | GET /scenarios/misc | GET /scenarios/misc |
SchemaApi | schemaGet | GET /schema | GET /schema |
SearchApi | searchGet | GET /search | GET /search |
StatusApi | statusGet | GET /status | GET /status |
TeamsApi | teamsGet | GET /teams | GET /teams |
TeamsApi | teamsTeamIdGet | GET /teams/{team_id} | GET /teams/{team_id} |
TeamsApi | teamsTeamIdHeroesGet | GET /teams/{team_id}/heroes | GET /teams/{team_id}/heroes |
TeamsApi | teamsTeamIdMatchesGet | GET /teams/{team_id}/matches | GET /teams/{team_id}/matches |
TeamsApi | teamsTeamIdPlayersGet | GET /teams/{team_id}/players | GET /teams/{team_id}/players |
Usage
Prerequisites
You need IntelliJ to be able to run those queries. More information can be found here. You may have some luck running queries using the Code REST Client as well, but your mileage may vary.
Variables and Environment files
- Generally speaking, you want queries to be specific using custom variables. All variables in the
.http
files have the `` format. - You can create public or private environment files to dynamically replace the variables at runtime.
Note: don't commit private environment files! They typically will contain sensitive information like API Keys.
Customizations
If you have control over the generation of the files here, there are two main things you can do
- Select elements to replace as variables during generation. The process is case-sensitive. For example, API_KEY ->
- For this, run the generation with the
bodyVariables
property, followed by a "-" separated list of variables - Example:
--additional-properties bodyVariables=YOUR_MERCHANT_ACCOUNT-YOUR_COMPANY_ACCOUNT-YOUR_BALANCE_PLATFORM
- For this, run the generation with the
- Add custom headers to all requests. This can be useful for example if your specifications are missing security schemes.
- For this, run the generation with the
customHeaders
property, followed by a "&" separated list of variables - Example :
--additional-properties=customHeaders="Cookie:X-API-KEY="&"Accept-Encoding=gzip"
- For this, run the generation with the
This client was generated by the jetbrains-http-client generator of OpenAPI Generator