Add notes to requests for better readability

This commit is contained in:
Julien Lengrand-Lambert
2023-06-07 11:56:36 +02:00
parent fbe768bb9c
commit d3d41a788d
33 changed files with 442 additions and 0 deletions

View File

@@ -3,6 +3,7 @@
{{#operation}}
### {{#summary}}{{summary}}{{/summary}}
## {{#notes}}{{notes}}{{/notes}}
# @name {{operationId}}
{{httpMethod}} {{basePath}}{{#lambda.doubleMustache}}{{path}}{{/lambda.doubleMustache}}
{{#consumes}}Content-Type: {{{mediaType}}}

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.
# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

View File

@@ -0,0 +1,28 @@
Apis/BenchmarksApi.http
Apis/ConstantsApi.http
Apis/DistributionsApi.http
Apis/ExplorerApi.http
Apis/FindMatchesApi.http
Apis/HealthApi.http
Apis/HeroStatsApi.http
Apis/HeroesApi.http
Apis/LeaguesApi.http
Apis/LiveApi.http
Apis/MatchesApi.http
Apis/MetadataApi.http
Apis/ParsedMatchesApi.http
Apis/PlayersApi.http
Apis/PlayersByRankApi.http
Apis/ProMatchesApi.http
Apis/ProPlayersApi.http
Apis/PublicMatchesApi.http
Apis/RankingsApi.http
Apis/RecordsApi.http
Apis/ReplaysApi.http
Apis/RequestApi.http
Apis/ScenariosApi.http
Apis/SchemaApi.http
Apis/SearchApi.http
Apis/StatusApi.http
Apis/TeamsApi.http
README.md

View File

@@ -0,0 +1,6 @@
## BenchmarksApi
### GET /benchmarks
## Benchmarks of average stat values for a hero
# @name benchmarksGet
GET https://api.opendota.com/api/benchmarks

View File

@@ -0,0 +1,11 @@
## ConstantsApi
### GET /constants
## Gets an array of available resources.
# @name constantsGet
GET https://api.opendota.com/api/constants
### GET /constants
## Get static game data mirrored from the dotaconstants repository.
# @name constantsResourceGet
GET https://api.opendota.com/api/constants/{{resource}}

View File

@@ -0,0 +1,6 @@
## DistributionsApi
### GET /distributions
## Distributions of MMR data by bracket and country
# @name distributionsGet
GET https://api.opendota.com/api/distributions

View File

@@ -0,0 +1,6 @@
## ExplorerApi
### GET /explorer
## Submit arbitrary SQL queries to the database
# @name explorerGet
GET https://api.opendota.com/api/explorer

View File

@@ -0,0 +1,6 @@
## FindMatchesApi
### GET /
## Finds recent matches by heroes played
# @name findMatchesGet
GET https://api.opendota.com/api/findMatches

View File

@@ -0,0 +1,6 @@
## HealthApi
### GET /health
## Get service health data
# @name healthGet
GET https://api.opendota.com/api/health

View File

@@ -0,0 +1,6 @@
## HeroStatsApi
### GET /heroStats
## Get stats about hero performance in recent matches
# @name heroStatsGet
GET https://api.opendota.com/api/heroStats

View File

@@ -0,0 +1,31 @@
## HeroesApi
### GET /heroes
## Get hero data
# @name heroesGet
GET https://api.opendota.com/api/heroes
### GET /heroes/{hero_id}/durations
## Get hero performance over a range of match durations
# @name heroesHeroIdDurationsGet
GET https://api.opendota.com/api/heroes/{{hero_id}}/durations
### GET /heroes/{hero_id}/itemPopularity
## Get item popularity of hero categoried by start, early, mid and late game, analyzed from professional games
# @name heroesHeroIdItemPopularityGet
GET https://api.opendota.com/api/heroes/{{hero_id}}/itemPopularity
### GET /heroes/{hero_id}/matches
## Get recent matches with a hero
# @name heroesHeroIdMatchesGet
GET https://api.opendota.com/api/heroes/{{hero_id}}/matches
### GET /heroes/{hero_id}/matchups
## Get results against other heroes for a hero
# @name heroesHeroIdMatchupsGet
GET https://api.opendota.com/api/heroes/{{hero_id}}/matchups
### GET /heroes/{hero_id}/players
## Get players who have played this hero
# @name heroesHeroIdPlayersGet
GET https://api.opendota.com/api/heroes/{{hero_id}}/players

View File

@@ -0,0 +1,21 @@
## LeaguesApi
### GET /leagues
## Get league data
# @name leaguesGet
GET https://api.opendota.com/api/leagues
### GET /leagues/{league_id}
## Get data for a league
# @name leaguesLeagueIdGet
GET https://api.opendota.com/api/leagues/{{league_id}}
### GET /leagues/{league_id}/matches
## Get matches for a team
# @name leaguesLeagueIdMatchesGet
GET https://api.opendota.com/api/leagues/{{league_id}}/matches
### GET /leagues/{league_id}/teams
## Get teams for a league
# @name leaguesLeagueIdTeamsGet
GET https://api.opendota.com/api/leagues/{{league_id}}/teams

View File

@@ -0,0 +1,6 @@
## LiveApi
### GET /live
## Get top currently ongoing live games
# @name liveGet
GET https://api.opendota.com/api/live

View File

@@ -0,0 +1,6 @@
## MatchesApi
### GET /matches/{match_id}
## Match data
# @name matchesMatchIdGet
GET https://api.opendota.com/api/matches/{{match_id}}

View File

@@ -0,0 +1,6 @@
## MetadataApi
### GET /metadata
## Site metadata
# @name metadataGet
GET https://api.opendota.com/api/metadata

View File

@@ -0,0 +1,6 @@
## ParsedMatchesApi
### GET /parsedMatches
## Get list of parsed match IDs
# @name parsedMatchesGet
GET https://api.opendota.com/api/parsedMatches

View File

@@ -0,0 +1,76 @@
## PlayersApi
### GET /players/{account_id}/counts
## Counts in categories
# @name playersAccountIdCountsGet
GET https://api.opendota.com/api/players/{{account_id}}/counts
### GET /players/{account_id}
## Player data
# @name playersAccountIdGet
GET https://api.opendota.com/api/players/{{account_id}}
### GET /players/{account_id}/heroes
## Heroes played
# @name playersAccountIdHeroesGet
GET https://api.opendota.com/api/players/{{account_id}}/heroes
### GET /players/{account_id}/histograms
## Distribution of matches in a single stat
# @name playersAccountIdHistogramsFieldGet
GET https://api.opendota.com/api/players/{{account_id}}/histograms/{{field}}
### GET /players/{account_id}/matches
## Matches played
# @name playersAccountIdMatchesGet
GET https://api.opendota.com/api/players/{{account_id}}/matches
### GET /players/{account_id}/peers
## Players played with
# @name playersAccountIdPeersGet
GET https://api.opendota.com/api/players/{{account_id}}/peers
### GET /players/{account_id}/pros
## Pro players played with
# @name playersAccountIdProsGet
GET https://api.opendota.com/api/players/{{account_id}}/pros
### GET /players/{account_id}/rankings
## Player hero rankings
# @name playersAccountIdRankingsGet
GET https://api.opendota.com/api/players/{{account_id}}/rankings
### GET /players/{account_id}/ratings
## Player rating history
# @name playersAccountIdRatingsGet
GET https://api.opendota.com/api/players/{{account_id}}/ratings
### GET /players/{account_id}/recentMatches
## Recent matches played
# @name playersAccountIdRecentMatchesGet
GET https://api.opendota.com/api/players/{{account_id}}/recentMatches
### POST /players/{account_id}/refresh
## Refresh player match history
# @name playersAccountIdRefreshPost
POST https://api.opendota.com/api/players/{{account_id}}/refresh
### GET /players/{account_id}/totals
## Totals in stats
# @name playersAccountIdTotalsGet
GET https://api.opendota.com/api/players/{{account_id}}/totals
### GET /players/{account_id}/wardmap
## Wards placed in matches played
# @name playersAccountIdWardmapGet
GET https://api.opendota.com/api/players/{{account_id}}/wardmap
### GET /players/{account_id}/wl
## Win/Loss count
# @name playersAccountIdWlGet
GET https://api.opendota.com/api/players/{{account_id}}/wl
### GET /players/{account_id}/wordcloud
## Words said/read in matches played
# @name playersAccountIdWordcloudGet
GET https://api.opendota.com/api/players/{{account_id}}/wordcloud

View File

@@ -0,0 +1,6 @@
## PlayersByRankApi
### GET /playersByRank
## Players ordered by rank/medal tier
# @name playersByRankGet
GET https://api.opendota.com/api/playersByRank

View File

@@ -0,0 +1,6 @@
## ProMatchesApi
### GET /proMatches
## Get list of pro matches
# @name proMatchesGet
GET https://api.opendota.com/api/proMatches

View File

@@ -0,0 +1,6 @@
## ProPlayersApi
### GET /proPlayers
## Get list of pro players
# @name proPlayersGet
GET https://api.opendota.com/api/proPlayers

View File

@@ -0,0 +1,6 @@
## PublicMatchesApi
### GET /publicMatches
## Get list of randomly sampled public matches
# @name publicMatchesGet
GET https://api.opendota.com/api/publicMatches

View File

@@ -0,0 +1,6 @@
## RankingsApi
### GET /rankings
## Top players by hero
# @name rankingsGet
GET https://api.opendota.com/api/rankings

View File

@@ -0,0 +1,6 @@
## RecordsApi
### GET /records/{field}
## Get top performances in a stat
# @name recordsFieldGet
GET https://api.opendota.com/api/records/{{field}}

View File

@@ -0,0 +1,6 @@
## ReplaysApi
### GET /replays
## Get data to construct a replay URL with
# @name replaysGet
GET https://api.opendota.com/api/replays

View File

@@ -0,0 +1,11 @@
## RequestApi
### GET /request/{jobId}
## Get parse request state
# @name requestJobIdGet
GET https://api.opendota.com/api/request/{{jobId}}
### POST /request/{match_id}
## Submit a new parse request
# @name requestMatchIdPost
POST https://api.opendota.com/api/request/{{match_id}}

View File

@@ -0,0 +1,16 @@
## ScenariosApi
### GET /scenarios/itemTimings
## Win rates for certain item timings on a hero for items that cost at least 1400 gold
# @name scenariosItemTimingsGet
GET https://api.opendota.com/api/scenarios/itemTimings
### GET /scenarios/laneRoles
## Win rates for heroes in certain lane roles
# @name scenariosLaneRolesGet
GET https://api.opendota.com/api/scenarios/laneRoles
### GET /scenarios/misc
## Miscellaneous team scenarios
# @name scenariosMiscGet
GET https://api.opendota.com/api/scenarios/misc

View File

@@ -0,0 +1,6 @@
## SchemaApi
### GET /schema
## Get database schema
# @name schemaGet
GET https://api.opendota.com/api/schema

View File

@@ -0,0 +1,6 @@
## SearchApi
### GET /search
## Search players by personaname.
# @name searchGet
GET https://api.opendota.com/api/search

View File

@@ -0,0 +1,6 @@
## StatusApi
### GET /status
## Get current service statistics
# @name statusGet
GET https://api.opendota.com/api/status

View File

@@ -0,0 +1,26 @@
## TeamsApi
### GET /teams
## Get team data
# @name teamsGet
GET https://api.opendota.com/api/teams
### GET /teams/{team_id}
## Get data for a team
# @name teamsTeamIdGet
GET https://api.opendota.com/api/teams/{{team_id}}
### GET /teams/{team_id}/heroes
## Get heroes for a team
# @name teamsTeamIdHeroesGet
GET https://api.opendota.com/api/teams/{{team_id}}/heroes
### GET /teams/{team_id}/matches
## Get matches for a team
# @name teamsTeamIdMatchesGet
GET https://api.opendota.com/api/teams/{{team_id}}/matches
### GET /teams/{team_id}/players
## Get players who have played for a team
# @name teamsTeamIdPlayersGet
GET https://api.opendota.com/api/teams/{{team_id}}/players

View File

@@ -0,0 +1,76 @@
# OpenDota API - Jetbrains API Client
## OpenAPI File 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](https://github.com/odota/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](https://www.opendota.com/api-keys) to learn more.
* API basepath : [https://api.opendota.com/api](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
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BenchmarksApi* | [**benchmarksGet**](Apis/BenchmarksApi.http#benchmarksget) | **GET** /benchmarks | GET /benchmarks
*ConstantsApi* | [**constantsGet**](Apis/ConstantsApi.http#constantsget) | **GET** /constants | GET /constants
*ConstantsApi* | [**constantsResourceGet**](Apis/ConstantsApi.http#constantsresourceget) | **GET** /constants/{resource} | GET /constants
*DistributionsApi* | [**distributionsGet**](Apis/DistributionsApi.http#distributionsget) | **GET** /distributions | GET /distributions
*ExplorerApi* | [**explorerGet**](Apis/ExplorerApi.http#explorerget) | **GET** /explorer | GET /explorer
*FindMatchesApi* | [**findMatchesGet**](Apis/FindMatchesApi.http#findmatchesget) | **GET** /findMatches | GET /
*HealthApi* | [**healthGet**](Apis/HealthApi.http#healthget) | **GET** /health | GET /health
*HeroStatsApi* | [**heroStatsGet**](Apis/HeroStatsApi.http#herostatsget) | **GET** /heroStats | GET /heroStats
*HeroesApi* | [**heroesGet**](Apis/HeroesApi.http#heroesget) | **GET** /heroes | GET /heroes
*HeroesApi* | [**heroesHeroIdDurationsGet**](Apis/HeroesApi.http#heroesheroiddurationsget) | **GET** /heroes/{hero_id}/durations | GET /heroes/{hero_id}/durations
*HeroesApi* | [**heroesHeroIdItemPopularityGet**](Apis/HeroesApi.http#heroesheroiditempopularityget) | **GET** /heroes/{hero_id}/itemPopularity | GET /heroes/{hero_id}/itemPopularity
*HeroesApi* | [**heroesHeroIdMatchesGet**](Apis/HeroesApi.http#heroesheroidmatchesget) | **GET** /heroes/{hero_id}/matches | GET /heroes/{hero_id}/matches
*HeroesApi* | [**heroesHeroIdMatchupsGet**](Apis/HeroesApi.http#heroesheroidmatchupsget) | **GET** /heroes/{hero_id}/matchups | GET /heroes/{hero_id}/matchups
*HeroesApi* | [**heroesHeroIdPlayersGet**](Apis/HeroesApi.http#heroesheroidplayersget) | **GET** /heroes/{hero_id}/players | GET /heroes/{hero_id}/players
*LeaguesApi* | [**leaguesGet**](Apis/LeaguesApi.http#leaguesget) | **GET** /leagues | GET /leagues
*LeaguesApi* | [**leaguesLeagueIdGet**](Apis/LeaguesApi.http#leaguesleagueidget) | **GET** /leagues/{league_id} | GET /leagues/{league_id}
*LeaguesApi* | [**leaguesLeagueIdMatchesGet**](Apis/LeaguesApi.http#leaguesleagueidmatchesget) | **GET** /leagues/{league_id}/matches | GET /leagues/{league_id}/matches
*LeaguesApi* | [**leaguesLeagueIdTeamsGet**](Apis/LeaguesApi.http#leaguesleagueidteamsget) | **GET** /leagues/{league_id}/teams | GET /leagues/{league_id}/teams
*LiveApi* | [**liveGet**](Apis/LiveApi.http#liveget) | **GET** /live | GET /live
*MatchesApi* | [**matchesMatchIdGet**](Apis/MatchesApi.http#matchesmatchidget) | **GET** /matches/{match_id} | GET /matches/{match_id}
*MetadataApi* | [**metadataGet**](Apis/MetadataApi.http#metadataget) | **GET** /metadata | GET /metadata
*ParsedMatchesApi* | [**parsedMatchesGet**](Apis/ParsedMatchesApi.http#parsedmatchesget) | **GET** /parsedMatches | GET /parsedMatches
*PlayersApi* | [**playersAccountIdCountsGet**](Apis/PlayersApi.http#playersaccountidcountsget) | **GET** /players/{account_id}/counts | GET /players/{account_id}/counts
*PlayersApi* | [**playersAccountIdGet**](Apis/PlayersApi.http#playersaccountidget) | **GET** /players/{account_id} | GET /players/{account_id}
*PlayersApi* | [**playersAccountIdHeroesGet**](Apis/PlayersApi.http#playersaccountidheroesget) | **GET** /players/{account_id}/heroes | GET /players/{account_id}/heroes
*PlayersApi* | [**playersAccountIdHistogramsFieldGet**](Apis/PlayersApi.http#playersaccountidhistogramsfieldget) | **GET** /players/{account_id}/histograms/{field} | GET /players/{account_id}/histograms
*PlayersApi* | [**playersAccountIdMatchesGet**](Apis/PlayersApi.http#playersaccountidmatchesget) | **GET** /players/{account_id}/matches | GET /players/{account_id}/matches
*PlayersApi* | [**playersAccountIdPeersGet**](Apis/PlayersApi.http#playersaccountidpeersget) | **GET** /players/{account_id}/peers | GET /players/{account_id}/peers
*PlayersApi* | [**playersAccountIdProsGet**](Apis/PlayersApi.http#playersaccountidprosget) | **GET** /players/{account_id}/pros | GET /players/{account_id}/pros
*PlayersApi* | [**playersAccountIdRankingsGet**](Apis/PlayersApi.http#playersaccountidrankingsget) | **GET** /players/{account_id}/rankings | GET /players/{account_id}/rankings
*PlayersApi* | [**playersAccountIdRatingsGet**](Apis/PlayersApi.http#playersaccountidratingsget) | **GET** /players/{account_id}/ratings | GET /players/{account_id}/ratings
*PlayersApi* | [**playersAccountIdRecentMatchesGet**](Apis/PlayersApi.http#playersaccountidrecentmatchesget) | **GET** /players/{account_id}/recentMatches | GET /players/{account_id}/recentMatches
*PlayersApi* | [**playersAccountIdRefreshPost**](Apis/PlayersApi.http#playersaccountidrefreshpost) | **POST** /players/{account_id}/refresh | POST /players/{account_id}/refresh
*PlayersApi* | [**playersAccountIdTotalsGet**](Apis/PlayersApi.http#playersaccountidtotalsget) | **GET** /players/{account_id}/totals | GET /players/{account_id}/totals
*PlayersApi* | [**playersAccountIdWardmapGet**](Apis/PlayersApi.http#playersaccountidwardmapget) | **GET** /players/{account_id}/wardmap | GET /players/{account_id}/wardmap
*PlayersApi* | [**playersAccountIdWlGet**](Apis/PlayersApi.http#playersaccountidwlget) | **GET** /players/{account_id}/wl | GET /players/{account_id}/wl
*PlayersApi* | [**playersAccountIdWordcloudGet**](Apis/PlayersApi.http#playersaccountidwordcloudget) | **GET** /players/{account_id}/wordcloud | GET /players/{account_id}/wordcloud
*PlayersByRankApi* | [**playersByRankGet**](Apis/PlayersByRankApi.http#playersbyrankget) | **GET** /playersByRank | GET /playersByRank
*ProMatchesApi* | [**proMatchesGet**](Apis/ProMatchesApi.http#promatchesget) | **GET** /proMatches | GET /proMatches
*ProPlayersApi* | [**proPlayersGet**](Apis/ProPlayersApi.http#proplayersget) | **GET** /proPlayers | GET /proPlayers
*PublicMatchesApi* | [**publicMatchesGet**](Apis/PublicMatchesApi.http#publicmatchesget) | **GET** /publicMatches | GET /publicMatches
*RankingsApi* | [**rankingsGet**](Apis/RankingsApi.http#rankingsget) | **GET** /rankings | GET /rankings
*RecordsApi* | [**recordsFieldGet**](Apis/RecordsApi.http#recordsfieldget) | **GET** /records/{field} | GET /records/{field}
*ReplaysApi* | [**replaysGet**](Apis/ReplaysApi.http#replaysget) | **GET** /replays | GET /replays
*RequestApi* | [**requestJobIdGet**](Apis/RequestApi.http#requestjobidget) | **GET** /request/{jobId} | GET /request/{jobId}
*RequestApi* | [**requestMatchIdPost**](Apis/RequestApi.http#requestmatchidpost) | **POST** /request/{match_id} | POST /request/{match_id}
*ScenariosApi* | [**scenariosItemTimingsGet**](Apis/ScenariosApi.http#scenariositemtimingsget) | **GET** /scenarios/itemTimings | GET /scenarios/itemTimings
*ScenariosApi* | [**scenariosLaneRolesGet**](Apis/ScenariosApi.http#scenarioslanerolesget) | **GET** /scenarios/laneRoles | GET /scenarios/laneRoles
*ScenariosApi* | [**scenariosMiscGet**](Apis/ScenariosApi.http#scenariosmiscget) | **GET** /scenarios/misc | GET /scenarios/misc
*SchemaApi* | [**schemaGet**](Apis/SchemaApi.http#schemaget) | **GET** /schema | GET /schema
*SearchApi* | [**searchGet**](Apis/SearchApi.http#searchget) | **GET** /search | GET /search
*StatusApi* | [**statusGet**](Apis/StatusApi.http#statusget) | **GET** /status | GET /status
*TeamsApi* | [**teamsGet**](Apis/TeamsApi.http#teamsget) | **GET** /teams | GET /teams
*TeamsApi* | [**teamsTeamIdGet**](Apis/TeamsApi.http#teamsteamidget) | **GET** /teams/{team_id} | GET /teams/{team_id}
*TeamsApi* | [**teamsTeamIdHeroesGet**](Apis/TeamsApi.http#teamsteamidheroesget) | **GET** /teams/{team_id}/heroes | GET /teams/{team_id}/heroes
*TeamsApi* | [**teamsTeamIdMatchesGet**](Apis/TeamsApi.http#teamsteamidmatchesget) | **GET** /teams/{team_id}/matches | GET /teams/{team_id}/matches
*TeamsApi* | [**teamsTeamIdPlayersGet**](Apis/TeamsApi.http#teamsteamidplayersget) | **GET** /teams/{team_id}/players | GET /teams/{team_id}/players
_This client was generated by the jetbrains-http-client of OpenAPI Generator_