From 87d2b0fdc18f22b758a7cf2fe89c86a018dafcb7 Mon Sep 17 00:00:00 2001 From: Brendan Forster Date: Thu, 19 Mar 2020 16:21:16 -0300 Subject: [PATCH] more cleanup of route metadata (#2158) --- Octokit/Clients/AssigneesClient.cs | 4 ++-- Octokit/Clients/CheckRunsClient.cs | 6 +++--- Octokit/Clients/CommitStatusClient.cs | 4 ++-- Octokit/Clients/IssueReactionsClient.cs | 6 +++--- Octokit/Clients/IssueTimelineClient.cs | 4 ++-- Octokit/Clients/IssuesClient.cs | 8 ++++---- Octokit/Clients/IssuesEventsClient.cs | 4 ++-- Octokit/Clients/IssuesLabelsClient.cs | 20 ++++++++++---------- Octokit/Clients/MergingClient.cs | 2 +- Octokit/Clients/MilestonesClient.cs | 12 ++++++------ Octokit/Clients/RepositoryContentsClient.cs | 4 ++-- Octokit/Clients/RepositoryTrafficClient.cs | 8 ++++---- 12 files changed, 41 insertions(+), 41 deletions(-) diff --git a/Octokit/Clients/AssigneesClient.cs b/Octokit/Clients/AssigneesClient.cs index f1a19883..4938d934 100644 --- a/Octokit/Clients/AssigneesClient.cs +++ b/Octokit/Clients/AssigneesClient.cs @@ -108,7 +108,7 @@ namespace Octokit /// The issue number /// List of names of assignees to add /// - [ManualRoute("POST", "/repos/{owner}/{repo}/issues/{number}/assignees")] + [ManualRoute("POST", "/repos/{owner}/{repo}/issues/{issue_number}/assignees")] public Task AddAssignees(string owner, string name, int number, AssigneesUpdate assignees) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -126,7 +126,7 @@ namespace Octokit /// The issue number /// List of assignees to remove /// - [ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{number}/assignees")] + [ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{issue_number}/assignees")] public Task RemoveAssignees(string owner, string name, int number, AssigneesUpdate assignees) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); diff --git a/Octokit/Clients/CheckRunsClient.cs b/Octokit/Clients/CheckRunsClient.cs index 603a866b..dcefe018 100644 --- a/Octokit/Clients/CheckRunsClient.cs +++ b/Octokit/Clients/CheckRunsClient.cs @@ -106,7 +106,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The commit reference (can be a SHA, branch name, or a tag name) - [ManualRoute("GET", "/repos/{owner}/{name}/commits/{commit_sha}/check-runs")] + [ManualRoute("GET", "/repos/{owner}/{repo}/commits/{commit_sha}/check-runs")] public Task GetAllForReference(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -142,7 +142,7 @@ namespace Octokit /// The name of the repository /// The commit reference (can be a SHA, branch name, or a tag name) /// Details to filter the request, such as by check name - [ManualRoute("GET", "/repos/{owner}/{name}/commits/{commit_sha}/check-runs")] + [ManualRoute("GET", "/repos/{owner}/{repo}/commits/{commit_sha}/check-runs")] public Task GetAllForReference(string owner, string name, string reference, CheckRunRequest checkRunRequest) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -183,7 +183,7 @@ namespace Octokit /// Details to filter the request, such as by check name /// Options to change the API response [Preview("antiope")] - [ManualRoute("GET", "/repos/{owner}/{name}/commits/{commit_sha}/check-runs")] + [ManualRoute("GET", "/repos/{owner}/{repo}/commits/{commit_sha}/check-runs")] public async Task GetAllForReference(string owner, string name, string reference, CheckRunRequest checkRunRequest, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); diff --git a/Octokit/Clients/CommitStatusClient.cs b/Octokit/Clients/CommitStatusClient.cs index 676c5324..f7a34987 100644 --- a/Octokit/Clients/CommitStatusClient.cs +++ b/Octokit/Clients/CommitStatusClient.cs @@ -144,7 +144,7 @@ namespace Octokit /// The name of the repository /// The reference (SHA, branch name, or tag name) to list commits for /// The commit status to create - [ManualRoute("POST", "/repos/{owner}/{repo}/statuses/{ref}")] + [ManualRoute("POST", "/repos/{owner}/{repo}/statuses/{sha}")] public Task Create(string owner, string name, string reference, NewCommitStatus newCommitStatus) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -164,7 +164,7 @@ namespace Octokit /// The Id of the repository /// The reference (SHA, branch name, or tag name) to list commits for /// The commit status to create - [ManualRoute("POST", "/repositories/{id}/statuses/{ref}")] + [ManualRoute("POST", "/repositories/{id}/statuses/{sha}")] public Task Create(long repositoryId, string reference, NewCommitStatus newCommitStatus) { Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference)); diff --git a/Octokit/Clients/IssueReactionsClient.cs b/Octokit/Clients/IssueReactionsClient.cs index ea6f49b9..53c970e0 100644 --- a/Octokit/Clients/IssueReactionsClient.cs +++ b/Octokit/Clients/IssueReactionsClient.cs @@ -23,7 +23,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue id - [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{number}/reactions")] + [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/reactions")] public Task> GetAll(string owner, string name, int number) { return GetAll(owner, name, number, ApiOptions.None); @@ -38,7 +38,7 @@ namespace Octokit /// The issue id /// Options for changing the API response [Preview("squirrel-girl")] - [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{number}/reactions")] + [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/reactions")] public Task> GetAll(string owner, string name, int number, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -85,7 +85,7 @@ namespace Octokit /// The issue id /// The reaction to create [Preview("squirrel-girl")] - [ManualRoute("POST", "/repos/{owner}/{repo}/issues/{number}/reactions")] + [ManualRoute("POST", "/repos/{owner}/{repo}/issues/{issue_number}/reactions")] public Task Create(string owner, string name, int number, NewReaction reaction) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); diff --git a/Octokit/Clients/IssueTimelineClient.cs b/Octokit/Clients/IssueTimelineClient.cs index 5a67862a..00bbb376 100644 --- a/Octokit/Clients/IssueTimelineClient.cs +++ b/Octokit/Clients/IssueTimelineClient.cs @@ -24,7 +24,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue number - [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{number}/timeline")] + [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/timeline")] public Task> GetAllForIssue(string owner, string repo, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -45,7 +45,7 @@ namespace Octokit /// Options for changing the API repsonse [Preview("mockingbird")] [Preview("starfox")] - [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{number}/timeline")] + [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/timeline")] public Task> GetAllForIssue(string owner, string repo, int number, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); diff --git a/Octokit/Clients/IssuesClient.cs b/Octokit/Clients/IssuesClient.cs index 8e9a5a45..e5b12793 100644 --- a/Octokit/Clients/IssuesClient.cs +++ b/Octokit/Clients/IssuesClient.cs @@ -67,7 +67,7 @@ namespace Octokit /// The name of the repository /// The issue number [Preview("squirrel-girl")] - [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{number}")] + [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}")] public Task Get(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -473,7 +473,7 @@ namespace Octokit /// The issue number /// An instance describing the changes to make to the issue /// - [ManualRoute("PATCH", "/repos/{owner}/{repo}/issues/{number}")] + [ManualRoute("PATCH", "/repos/{owner}/{repo}/issues/{issue_number}")] public Task Update(string owner, string name, int number, IssueUpdate issueUpdate) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -507,7 +507,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue number - [ManualRoute("PUT", "/repos/{owner}/{repo}/issues/{number}/lock")] + [ManualRoute("PUT", "/repos/{owner}/{repo}/issues/{issue_number}/lock")] public Task Lock(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -535,7 +535,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue number - [ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{number}/lock")] + [ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{issue_number}/lock")] public Task Unlock(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); diff --git a/Octokit/Clients/IssuesEventsClient.cs b/Octokit/Clients/IssuesEventsClient.cs index 9b16d636..eb782471 100644 --- a/Octokit/Clients/IssuesEventsClient.cs +++ b/Octokit/Clients/IssuesEventsClient.cs @@ -24,7 +24,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue number - [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{number}/events")] + [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/events")] public Task> GetAllForIssue(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -58,7 +58,7 @@ namespace Octokit /// The issue number /// Options for changing the API response [Preview("starfox")] - [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{number}/events")] + [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/events")] public Task> GetAllForIssue(string owner, string name, int number, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); diff --git a/Octokit/Clients/IssuesLabelsClient.cs b/Octokit/Clients/IssuesLabelsClient.cs index 173c9682..a39f6a74 100644 --- a/Octokit/Clients/IssuesLabelsClient.cs +++ b/Octokit/Clients/IssuesLabelsClient.cs @@ -25,7 +25,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The number of the issue - [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{number}/labels")] + [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/labels")] public Task> GetAllForIssue(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -58,7 +58,7 @@ namespace Octokit /// The name of the repository /// The number of the issue /// Options for changing the API response - [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{number}/labels")] + [ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/labels")] public Task> GetAllForIssue(string owner, string name, int number, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -159,7 +159,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The number of the milestone - [ManualRoute("GET", "/repos/{owner}/{repo}/milestones/{number}/labels")] + [ManualRoute("GET", "/repos/{owner}/{repo}/milestones/{milestone_number}/labels")] public Task> GetAllForMilestone(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -176,7 +176,7 @@ namespace Octokit /// /// The Id of the repository /// The number of the milestone - [ManualRoute("GET", "/repositories/{id}/milestones/{number}/labels")] + [ManualRoute("GET", "/repositories/{id}/milestones/{milestone_number}/labels")] public Task> GetAllForMilestone(long repositoryId, int number) { return GetAllForMilestone(repositoryId, number, ApiOptions.None); @@ -192,7 +192,7 @@ namespace Octokit /// The name of the repository /// The number of the milestone /// Options for changing the API response - [ManualRoute("GET", "/repos/{owner}/{repo}/milestones/{number}/labels")] + [ManualRoute("GET", "/repos/{owner}/{repo}/milestones/{milestone_number}/labels")] public Task> GetAllForMilestone(string owner, string name, int number, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -211,7 +211,7 @@ namespace Octokit /// The Id of the repository /// The number of the milestone /// Options for changing the API response - [ManualRoute("GET", "/repositories/{id}/milestones/{number}/labels")] + [ManualRoute("GET", "/repositories/{id}/milestones/{milestone_number}/labels")] public Task> GetAllForMilestone(long repositoryId, int number, ApiOptions options) { Ensure.ArgumentNotNull(options, nameof(options)); @@ -377,7 +377,7 @@ namespace Octokit /// The name of the repository /// The number of the issue /// The names of the labels to add - [ManualRoute("POST", "/repos/{owner}/{repo}/issues/{number}/labels")] + [ManualRoute("POST", "/repos/{owner}/{repo}/issues/{issue_number}/labels")] public Task> AddToIssue(string owner, string name, int number, string[] labels) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -414,7 +414,7 @@ namespace Octokit /// The name of the repository /// The number of the issue /// The name of the label to remove - [ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{number}/labels")] + [ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{issue_number}/labels")] public Task> RemoveFromIssue(string owner, string name, int number, string labelName) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -451,7 +451,7 @@ namespace Octokit /// The name of the repository /// The number of the issue /// The names of the labels to set - [ManualRoute("PUT", "/repos/{owner}/{repo}/issues/{number}/labels")] + [ManualRoute("PUT", "/repos/{owner}/{repo}/issues/{issue_number}/labels")] public Task> ReplaceAllForIssue(string owner, string name, int number, string[] labels) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -487,7 +487,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The number of the issue - [ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{number}/labels")] + [ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{issue_number}/labels")] public Task RemoveAllFromIssue(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); diff --git a/Octokit/Clients/MergingClient.cs b/Octokit/Clients/MergingClient.cs index f96243be..a6f4973c 100644 --- a/Octokit/Clients/MergingClient.cs +++ b/Octokit/Clients/MergingClient.cs @@ -28,7 +28,7 @@ namespace Octokit /// The name of the repository /// The merge to create /// - [ManualRoute("POST", "/repos/{owner}/{name}/merges")] + [ManualRoute("POST", "/repos/{owner}/{repo}/merges")] public Task Create(string owner, string name, NewMerge merge) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); diff --git a/Octokit/Clients/MilestonesClient.cs b/Octokit/Clients/MilestonesClient.cs index 11caef7c..5cf9b350 100644 --- a/Octokit/Clients/MilestonesClient.cs +++ b/Octokit/Clients/MilestonesClient.cs @@ -26,7 +26,7 @@ namespace Octokit /// http://developer.github.com/v3/issues/milestones/#get-a-single-milestone /// /// - [ManualRoute("GET", "/repos/{owner}/{repo}/milestones/{number}")] + [ManualRoute("GET", "/repos/{owner}/{repo}/milestones/{milestone_number}")] public Task Get(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -42,7 +42,7 @@ namespace Octokit /// http://developer.github.com/v3/issues/milestones/#get-a-single-milestone /// /// - [ManualRoute("GET", "/repositories/{id}/milestones/{number}")] + [ManualRoute("GET", "/repositories/{id}/milestones/{milestone_number}")] public Task Get(long repositoryId, int number) { return ApiConnection.Get(ApiUrls.Milestone(repositoryId, number)); @@ -243,7 +243,7 @@ namespace Octokit /// An instance describing the changes to make to the Milestone /// /// - [ManualRoute("PATCH", "/repos/{owner}/{repo}/milestones/{number}")] + [ManualRoute("PATCH", "/repos/{owner}/{repo}/milestones/{milestone_number}")] public Task Update(string owner, string name, int number, MilestoneUpdate milestoneUpdate) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -263,7 +263,7 @@ namespace Octokit /// An instance describing the changes to make to the Milestone /// /// - [ManualRoute("PATCH", "/repositories/{id}/milestones/{number}")] + [ManualRoute("PATCH", "/repositories/{id}/milestones/{milestone_number}")] public Task Update(long repositoryId, int number, MilestoneUpdate milestoneUpdate) { Ensure.ArgumentNotNull(milestoneUpdate, nameof(milestoneUpdate)); @@ -280,7 +280,7 @@ namespace Octokit /// The name of the repository /// The milestone number /// - [ManualRoute("DELETE", "/repos/{owner}/{repo}/milestones/{number}")] + [ManualRoute("DELETE", "/repos/{owner}/{repo}/milestones/{milestone_number}")] public Task Delete(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -297,7 +297,7 @@ namespace Octokit /// The Id of the repository /// The milestone number /// - [ManualRoute("DELETE", "/repositories/{id}/milestones/{number}")] + [ManualRoute("DELETE", "/repositories/{id}/milestones/{milestone_number}")] public Task Delete(long repositoryId, int number) { return ApiConnection.Delete(ApiUrls.Milestone(repositoryId, number)); diff --git a/Octokit/Clients/RepositoryContentsClient.cs b/Octokit/Clients/RepositoryContentsClient.cs index aaf01227..8f8f6bf0 100644 --- a/Octokit/Clients/RepositoryContentsClient.cs +++ b/Octokit/Clients/RepositoryContentsClient.cs @@ -67,7 +67,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - [ManualRoute("GET", "/repos/{owner}/{name}/contents/{path}")] + [ManualRoute("GET", "/repos/{owner}/{repo}/contents/{path}")] public Task> GetAllContents(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -188,7 +188,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Thrown when a general API error occurs. - [ManualRoute("GET", "/repos/{owner}/{name}/readme")] + [ManualRoute("GET", "/repos/{owner}/{repo}/readme")] public async Task GetReadme(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); diff --git a/Octokit/Clients/RepositoryTrafficClient.cs b/Octokit/Clients/RepositoryTrafficClient.cs index f9a7f133..6195ddd0 100644 --- a/Octokit/Clients/RepositoryTrafficClient.cs +++ b/Octokit/Clients/RepositoryTrafficClient.cs @@ -27,7 +27,7 @@ namespace Octokit /// https://developer.github.com/v3/repos/traffic/#list-paths /// The owner of the repository /// The name of the repository - [ManualRoute("GET", "/repositories/{owner}/{repo}/traffic/popular/paths")] + [ManualRoute("GET", "/repos/{owner}/{repo}/traffic/popular/paths")] public Task> GetAllPaths(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -53,7 +53,7 @@ namespace Octokit /// https://developer.github.com/v3/repos/traffic/#list-referrers /// The owner of the repository /// The name of the repository - [ManualRoute("GET", "/repositories/{owner}/{repo}/traffic/popular/referrers")] + [ManualRoute("GET", "/repos/{owner}/{repo}/traffic/popular/referrers")] public Task> GetAllReferrers(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -83,7 +83,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Breakdown per day or week - [ManualRoute("GET", "/repositories/{owner}/{repo}/traffic/clones")] + [ManualRoute("GET", "/repos/{owner}/{repo}/traffic/clones")] public Task GetClones(string owner, string name, RepositoryTrafficRequest per) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner)); @@ -114,7 +114,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Breakdown per day or week - [ManualRoute("GET", "/repositories/{owner}/{repo}/traffic/views")] + [ManualRoute("GET", "/repos/{owner}/{repo}/traffic/views")] public Task GetViews(string owner, string name, RepositoryTrafficRequest per) { Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));