Skip to content

Commit

Permalink
[FIX]: reworks all number parameter names to represent what they actu…
Browse files Browse the repository at this point in the history 
…ally are. Refactors some types to be the appropriate types based on OpenAPI and docs. (#2948)

* 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
  • Loading branch information
@nickfloyd
nickfloyd authored Jul 2, 2024
1 parent 6565a07 commit 6bb0408
Show file tree
Hide file tree
Showing 77 changed files with 1,935 additions and 1,935 deletions.
1,354 changes: 677 additions & 677 deletions Octokit.AsyncPaginationExtension/Extensions.cs
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions Octokit.Reactive/Clients/IObservableAssigneesClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,20 @@ public interface IObservableAssigneesClient
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="assignees">List of names of assignees to add</param>
/// <returns></returns>
IObservable<Issue> AddAssignees(string owner, string name, int number, AssigneesUpdate assignees);
IObservable<Issue> AddAssignees(string owner, string name, int issueNumber, AssigneesUpdate assignees);

/// <summary>
/// Remove assignees from a specified Issue.
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="assignees">List of assignees to remove </param>
/// <returns></returns>
IObservable<Issue> RemoveAssignees(string owner, string name, int number, AssigneesUpdate assignees);
IObservable<Issue> RemoveAssignees(string owner, string name, int issueNumber, AssigneesUpdate assignees);

/// <summary>
/// Checks to see if a user is an assignee for a repository.
Expand Down
40 changes: 20 additions & 20 deletions Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,94 +107,94 @@ public interface IObservableIssueCommentsClient
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
IObservable<IssueComment> GetAllForIssue(string owner, string name, int number);
/// <param name="issueNumber">The issue number</param>
IObservable<IssueComment> GetAllForIssue(string owner, string name, int issueNumber);

/// <summary>
/// Gets Issue Comments for a specified Issue.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue number</param>
IObservable<IssueComment> GetAllForIssue(long repositoryId, int number);
/// <param name="issueNumber">The issue number</param>
IObservable<IssueComment> GetAllForIssue(long repositoryId, int issueNumber);

/// <summary>
/// Gets Issue Comments for a specified Issue.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<IssueComment> GetAllForIssue(string owner, string name, int number, ApiOptions options);
IObservable<IssueComment> GetAllForIssue(string owner, string name, int issueNumber, ApiOptions options);

/// <summary>
/// Gets Issue Comments for a specified Issue.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<IssueComment> GetAllForIssue(long repositoryId, int number, ApiOptions options);
IObservable<IssueComment> GetAllForIssue(long repositoryId, int issueNumber, ApiOptions options);

/// <summary>
/// Gets Issue Comments for a specified Issue.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="request">The sorting <see cref="IssueCommentRequest">parameters</see></param>
IObservable<IssueComment> GetAllForIssue(string owner, string name, int number, IssueCommentRequest request);
IObservable<IssueComment> GetAllForIssue(string owner, string name, int issueNumber, IssueCommentRequest request);

/// <summary>
/// Gets Issue Comments for a specified Issue.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="request">The sorting <see cref="IssueCommentRequest">parameters</see></param>
IObservable<IssueComment> GetAllForIssue(long repositoryId, int number, IssueCommentRequest request);
IObservable<IssueComment> GetAllForIssue(long repositoryId, int issueNumber, IssueCommentRequest request);

/// <summary>
/// Gets Issue Comments for a specified Issue.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="request">The sorting <see cref="IssueCommentRequest">parameters</see></param>
/// <param name="options">Options for changing the API response</param>
IObservable<IssueComment> GetAllForIssue(string owner, string name, int number, IssueCommentRequest request, ApiOptions options);
IObservable<IssueComment> GetAllForIssue(string owner, string name, int issueNumber, IssueCommentRequest request, ApiOptions options);

/// <summary>
/// Gets Issue Comments for a specified Issue.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="request">The sorting <see cref="IssueCommentRequest">parameters</see></param>
/// <param name="options">Options for changing the API response</param>
IObservable<IssueComment> GetAllForIssue(long repositoryId, int number, IssueCommentRequest request, ApiOptions options);
IObservable<IssueComment> GetAllForIssue(long repositoryId, int issueNumber, IssueCommentRequest request, ApiOptions options);

/// <summary>
/// Creates a new Issue Comment for a specified Issue.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#create-a-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The number of the issue</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="newComment">The text of the new comment</param>
IObservable<IssueComment> Create(string owner, string name, int number, string newComment);
IObservable<IssueComment> Create(string owner, string name, int issueNumber, string newComment);

/// <summary>
/// Creates a new Issue Comment for a specified Issue.
/// </summary>
/// <remarks>http://developer.github.com/v3/issues/comments/#create-a-comment</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The number of the issue</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="newComment">The text of the new comment</param>
IObservable<IssueComment> Create(long repositoryId, int number, string newComment);
IObservable<IssueComment> Create(long repositoryId, int issueNumber, string newComment);

/// <summary>
/// Updates a specified Issue Comment.
Expand Down
24 changes: 12 additions & 12 deletions Octokit.Reactive/Clients/IObservableIssueReactionsClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,54 +17,54 @@ public interface IObservableIssueReactionsClient
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
IObservable<Reaction> GetAll(string owner, string name, int number);
/// <param name="issueNumber">The issue number</param>
IObservable<Reaction> GetAll(string owner, string name, int issueNumber);

/// <summary>
/// List reactions for a specified Issue.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Reaction> GetAll(string owner, string name, int number, ApiOptions options);
IObservable<Reaction> GetAll(string owner, string name, int issueNumber, ApiOptions options);

/// <summary>
/// List reactions for a specified Issue.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue id</param>
IObservable<Reaction> GetAll(long repositoryId, int number);
/// <param name="issueNumber">The issue number</param>
IObservable<Reaction> GetAll(long repositoryId, int issueNumber);

/// <summary>
/// List reactions for a specified Issue.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue id</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Reaction> GetAll(long repositoryId, int number, ApiOptions options);
IObservable<Reaction> GetAll(long repositoryId, int issueNumber, ApiOptions options);

/// <summary>
/// Creates a reaction for a specified Issue.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#create-reaction-for-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="reaction">The reaction to create </param>
IObservable<Reaction> Create(string owner, string name, int number, NewReaction reaction);
IObservable<Reaction> Create(string owner, string name, int issueNumber, NewReaction reaction);

/// <summary>
/// Creates a reaction for a specified Issue.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#create-reaction-for-an-issue</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue id</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="reaction">The reaction to create </param>
IObservable<Reaction> Create(long repositoryId, int number, NewReaction reaction);
IObservable<Reaction> Create(long repositoryId, int issueNumber, NewReaction reaction);

/// <summary>
/// Deletes a reaction for a specified Issue
Expand Down
16 changes: 8 additions & 8 deletions Octokit.Reactive/Clients/IObservableIssueTimelineClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ public interface IObservableIssueTimelineClient
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="number">The issue number</param>
IObservable<TimelineEventInfo> GetAllForIssue(string owner, string repo, int number);
/// <param name="issueNumber">The issue number</param>
IObservable<TimelineEventInfo> GetAllForIssue(string owner, string repo, int issueNumber);

/// <summary>
/// Gets all the various events that have occurred around an issue or pull request.
Expand All @@ -29,9 +29,9 @@ public interface IObservableIssueTimelineClient
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<TimelineEventInfo> GetAllForIssue(string owner, string repo, int number, ApiOptions options);
IObservable<TimelineEventInfo> GetAllForIssue(string owner, string repo, int issueNumber, ApiOptions options);

/// <summary>
/// Gets all the various events that have occurred around an issue or pull request.
Expand All @@ -40,8 +40,8 @@ public interface IObservableIssueTimelineClient
/// https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue number</param>
IObservable<TimelineEventInfo> GetAllForIssue(long repositoryId, int number);
/// <param name="issueNumber">The issue number</param>
IObservable<TimelineEventInfo> GetAllForIssue(long repositoryId, int issueNumber);

/// <summary>
/// Gets all the various events that have occurred around an issue or pull request.
Expand All @@ -50,8 +50,8 @@ public interface IObservableIssueTimelineClient
/// https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="issueNumber">The issue number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<TimelineEventInfo> GetAllForIssue(long repositoryId, int number, ApiOptions options);
IObservable<TimelineEventInfo> GetAllForIssue(long repositoryId, int issueNumber, ApiOptions options);
}
}
Loading

0 comments on commit 6bb0408

Please sign in to comment.