diff --git a/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs index f587e235..33c02be3 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs @@ -117,8 +117,19 @@ namespace Octokit.Reactive /// details. Also check out the blog post /// that announced this feature. /// + [Obsolete("Use Status instead")] IObservableCommitStatusClient CommitStatus { get; } + /// + /// 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. + /// + IObservableCommitStatusClient Status { get; } + /// /// Client for GitHub's Repository Deployments API /// diff --git a/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs b/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs index 43922e5d..b6390bc1 100644 --- a/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs +++ b/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs @@ -13,7 +13,7 @@ namespace Octokit.Reactive { Ensure.ArgumentNotNull(client, "client"); - _client = client.Repository.CommitStatus; + _client = client.Repository.Status; _connection = client.Connection; } diff --git a/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs index 9d0bb128..5364978f 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs @@ -19,7 +19,7 @@ namespace Octokit.Reactive _client = client.Repository; _connection = client.Connection; - CommitStatus = new ObservableCommitStatusClient(client); + Status = new ObservableCommitStatusClient(client); Hooks = new ObservableRepositoryHooksClient(client); Forks = new ObservableRepositoryForksClient(client); RepoCollaborators = new ObservableRepoCollaboratorsClient(client); @@ -186,7 +186,18 @@ namespace Octokit.Reactive /// details. Also check out the blog post /// that announced this feature. /// - public IObservableCommitStatusClient CommitStatus { get; private set; } + [Obsolete("Use Status instead")] + public IObservableCommitStatusClient CommitStatus { get { return Status; }} + + /// + /// 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 Status { get; private set; } /// /// Client for GitHub's Repository Deployments API diff --git a/Octokit.Tests.Integration/Clients/CommitStatusClientTests.cs b/Octokit.Tests.Integration/Clients/CommitStatusClientTests.cs index a3fe99c0..eb1ebbd8 100644 --- a/Octokit.Tests.Integration/Clients/CommitStatusClientTests.cs +++ b/Octokit.Tests.Integration/Clients/CommitStatusClientTests.cs @@ -17,7 +17,7 @@ public class CommitStatusClientTests // to go through the rigamarole of creating it all. But ideally, that's exactly what we'd do. var github = Helper.GetAuthenticatedClient(); - var statuses = await github.Repository.CommitStatus.GetAll( + var statuses = await github.Repository.Status.GetAll( "rails", "rails", "94b857899506612956bb542e28e292308accb908"); @@ -33,7 +33,7 @@ public class CommitStatusClientTests public async Task CanRetrieveCombinedStatus() { var github = Helper.GetAuthenticatedClient(); - var status = await github.Repository.CommitStatus.GetCombined( + var status = await github.Repository.Status.GetCombined( "libgit2", "libgit2sharp", "f54529997b6ad841be524654d9e9074ab8e7d41d"); @@ -69,7 +69,7 @@ public class CommitStatusClientTests Description = "this is a test status" }; - var result = await _github.Repository.CommitStatus.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); + var result = await _github.Repository.Status.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); Assert.Equal(CommitState.Pending, result.State); } @@ -85,9 +85,9 @@ public class CommitStatusClientTests Description = "this is a test status" }; - await _github.Repository.CommitStatus.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); + await _github.Repository.Status.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); - var statuses = await _github.Repository.CommitStatus.GetAll(_context.RepositoryOwner, _context.RepositoryName, commit.Sha); + var statuses = await _github.Repository.Status.GetAll(_context.RepositoryOwner, _context.RepositoryName, commit.Sha); Assert.Equal(1, statuses.Count); Assert.Equal(CommitState.Pending, statuses[0].State); @@ -104,13 +104,13 @@ public class CommitStatusClientTests Description = "this is a test status" }; - await _github.Repository.CommitStatus.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); + await _github.Repository.Status.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); status.State = CommitState.Success; - await _github.Repository.CommitStatus.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); + await _github.Repository.Status.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); - var statuses = await _github.Repository.CommitStatus.GetAll(_context.RepositoryOwner, _context.RepositoryName, commit.Sha); + var statuses = await _github.Repository.Status.GetAll(_context.RepositoryOwner, _context.RepositoryName, commit.Sha); Assert.Equal(2, statuses.Count); Assert.Equal(CommitState.Success, statuses[0].State); @@ -127,9 +127,9 @@ public class CommitStatusClientTests Description = "this is a test status" }; - await _github.Repository.CommitStatus.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); + await _github.Repository.Status.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); - var statuses = await _github.Repository.CommitStatus.GetAll(_context.RepositoryOwner, _context.RepositoryName, commit.Sha); + var statuses = await _github.Repository.Status.GetAll(_context.RepositoryOwner, _context.RepositoryName, commit.Sha); Assert.Equal(1, statuses.Count); Assert.Equal("default", statuses[0].Context); @@ -147,13 +147,13 @@ public class CommitStatusClientTests Context = "System A" }; - await _github.Repository.CommitStatus.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); + await _github.Repository.Status.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); status.Context = "System B"; - await _github.Repository.CommitStatus.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); + await _github.Repository.Status.Create(_context.RepositoryOwner, _context.RepositoryName, commit.Sha, status); - var statuses = await _github.Repository.CommitStatus.GetAll(_context.RepositoryOwner, _context.RepositoryName, commit.Sha); + var statuses = await _github.Repository.Status.GetAll(_context.RepositoryOwner, _context.RepositoryName, commit.Sha); Assert.Equal(2, statuses.Count); Assert.Equal("System B", statuses[0].Context); diff --git a/Octokit/Clients/IRepositoriesClient.cs b/Octokit/Clients/IRepositoriesClient.cs index 2243dcd9..426030f9 100644 --- a/Octokit/Clients/IRepositoriesClient.cs +++ b/Octokit/Clients/IRepositoriesClient.cs @@ -6,7 +6,9 @@ using System.Collections.Generic; namespace Octokit { - /// + using System; + + /// /// A client for GitHub's Repositories API. /// /// @@ -185,8 +187,19 @@ namespace Octokit /// details. Also check out the blog post /// that announced this feature. /// + [Obsolete("Use Status instead")] ICommitStatusClient CommitStatus { get; } + /// + /// 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. + /// + ICommitStatusClient Status { get; } + /// /// A client for GitHub's Repository Hooks API. /// diff --git a/Octokit/Clients/RepositoriesClient.cs b/Octokit/Clients/RepositoriesClient.cs index 1f9f55e7..8d963d91 100644 --- a/Octokit/Clients/RepositoriesClient.cs +++ b/Octokit/Clients/RepositoriesClient.cs @@ -22,7 +22,7 @@ namespace Octokit /// An API connection public RepositoriesClient(IApiConnection apiConnection) : base(apiConnection) { - CommitStatus = new CommitStatusClient(apiConnection); + Status = new CommitStatusClient(apiConnection); Hooks = new RepositoryHooksClient(apiConnection); Forks = new RepositoryForksClient(apiConnection); RepoCollaborators = new RepoCollaboratorsClient(apiConnection); @@ -306,7 +306,18 @@ namespace Octokit /// details. Also check out the blog post /// that announced this feature. /// - public ICommitStatusClient CommitStatus { get; private set; } + [Obsolete("Use Status instead")] + public ICommitStatusClient CommitStatus { get { return Status; } } + + /// + /// 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 ICommitStatusClient Status { get; private set; } /// /// A client for GitHub's Repository Hooks API.