Revert "Move commentary for client methods to the actual interface."

This reverts commit 8f5d035e92.
api/rm-interface
Icedream 2016-06-26 12:24:59 +02:00
parent 9d3290ff36
commit 1d952c49e9
11 changed files with 17 additions and 27 deletions

View File

@ -16,38 +16,16 @@ Provides a high-level client to talk to the API that football-data.org offers.
To create an instance please use NewClient(h). To create an instance please use NewClient(h).
*/ */
type Client interface { type Client interface {
// Fixture prepares a request to fetch the fixtures of a soccer season.
Fixture(id uint64) FixtureRequest Fixture(id uint64) FixtureRequest
// Fixtures prepares a request to fetch the fixtures of a soccer season.
Fixtures() FixturesRequest Fixtures() FixturesRequest
SoccerSeason(id uint64) SoccerSeasonRequest
// FixturesOfSoccerSeason prepares a request to fetch the fixtures of a soccer season.
FixturesOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonFixturesRequest FixturesOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonFixturesRequest
LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest
// FixturesOfTeam prepares a request to fetch the fixtures of a soccer season. TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest
SoccerSeasons() SoccerSeasonsRequest
Team(id uint64) TeamRequest
FixturesOfTeam(id uint64) TeamFixturesRequest FixturesOfTeam(id uint64) TeamFixturesRequest
// LeagueTableOfSoccerSeason prepares a new request to fetch the league table of a given soccer season.
LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest
// PlayersOfTeam prepares a request to fetch a team's players.
PlayersOfTeam(id uint64) TeamPlayersRequest
// SoccerSeason prepares a request to fetch the complete list of soccer seasons.
SoccerSeason(id uint64) SoccerSeasonRequest
// SoccerSeasons prepares a request to fetch the complete list of soccer seasons.
SoccerSeasons() SoccerSeasonsRequest
// Team prepares a request to fetch a team's information.
Team(id uint64) TeamRequest
// TeamsOfSoccerSeason prepares a new request to fetch the league table of a given soccer season.
TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest
// SetToken sets the authentication token.
// Calling this method is *optional*.
SetToken(authToken string) SetToken(authToken string)
} }
@ -70,6 +48,8 @@ func NewClient(h *http.Client) Client {
return &client{httpClient: h} return &client{httpClient: h}
} }
// SetToken sets the authentication token.
// Calling this method is *optional*.
func (c *client) SetToken(authToken string) { func (c *client) SetToken(authToken string) {
c.AuthToken = authToken c.AuthToken = authToken
} }

View File

@ -21,6 +21,7 @@ func (r FixtureRequest) Do() (s Fixture, err error) {
return return
} }
// Fixture prepares a request to fetch the fixtures of a soccer season.
func (c *client) Fixture(id uint64) FixtureRequest { func (c *client) Fixture(id uint64) FixtureRequest {
return FixtureRequest{c.req("fixture/%d", id)} return FixtureRequest{c.req("fixture/%d", id)}
} }

View File

@ -30,6 +30,7 @@ func (r FixturesRequest) Do() (s FixturesResponse, err error) {
return return
} }
// Fixtures prepares a request to fetch the fixtures of a soccer season.
func (c *client) Fixtures() FixturesRequest { func (c *client) Fixtures() FixturesRequest {
return FixturesRequest{c.req("fixtures")} return FixturesRequest{c.req("fixtures")}
} }

View File

@ -13,6 +13,7 @@ func (r SoccerSeasonRequest) Do() (s SoccerSeason, err error) {
return return
} }
// SoccerSeason prepares a request to fetch the complete list of soccer seasons.
func (c *client) SoccerSeason(id uint64) SoccerSeasonRequest { func (c *client) SoccerSeason(id uint64) SoccerSeasonRequest {
return SoccerSeasonRequest{c.req("soccerseasons/%d", id)} return SoccerSeasonRequest{c.req("soccerseasons/%d", id)}
} }

View File

@ -30,6 +30,7 @@ func (r SoccerSeasonFixturesRequest) Do() (s FixtureList, err error) {
return return
} }
// FixturesOfSoccerSeason prepares a request to fetch the fixtures of a soccer season.
func (c *client) FixturesOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonFixturesRequest { func (c *client) FixturesOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonFixturesRequest {
return SoccerSeasonFixturesRequest{c.req("soccerseasons/%d/fixtures", soccerSeasonId)} return SoccerSeasonFixturesRequest{c.req("soccerseasons/%d/fixtures", soccerSeasonId)}
} }

View File

@ -21,6 +21,7 @@ func (r SoccerSeasonLeagueTableRequest) Do() (s SoccerSeason, err error) {
return return
} }
// LeagueTableOfSoccerSeason prepares a new request to fetch the league table of a given soccer season.
func (c *client) LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest { func (c *client) LeagueTableOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonLeagueTableRequest {
return SoccerSeasonLeagueTableRequest{c.req("soccerseasons/%d/leagueTable", soccerSeasonId)} return SoccerSeasonLeagueTableRequest{c.req("soccerseasons/%d/leagueTable", soccerSeasonId)}
} }

View File

@ -13,6 +13,7 @@ func (r SoccerSeasonTeamsRequest) Do() (s TeamList, err error) {
return return
} }
// TeamsOfSoccerSeason prepares a new request to fetch the league table of a given soccer season.
func (c *client) TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest { func (c *client) TeamsOfSoccerSeason(soccerSeasonId uint64) SoccerSeasonTeamsRequest {
return SoccerSeasonTeamsRequest{c.req("soccerseasons/%d/leagueTable", soccerSeasonId)} return SoccerSeasonTeamsRequest{c.req("soccerseasons/%d/leagueTable", soccerSeasonId)}
} }

View File

@ -21,6 +21,7 @@ func (r SoccerSeasonsRequest) Do() (s SoccerSeasonList, err error) {
return return
} }
// SoccerSeasons prepares a request to fetch the complete list of soccer seasons.
func (c *client) SoccerSeasons() SoccerSeasonsRequest { func (c *client) SoccerSeasons() SoccerSeasonsRequest {
return SoccerSeasonsRequest{c.req("soccerseasons")} return SoccerSeasonsRequest{c.req("soccerseasons")}
} }

View File

@ -20,6 +20,7 @@ func (r TeamRequest) Do() (s Team, err error) {
return return
} }
// Team prepares a request to fetch a team's information.
func (c *client) Team(id uint64) TeamRequest { func (c *client) Team(id uint64) TeamRequest {
return TeamRequest{c.req("teams/%d", id), id} return TeamRequest{c.req("teams/%d", id), id}
} }

View File

@ -36,6 +36,7 @@ func (r TeamFixturesRequest) Do() (s FixturesResponse, err error) {
return return
} }
// FixturesOfTeam prepares a request to fetch the fixtures of a soccer season.
func (c *client) FixturesOfTeam(id uint64) TeamFixturesRequest { func (c *client) FixturesOfTeam(id uint64) TeamFixturesRequest {
return TeamFixturesRequest{c.req("teams/%d/fixtures", id)} return TeamFixturesRequest{c.req("teams/%d/fixtures", id)}
} }

View File

@ -13,6 +13,7 @@ func (r TeamPlayersRequest) Do() (s PlayerList, err error) {
return return
} }
// PlayersOfTeam prepares a request to fetch a team's players.
func (c *client) PlayersOfTeam(id uint64) TeamPlayersRequest { func (c *client) PlayersOfTeam(id uint64) TeamPlayersRequest {
return TeamPlayersRequest{c.req("teams/%d/players", id)} return TeamPlayersRequest{c.req("teams/%d/players", id)}
} }