mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
6bb0408582
* reworks all number parameter names to represent what they actually are. Refactors some types to be the appropriate types based on OpenAPI and docs. * updates interfaces and implementations for id naming * updates reactive to match sync SDKs
324 lines
17 KiB
C#
324 lines
17 KiB
C#
using System.Collections.Generic;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Issue Labels API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/">Issue Labels API documentation</a> for more information.
|
|
/// </remarks>
|
|
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="name">The name of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
Task<IReadOnlyList<Label>> GetAllForIssue(string owner, string name, int issueNumber);
|
|
|
|
/// <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="repositoryId">The Id of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
Task<IReadOnlyList<Label>> GetAllForIssue(long repositoryId, int issueNumber);
|
|
|
|
/// <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="name">The name of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Label>> GetAllForIssue(string owner, string name, int issueNumber, ApiOptions options);
|
|
|
|
/// <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="repositoryId">The Id of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Label>> GetAllForIssue(long repositoryId, int issueNumber, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all labels for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
Task<IReadOnlyList<Label>> GetAllForRepository(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets all labels for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
Task<IReadOnlyList<Label>> GetAllForRepository(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Gets all labels for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Label>> GetAllForRepository(string owner, string name, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all labels for the repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Label>> GetAllForRepository(long repositoryId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets labels for every issue in a milestone
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="milestoneNumber">The number of the milestone</param>
|
|
Task<IReadOnlyList<Label>> GetAllForMilestone(string owner, string name, int milestoneNumber);
|
|
|
|
/// <summary>
|
|
/// Gets labels for every issue in a milestone
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="milestoneNumber">The number of the milestone</param>
|
|
Task<IReadOnlyList<Label>> GetAllForMilestone(long repositoryId, int milestoneNumber);
|
|
|
|
/// <summary>
|
|
/// Gets labels for every issue in a milestone
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="milestoneNumber">The number of the milestone</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Label>> GetAllForMilestone(string owner, string name, int milestoneNumber, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets labels for every issue in a milestone
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="milestoneNumber">The number of the milestone</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Label>> GetAllForMilestone(long repositoryId, int milestoneNumber, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets a single Label by name.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#get-a-single-label">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="labelName">The name of the label</param>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
|
Justification = "Method makes a network request")]
|
|
Task<Label> Get(string owner, string name, string labelName);
|
|
|
|
/// <summary>
|
|
/// Gets a single Label by name.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#get-a-single-label">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="labelName">The name of the label</param>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
|
Justification = "Method makes a network request")]
|
|
Task<Label> Get(long repositoryId, string labelName);
|
|
|
|
/// <summary>
|
|
/// Deletes a label.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// 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="name">The name of the repository</param>
|
|
/// <param name="labelName">The name of the label</param>
|
|
Task Delete(string owner, string name, string labelName);
|
|
|
|
/// <summary>
|
|
/// Deletes a label.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#delete-a-label">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="labelName">The name of the label</param>
|
|
Task Delete(long repositoryId, string labelName);
|
|
|
|
/// <summary>
|
|
/// Creates a label.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#create-a-label">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="newLabel">The data for the label to be created</param>
|
|
Task<Label> Create(string owner, string name, NewLabel newLabel);
|
|
|
|
/// <summary>
|
|
/// Creates a label.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#create-a-label">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="newLabel">The data for the label to be created</param>
|
|
Task<Label> Create(long repositoryId, NewLabel newLabel);
|
|
|
|
/// <summary>
|
|
/// Updates a label.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#update-a-label">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="labelName">The name of the label</param>
|
|
/// <param name="labelUpdate">The data for the label to be updated</param>
|
|
Task<Label> Update(string owner, string name, string labelName, LabelUpdate labelUpdate);
|
|
|
|
/// <summary>
|
|
/// Updates a label.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#update-a-label">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="labelName">The name of the label</param>
|
|
/// <param name="labelUpdate">The data for the label to be updated</param>
|
|
Task<Label> Update(long repositoryId, string labelName, LabelUpdate labelUpdate);
|
|
|
|
/// <summary>
|
|
/// Adds a label to an issue
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#add-labels-to-an-issue">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
/// <param name="labels">The names of the labels to add</param>
|
|
Task<IReadOnlyList<Label>> AddToIssue(string owner, string name, int issueNumber, string[] labels);
|
|
|
|
/// <summary>
|
|
/// Adds a label to an issue
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#add-labels-to-an-issue">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
/// <param name="labels">The names of the labels to add</param>
|
|
Task<IReadOnlyList<Label>> AddToIssue(long repositoryId, int issueNumber, string[] labels);
|
|
|
|
/// <summary>
|
|
/// Removes a label from an issue
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
/// <param name="labelName">The name of the label to remove</param>
|
|
Task<IReadOnlyList<Label>> RemoveFromIssue(string owner, string name, int issueNumber, string labelName);
|
|
|
|
/// <summary>
|
|
/// Removes a label from an issue
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
/// <param name="labelName">The name of the label to remove</param>
|
|
Task<IReadOnlyList<Label>> RemoveFromIssue(long repositoryId, int issueNumber, string labelName);
|
|
|
|
/// <summary>
|
|
/// Replaces all labels on the specified issues with the provided labels
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
/// <param name="labels">The names of the labels to set</param>
|
|
Task<IReadOnlyList<Label>> ReplaceAllForIssue(string owner, string name, int issueNumber, string[] labels);
|
|
|
|
/// <summary>
|
|
/// Replaces all labels on the specified issues with the provided labels
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
/// <param name="labels">The names of the labels to set</param>
|
|
Task<IReadOnlyList<Label>> ReplaceAllForIssue(long repositoryId, int issueNumber, string[] labels);
|
|
|
|
/// <summary>
|
|
/// Removes all labels from an issue
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
Task RemoveAllFromIssue(string owner, string name, int issueNumber);
|
|
|
|
/// <summary>
|
|
/// Removes all labels from an issue
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="issueNumber">The number of the issue</param>
|
|
Task RemoveAllFromIssue(long repositoryId, int issueNumber);
|
|
}
|
|
}
|