Skip to content

Commit 6bb0408

Browse files
nickfloydnickfloyd
authored
[FIX]: reworks all number parameter names to represent what they actually 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
1 parent 6565a07 commit 6bb0408

File tree

77 files changed

+1935
-1935
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+1935
-1935
lines changed

‎Octokit.AsyncPaginationExtension/Extensions.cs

+677-677
Large diffs are not rendered by default.

‎Octokit.Reactive/Clients/IObservableAssigneesClient.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,20 @@ public interface IObservableAssigneesClient
5151
/// </summary>
5252
/// <param name="owner">The owner of the repository</param>
5353
/// <param name="name">The name of the repository</param>
54-
/// <param name="number">The issue number</param>
54+
/// <param name="issueNumber">The issue number</param>
5555
/// <param name="assignees">List of names of assignees to add</param>
5656
/// <returns></returns>
57-
IObservable<Issue> AddAssignees(string owner, string name, int number, AssigneesUpdate assignees);
57+
IObservable<Issue> AddAssignees(string owner, string name, int issueNumber, AssigneesUpdate assignees);
5858

5959
/// <summary>
6060
/// Remove assignees from a specified Issue.
6161
/// </summary>
6262
/// <param name="owner">The owner of the repository</param>
6363
/// <param name="name">The name of the repository</param>
64-
/// <param name="number">The issue number</param>
64+
/// <param name="issueNumber">The issue number</param>
6565
/// <param name="assignees">List of assignees to remove </param>
6666
/// <returns></returns>
67-
IObservable<Issue> RemoveAssignees(string owner, string name, int number, AssigneesUpdate assignees);
67+
IObservable<Issue> RemoveAssignees(string owner, string name, int issueNumber, AssigneesUpdate assignees);
6868

6969
/// <summary>
7070
/// Checks to see if a user is an assignee for a repository.

‎Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs

+20-20
Original file line numberDiff line numberDiff line change
@@ -107,94 +107,94 @@ public interface IObservableIssueCommentsClient
107107
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue</remarks>
108108
/// <param name="owner">The owner of the repository</param>
109109
/// <param name="name">The name of the repository</param>
110-
/// <param name="number">The issue number</param>
111-
IObservable<IssueComment> GetAllForIssue(string owner, string name, int number);
110+
/// <param name="issueNumber">The issue number</param>
111+
IObservable<IssueComment> GetAllForIssue(string owner, string name, int issueNumber);
112112

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

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

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

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

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

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

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

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

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

199199
/// <summary>
200200
/// Updates a specified Issue Comment.

‎Octokit.Reactive/Clients/IObservableIssueReactionsClient.cs

+12-12
Original file line numberDiff line numberDiff line change
@@ -17,54 +17,54 @@ public interface IObservableIssueReactionsClient
1717
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</remarks>
1818
/// <param name="owner">The owner of the repository</param>
1919
/// <param name="name">The name of the repository</param>
20-
/// <param name="number">The issue id</param>
21-
IObservable<Reaction> GetAll(string owner, string name, int number);
20+
/// <param name="issueNumber">The issue number</param>
21+
IObservable<Reaction> GetAll(string owner, string name, int issueNumber);
2222

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

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

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

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

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

6969
/// <summary>
7070
/// Deletes a reaction for a specified Issue

‎Octokit.Reactive/Clients/IObservableIssueTimelineClient.cs

+8-8
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ public interface IObservableIssueTimelineClient
1818
/// </remarks>
1919
/// <param name="owner">The owner of the repository</param>
2020
/// <param name="repo">The name of the repository</param>
21-
/// <param name="number">The issue number</param>
22-
IObservable<TimelineEventInfo> GetAllForIssue(string owner, string repo, int number);
21+
/// <param name="issueNumber">The issue number</param>
22+
IObservable<TimelineEventInfo> GetAllForIssue(string owner, string repo, int issueNumber);
2323

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

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

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

0 commit comments

Comments
 (0)