/// <summary> /// Gets the perferred README's HTML for the specified repository. /// </summary> /// <remarks> /// See the <a href="http://developer.github.com/v3/repos/contents/#get-the-readme">API documentation</a> for more information. /// </remarks> /// <param name="owner">The owner of the repository</param> /// <param name="name">The name of the repository</param> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <returns></returns> public Task <string> GetReadmeHtml(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); return(ApiConnection.GetHtml(ApiUrls.RepositoryReadme(owner, name), null)); }
/// <summary> /// Gets the preferred README for the specified repository. /// </summary> /// <remarks> /// See the <a href="http://developer.github.com/v3/repos/contents/#get-the-readme">API documentation</a> for more information. /// </remarks> /// <param name="repositoryId">The Id of the repository</param> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception> public async Task <Readme> GetReadme(int repositoryId) { var endpoint = ApiUrls.RepositoryReadme(repositoryId); var readmeInfo = await ApiConnection.Get <ReadmeResponse>(endpoint, null).ConfigureAwait(false); return(new Readme(readmeInfo, ApiConnection)); }
/// <summary> /// Gets the preferred README for the specified repository. /// </summary> /// <remarks> /// See the <a href="http://developer.github.com/v3/repos/contents/#get-the-readme">API documentation</a> for more information. /// </remarks> /// <param name="owner">The owner of the repository</param> /// <param name="name">The name of the repository</param> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <returns></returns> public async Task <Readme> GetReadme(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(name, "name"); var endpoint = ApiUrls.RepositoryReadme(owner, name); var readmeInfo = await ApiConnection.Get <ReadmeResponse>(endpoint, null).ConfigureAwait(false); return(new Readme(readmeInfo, ApiConnection)); }
/// <summary> /// Gets the preferred README's HTML for the specified repository. /// </summary> /// <remarks> /// See the <a href="http://developer.github.com/v3/repos/contents/#get-the-readme">API documentation</a> for more information. /// </remarks> /// <param name="repositoryId">The Id of the repository</param> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception> public Task <string> GetReadmeHtml(int repositoryId) { return(ApiConnection.GetHtml(ApiUrls.RepositoryReadme(repositoryId), null)); }