diff --git a/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs index 8f8022be..d0460778 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs @@ -231,6 +231,7 @@ namespace Octokit.Reactive /// The name of the repository /// Thrown when a general API error occurs. /// All es of the repository + [Obsolete("Please use ObservableRepositoriesClient.Branch.GetAll() instead. This method will be removed in a future version")] IObservable GetAllBranches(string owner, string name); /// @@ -242,6 +243,7 @@ namespace Octokit.Reactive /// The Id of the repository /// Thrown when a general API error occurs. /// All es of the repository + [Obsolete("Please use ObservableRepositoriesClient.Branch.GetAll() instead. This method will be removed in a future version")] IObservable GetAllBranches(int repositoryId); /// @@ -255,6 +257,7 @@ namespace Octokit.Reactive /// Options for changing the API response /// Thrown when a general API error occurs. /// All es of the repository + [Obsolete("Please use ObservableRepositoriesClient.Branch.GetAll() instead. This method will be removed in a future version")] IObservable GetAllBranches(string owner, string name, ApiOptions options); /// @@ -267,6 +270,7 @@ namespace Octokit.Reactive /// Options for changing the API response /// Thrown when a general API error occurs. /// All es of the repository + [Obsolete("Please use ObservableRepositoriesClient.Branch.GetAll() instead. This method will be removed in a future version")] IObservable GetAllBranches(int repositoryId, ApiOptions options); /// @@ -480,6 +484,7 @@ namespace Octokit.Reactive /// The name of the repository /// The name of the branch /// The specified + [Obsolete("Please use ObservableRepositoriesClient.Branch.Get() instead. This method will be removed in a future version")] IObservable GetBranch(string owner, string name, string branchName); /// @@ -491,6 +496,7 @@ namespace Octokit.Reactive /// The Id of the repository /// The name of the branch /// The specified + [Obsolete("Please use ObservableRepositoriesClient.Branch.Get() instead. This method will be removed in a future version")] IObservable GetBranch(int repositoryId, string branchName); /// @@ -518,7 +524,7 @@ namespace Octokit.Reactive /// The name of the branch /// New values to update the branch with /// The updated - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the ObservableRepositoryBranchesClient methods instead.")] IObservable EditBranch(string owner, string name, string branch, BranchUpdate update); /// @@ -528,7 +534,7 @@ namespace Octokit.Reactive /// The name of the branch /// New values to update the branch with /// The updated - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the ObservableRepositoryBranchesClient methods instead.")] IObservable EditBranch(int repositoryId, string branch, BranchUpdate update); /// diff --git a/Octokit.Reactive/Clients/IObservableRepositoryBranchesClient.cs b/Octokit.Reactive/Clients/IObservableRepositoryBranchesClient.cs index dbf2452d..f3c06d98 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoryBranchesClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoryBranchesClient.cs @@ -81,7 +81,7 @@ namespace Octokit.Reactive /// The name of the repository /// The name of the branch /// New values to update the branch with - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other ObservableRepositoryBranchesClient methods instead.")] IObservable Edit(string owner, string name, string branch, BranchUpdate update); /// @@ -90,7 +90,7 @@ namespace Octokit.Reactive /// The Id of the repository /// The name of the branch /// New values to update the branch with - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other ObservableRepositoryBranchesClient methods instead.")] IObservable Edit(int repositoryId, string branch, BranchUpdate update); /// diff --git a/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs index dbe5c554..f9f11f82 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs @@ -778,7 +778,7 @@ namespace Octokit.Reactive /// The name of the branch /// New values to update the branch with /// The updated - [Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the ObservableRepositoryBranchesClient methods instead.")] public IObservable EditBranch(string owner, string name, string branch, BranchUpdate update) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -796,7 +796,7 @@ namespace Octokit.Reactive /// The name of the branch /// New values to update the branch with /// The updated - [Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the ObservableRepositoryBranchesClient methods instead.")] public IObservable EditBranch(int repositoryId, string branch, BranchUpdate update) { Ensure.ArgumentNotNullOrEmptyString(branch, "branch"); diff --git a/Octokit.Reactive/Clients/ObservableRepositoryBranchesClient.cs b/Octokit.Reactive/Clients/ObservableRepositoryBranchesClient.cs index eb200bdb..1d2a22b7 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoryBranchesClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoryBranchesClient.cs @@ -122,7 +122,7 @@ namespace Octokit.Reactive /// The name of the repository /// The name of the branch /// New values to update the branch with - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other ObservableRepositoryBranchesClient methods instead.")] public IObservable Edit(string owner, string name, string branch, BranchUpdate update) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -139,7 +139,7 @@ namespace Octokit.Reactive /// The Id of the repository /// The name of the branch /// New values to update the branch with - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other ObservableRepositoryBranchesClient methods instead.")] public IObservable Edit(int repositoryId, string branch, BranchUpdate update) { Ensure.ArgumentNotNullOrEmptyString(branch, "branch"); diff --git a/Octokit/Clients/IRepositoriesClient.cs b/Octokit/Clients/IRepositoriesClient.cs index be88eedf..f0d10e51 100644 --- a/Octokit/Clients/IRepositoriesClient.cs +++ b/Octokit/Clients/IRepositoriesClient.cs @@ -627,7 +627,7 @@ namespace Octokit /// The name of the branch /// New values to update the branch with /// The updated - [Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the RepositoryBranchesClient methods instead.")] Task EditBranch(string owner, string name, string branch, BranchUpdate update); /// @@ -637,7 +637,7 @@ namespace Octokit /// The name of the branch /// New values to update the branch with /// The updated - [Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the RepositoryBranchesClient methods instead.")] Task EditBranch(int repositoryId, string branch, BranchUpdate update); /// diff --git a/Octokit/Clients/IRepositoryBranchesClient.cs b/Octokit/Clients/IRepositoryBranchesClient.cs index 1e4fff9e..469a7013 100644 --- a/Octokit/Clients/IRepositoryBranchesClient.cs +++ b/Octokit/Clients/IRepositoryBranchesClient.cs @@ -86,7 +86,7 @@ namespace Octokit /// The name of the repository /// The name of the branch /// New values to update the branch with - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other RepositoryBranchesClient methods instead.")] Task Edit(string owner, string name, string branch, BranchUpdate update); /// @@ -95,7 +95,7 @@ namespace Octokit /// The Id of the repository /// The name of the branch /// New values to update the branch with - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other RepositoryBranchesClient methods instead.")] Task Edit(int repositoryId, string branch, BranchUpdate update); /// diff --git a/Octokit/Clients/RepositoriesClient.cs b/Octokit/Clients/RepositoriesClient.cs index eefa7e54..37b8713f 100644 --- a/Octokit/Clients/RepositoriesClient.cs +++ b/Octokit/Clients/RepositoriesClient.cs @@ -216,7 +216,7 @@ namespace Octokit /// The name of the branch /// New values to update the branch with /// The updated - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the RepositoryBranchesClient methods instead.")] public Task EditBranch(string owner, string name, string branch, BranchUpdate update) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -234,7 +234,7 @@ namespace Octokit /// The name of the branch /// New values to update the branch with /// The updated - [Obsolete("Please use RepositoriesClient.Branch.Edit() instead. This method will be removed in a future version")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use the RepositoryBranchesClient methods instead.")] public Task EditBranch(int repositoryId, string branch, BranchUpdate update) { Ensure.ArgumentNotNullOrEmptyString(branch, "branch"); diff --git a/Octokit/Clients/RepositoryBranchesClient.cs b/Octokit/Clients/RepositoryBranchesClient.cs index 799273b8..219eec6f 100644 --- a/Octokit/Clients/RepositoryBranchesClient.cs +++ b/Octokit/Clients/RepositoryBranchesClient.cs @@ -124,7 +124,7 @@ namespace Octokit /// The name of the repository /// The name of the branch /// New values to update the branch with - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other RepositoryBranchesClient methods instead.")] public Task Edit(string owner, string name, string branch, BranchUpdate update) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -141,7 +141,7 @@ namespace Octokit /// The Id of the repository /// The name of the branch /// New values to update the branch with - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use other RepositoryBranchesClient methods instead.")] public Task Edit(int repositoryId, string branch, BranchUpdate update) { Ensure.ArgumentNotNullOrEmptyString(branch, "branch"); diff --git a/Octokit/Models/Request/BranchUpdate.cs b/Octokit/Models/Request/BranchUpdate.cs index 776e5947..d65dd0ae 100644 --- a/Octokit/Models/Request/BranchUpdate.cs +++ b/Octokit/Models/Request/BranchUpdate.cs @@ -11,7 +11,7 @@ namespace Octokit /// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/ /// [DebuggerDisplay("{DebuggerDisplay,nq}")] - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please use BranchProtectionSettingsUpdate instead.")] public class BranchUpdate { /// diff --git a/Octokit/Models/Response/Branch.cs b/Octokit/Models/Response/Branch.cs index 43206822..153d446f 100644 --- a/Octokit/Models/Response/Branch.cs +++ b/Octokit/Models/Response/Branch.cs @@ -39,7 +39,7 @@ namespace Octokit /// /// The details for this . /// - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.", false)] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please see the Branch.Protected property and RepositoryBranchesClient.GetBranchProtection method instead.")] public BranchProtection Protection { get; protected set; } /// diff --git a/Octokit/Models/Response/BranchProtection.cs b/Octokit/Models/Response/BranchProtection.cs index 06b25991..94ecf065 100644 --- a/Octokit/Models/Response/BranchProtection.cs +++ b/Octokit/Models/Response/BranchProtection.cs @@ -14,7 +14,7 @@ namespace Octokit /// Note: this is a PREVIEW api: https://developer.github.com/changes/2015-11-11-protected-branches-api/ /// [DebuggerDisplay("{DebuggerDisplay,nq}")] - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please see BranchProtectionSettings instead.")] public class BranchProtection { public BranchProtection() { } @@ -45,7 +45,7 @@ namespace Octokit } [DebuggerDisplay("{DebuggerDisplay,nq}")] - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please see BranchProtectionRequiredStatusChecks instead.")] public class RequiredStatusChecks { public RequiredStatusChecks() { } @@ -78,7 +78,7 @@ namespace Octokit /// /// The enforcement levels that are available /// - [Obsolete("BranchProtection preview functionality in the GitHub API has had breaking changes. This existing implementation will cease to work when the preview period ends.")] + [Obsolete("This existing implementation will cease to work when the Branch Protection API preview period ends. Please see BranchProtectionRequiredStatusChecks.IncludeAdmins instead.")] public enum EnforcementLevel { ///