Implement improved labels API (#1802)

* Implement new attributes for labels * Include correct API header in all Labels calls * Add integration tests for Create and Update methods for labels * Use improved labels API in observable client * found even more endpoints that need the preview header! * RemoveFromIssue actually returns the list of remaining labels rather than null. This change should be source compatible but not binary compatible * Implement new labels search method in SearchClient * Implement reactive client SearchLabels * Improve documentation for label search methods * more comment tidy up
2026-06-02 02:45:32 +00:00 · 2018-05-17 13:48:45 +02:00
parent f771147f1d
commit fc3e9c2cd2
21 changed files with 436 additions and 74 deletions
@@ -0,0 +1,82 @@
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
+using System.Linq;
+using Octokit.Internal;
+
+namespace Octokit
+{
+    /// <summary>
+    /// Search labels
+    /// https://developer.github.com/v3/search/#search-labels
+    /// </summary>
+    [DebuggerDisplay("{DebuggerDisplay,nq}")]
+    public class SearchLabelsRequest : BaseSearchRequest
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SearchLabelsRequest"/> class.
+        /// </summary>
+        public SearchLabelsRequest() : base()
+        {
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SearchLabelsRequest"/> class.
+        /// </summary>
+        /// <param name="term">The search term.</param>
+        /// <param name="repositoryId">The repository to search in</param>
+        public SearchLabelsRequest(string term, long repositoryId) : base(term)
+        {
+            RepositoryId = repositoryId;
+        }
+
+        /// <summary>
+        /// Optional Sort field. One of created or updated.
+        /// If not provided, results are sorted by best match.
+        /// </summary>
+        public LabelSearchSort? SortField { get; set; }
+
+        public override string Sort
+        {
+            get { return SortField.ToParameter(); }
+        }
+
+        /// <summary>
+        /// The repository to search in
+        /// </summary>
+        public long RepositoryId { get; set; }
+
+        public override IDictionary<string, string> AdditionalParameters()
+        {
+            return new Dictionary<string, string>
+            {
+                { "repository_id", RepositoryId.ToString() }
+            };
+        }
+
+        internal string DebuggerDisplay
+        {
+            get
+            {
+                return string.Format(CultureInfo.InvariantCulture, "Term: {0} Sort: {1} RepositoryId: {2}", Term, Sort, RepositoryId);
+            }
+        }
+    }
+
+    public enum LabelSearchSort
+    {
+        /// <summary>
+        /// search by created
+        /// </summary>
+        [Parameter(Value = "created")]
+        Created,
+        
+        /// <summary>
+        /// search by last updated
+        /// </summary>
+        [Parameter(Value = "updated")]
+        Updated
+    }
+}