mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-05 11:40:42 +00:00
Apply review comments
This commit is contained in:
@@ -6,22 +6,39 @@ namespace Octokit
|
||||
{
|
||||
public interface IIssuesLabelsClient
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets all labels for the issue.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// See the <a href="http://developer.github.com/v3/issues/labels/#list-labels-on-an-issue">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
/// <param name="number">The number of the issue</param>
|
||||
/// <returns>The list of labels</returns>
|
||||
Task<IReadOnlyList<Label>> GetForIssue(string owner, string repo, int number);
|
||||
|
||||
/// <summary>
|
||||
/// Gets all labels for the repository.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// http://developer.github.com/v3/repos/:owner/:repo/labels/:name
|
||||
/// See the <a href="http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <returns></returns>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
/// <returns>The list of labels</returns>
|
||||
Task<IReadOnlyList<Label>> GetForRepository(string owner, string repo);
|
||||
|
||||
/// <summary>
|
||||
/// Gets a single Label by name.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// http://developer.github.com/v3/repos/:owner/:repo/labels/:name
|
||||
/// See the <a href="http://developer.github.com/v3/issues/labels/#get-a-single-label">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <returns></returns>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
/// <param name="name">The name of the label</param>
|
||||
/// <returns>The label</returns>
|
||||
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
||||
Justification = "Method makes a network request")]
|
||||
Task<Label> Get(string owner, string repo, string name);
|
||||
@@ -30,27 +47,37 @@ namespace Octokit
|
||||
/// Deletes a label.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// http://developer.github.com/v3/repos/:owner/:repo/labels/:label
|
||||
/// See the <a href="http://developer.github.com/v3/issues/labels/#delete-a-label">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
/// <param name="name">The name of the label</param>
|
||||
/// <returns></returns>
|
||||
Task Delete(string owner, string repo, string name);
|
||||
|
||||
/// <summary>
|
||||
/// Deletes a label.
|
||||
/// Creates a label.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// http://developer.github.com/v3/repos/:owner/:repo/labels/:label
|
||||
/// See the <a href="http://developer.github.com/v3/issues/labels/#create-a-label">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <returns></returns>
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
/// <param name="newLabel">The data for the label to be created</param>
|
||||
/// <returns>The created label</returns>
|
||||
Task<Label> Create(string owner, string repo, NewLabel newLabel);
|
||||
|
||||
/// <summary>
|
||||
/// Updates a label.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// http://developer.github.com/v3/repos/:owner/:repo/labels/:label
|
||||
/// See the <a href="http://developer.github.com/v3/issues/labels/#update-a-label">API documentation</a> for more information.
|
||||
/// </remarks>
|
||||
/// <returns></returns>
|
||||
Task<Label> Create(string owner, string repo, string name, LabelUpdate labelUpdate);
|
||||
/// <param name="owner">The owner of the repository</param>
|
||||
/// <param name="repo">The name of the repository</param>
|
||||
/// <param name="name">The name of the label</param>
|
||||
/// <param name="labelUpdate">The data for the label to be updated</param>
|
||||
/// <returns>The updated label</returns>
|
||||
Task<Label> Update(string owner, string repo, string name, LabelUpdate labelUpdate);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user