diff --git a/Octokit.Reactive/Clients/ObservableCommitsClient.cs b/Octokit.Reactive/Clients/ObservableCommitsClient.cs index 41e4cddc..0030f83c 100644 --- a/Octokit.Reactive/Clients/ObservableCommitsClient.cs +++ b/Octokit.Reactive/Clients/ObservableCommitsClient.cs @@ -13,6 +13,16 @@ namespace Octokit.Reactive _client = client.GitDatabase.Commit; } + /// + /// Gets a commit for a given repository by sha reference + /// + /// + /// http://developer.github.com/v3/git/commits/#get-a-commit + /// + /// The owner of the repository + /// The name of the repository + /// Tha sha reference of the commit + /// public IObservable Get(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -22,6 +32,16 @@ namespace Octokit.Reactive return _client.Get(owner, name, reference).ToObservable(); } + /// + /// Create a commit for a given repository + /// + /// + /// http://developer.github.com/v3/git/commits/#create-a-commit + /// + /// The owner of the repository + /// The name of the repository + /// The commit to create + /// public IObservable Create(string owner, string name, NewCommit commit) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); diff --git a/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs index 05d60706..efe5bd81 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs @@ -64,6 +64,12 @@ namespace Octokit.Reactive return _client.Delete(owner, name).ToObservable(); } + /// + /// Retrieves the for the specified owner and name. + /// + /// The owner of the repository + /// The name of the repository + /// A public IObservable Get(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -72,11 +78,26 @@ namespace Octokit.Reactive return _client.Get(owner, name).ToObservable(); } + /// + /// Retrieves every that belongs to the current user. + /// + /// + /// The default page size on GitHub.com is 30. + /// + /// Thrown if the client is not authenticated. + /// A of . public IObservable GetAllForCurrent() { return _connection.GetAndFlattenAllPages(ApiUrls.Repositories()); } + /// + /// Retrieves every that belongs to the specified user. + /// + /// + /// The default page size on GitHub.com is 30. + /// + /// A of . public IObservable GetAllForUser(string login) { Ensure.ArgumentNotNullOrEmptyString(login, "login"); @@ -84,6 +105,13 @@ namespace Octokit.Reactive return _connection.GetAndFlattenAllPages(ApiUrls.Repositories(login)); } + /// + /// Retrieves every that belongs to the specified organization. + /// + /// + /// The default page size on GitHub.com is 30. + /// + /// A of . public IObservable GetAllForOrg(string organization) { Ensure.ArgumentNotNullOrEmptyString(organization, "organization"); @@ -91,6 +119,12 @@ namespace Octokit.Reactive return _connection.GetAndFlattenAllPages(ApiUrls.OrganizationRepositories(organization)); } + /// + /// Returns the HTML rendered README. + /// + /// The owner of the repository + /// The name of the repository + /// public IObservable GetReadme(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -99,6 +133,12 @@ namespace Octokit.Reactive return _client.GetReadme(owner, name).ToObservable(); } + /// + /// Returns just the HTML portion of the README without the surrounding HTML document. + /// + /// The owner of the repository + /// The name of the repository + /// public IObservable GetReadmeHtml(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -107,6 +147,14 @@ namespace Octokit.Reactive return _client.GetReadmeHtml(owner, name).ToObservable(); } + /// + /// A client for GitHub's Commit Status API. + /// + /// + /// See the Commit Status API documentation for more + /// details. Also check out the blog post + /// that announced this feature. + /// public IObservableCommitStatusClient CommitStatus { get; private set; } } } diff --git a/Octokit.Reactive/Clients/ObservableTagsClient.cs b/Octokit.Reactive/Clients/ObservableTagsClient.cs index d54897c6..29cede9f 100644 --- a/Octokit.Reactive/Clients/ObservableTagsClient.cs +++ b/Octokit.Reactive/Clients/ObservableTagsClient.cs @@ -14,6 +14,16 @@ namespace Octokit.Reactive _client = client.GitDatabase.Tag; } + /// + /// Gets a tag for a given repository by sha reference + /// + /// + /// http://developer.github.com/v3/git/tags/#get-a-tag + /// + /// The owner of the repository + /// The name of the repository + /// Tha sha reference of the tag + /// public IObservable Get(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -23,6 +33,16 @@ namespace Octokit.Reactive return _client.Get(owner, name, reference).ToObservable(); } + /// + /// Create a tag for a given repository + /// + /// + /// http://developer.github.com/v3/git/tags/#create-a-tag-object + /// + /// The owner of the repository + /// The name of the repository + /// The tag to create + /// public IObservable Create(string owner, string name, NewTag tag) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); diff --git a/Octokit.Reactive/Clients/ObservableUsersClient.cs b/Octokit.Reactive/Clients/ObservableUsersClient.cs index 81521992..5588e737 100644 --- a/Octokit.Reactive/Clients/ObservableUsersClient.cs +++ b/Octokit.Reactive/Clients/ObservableUsersClient.cs @@ -17,6 +17,10 @@ namespace Octokit.Reactive _connection = client.Connection; } + /// + /// Returns the user specified by the login. + /// + /// The login name for the user public IObservable Get(string login) { Ensure.ArgumentNotNull(login, "login"); @@ -24,11 +28,22 @@ namespace Octokit.Reactive return _client.Get(login).ToObservable(); } + /// + /// Returns a for the current authenticated user. + /// + /// Thrown if the client is not authenticated. + /// A public IObservable Current() { return _client.Current().ToObservable(); } + /// + /// Update the specified . + /// + /// The login for the user + /// Thrown if the client is not authenticated. + /// A public IObservable Update(UserUpdate user) { Ensure.ArgumentNotNull(user, "user"); @@ -36,6 +51,10 @@ namespace Octokit.Reactive return _client.Update(user).ToObservable(); } + /// + /// Returns emails for the current user. + /// + /// public IObservable GetEmails() { return _connection.GetAndFlattenAllPages(ApiUrls.Emails());