Add comments, move request classes to new file

2026-06-05 03:30:34 +00:00 · 2016-08-08 23:25:52 +10:00
parent 466d0763d2
commit 3bd7323044
11 changed files with 247 additions and 56 deletions
@@ -0,0 +1,122 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Globalization;
+
+namespace Octokit
+{
+    /// <summary>
+    /// Specifies the requested settings for branch protection
+    /// </summary>
+    [DebuggerDisplay("{DebuggerDisplay,nq}")]
+    public class BranchProtectionSettingsUpdate
+    {
+        /// <summary>
+        /// Create a BranchProtection update request
+        /// </summary>
+        /// <param name="requiredStatusChecks">Specifies the requested status check settings</param>
+        /// <param name="restrictions">Specifies the requested push access restrictions (applies only to Organization owned repositories)</param>
+        public BranchProtectionSettingsUpdate(BranchProtectionRequiredStatusChecksUpdate requiredStatusChecks, ProtectedBranchRestrictionsUpdate restrictions)
+        {
+            RequiredStatusChecks = requiredStatusChecks;
+            Restrictions = restrictions;
+        }
+
+        /// <summary>
+        /// Status check settings for protected branch
+        /// </summary>
+        public BranchProtectionRequiredStatusChecksUpdate RequiredStatusChecks { get; protected set; }
+
+        /// <summary>
+        /// Push access restrictions for the protected branch
+        /// </summary>
+        public ProtectedBranchRestrictionsUpdate Restrictions { get; protected set; }
+
+        internal string DebuggerDisplay
+        {
+            get
+            {
+                return String.Format(CultureInfo.InvariantCulture, "StatusChecks: {0} Restrictions: {1}", RequiredStatusChecks, Restrictions);
+            }
+        }
+    }
+
+    /// <summary>
+    /// Specifies the requested status check settings for branch protection
+    /// </summary>
+    [DebuggerDisplay("{DebuggerDisplay,nq}")]
+    public class BranchProtectionRequiredStatusChecksUpdate
+    {
+        /// <summary>
+        /// Status check settings for branch protection
+        /// </summary>
+        /// <param name="includeAdmins">Enforce required status checks for repository administrators</param>
+        /// <param name="strict">Require branches to be up to date before merging</param>
+        /// <param name="contexts">Require status checks to pass before merging</param>
+        public BranchProtectionRequiredStatusChecksUpdate(bool includeAdmins, bool strict, IReadOnlyList<string> contexts)
+        {
+            IncludeAdmins = includeAdmins;
+            Strict = strict;
+            Contexts = contexts;
+        }
+
+        /// <summary>
+        /// Enforce required status checks for repository administrators
+        /// </summary>
+        public bool IncludeAdmins { get; protected set; }
+
+        /// <summary>
+        /// Require branches to be up to date before merging
+        /// </summary>
+        public bool Strict { get; protected set; }
+
+        /// <summary>
+        /// Require status checks to pass before merging
+        /// </summary>
+        public IReadOnlyList<string> Contexts { get; private set; }
+
+        internal string DebuggerDisplay
+        {
+            get
+            {
+                return String.Format(CultureInfo.InvariantCulture, "IncludeAdmins: {0} Strict: {1} Contexts: {2}", IncludeAdmins, Strict, String.Join(",", Contexts));
+            }
+        }
+    }
+
+    /// <summary>
+    /// Specifies people or teams allowed to push to this branch. Required status checks will still prevent these people from merging if the checks fail.
+    /// </summary>
+    [DebuggerDisplay("{DebuggerDisplay,nq}")]
+    public class ProtectedBranchRestrictionsUpdate
+    {
+        /// <summary>
+        /// Specify people or teams allowed to push to this branch. Required status checks will still prevent these people from merging if the checks fail.
+        /// </summary>
+        /// <param name="teams">Teams allowed to push to this branch</param>
+        /// <param name="users">Users allowed to push to this branch</param>
+        public ProtectedBranchRestrictionsUpdate(IReadOnlyList<string> teams, IReadOnlyList<string> users)
+        {
+            Teams = teams;
+            Users = users;
+        }
+
+        /// <summary>
+        /// Teams allowed to push to this branch
+        /// </summary>
+        public IReadOnlyList<string> Teams { get; private set; }
+
+        /// <summary>
+        /// Users allowed to push to this branch
+        /// </summary>
+        public IReadOnlyList<string> Users { get; private set; }
+
+        internal string DebuggerDisplay
+        {
+            get
+            {
+                return String.Format(CultureInfo.InvariantCulture, "Teams: {0} Users: {1}", String.Join(",", Teams), String.Join(",", Users));
+            }
+        }
+    }
+}