Moved GetReadme and GetReadmeHtml to Contents

This commit is contained in:
Kristian Hellang
2014-03-18 20:12:13 +01:00
committed by Haacked
parent 790c07da30
commit bed18b9980
23 changed files with 295 additions and 78 deletions
@@ -0,0 +1,31 @@
using System.Threading.Tasks;
namespace Octokit
{
public interface IRepositoryContentsClient
{
/// <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>
Task<Readme> GetReadme(string owner, string name);
/// <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>
Task<string> GetReadmeHtml(string owner, string name);
}
}