diff --git a/Octokit.Reactive/Clients/IObservableAuthorizationsClient.cs b/Octokit.Reactive/Clients/IObservableAuthorizationsClient.cs index 54d27ad1..2283f454 100644 --- a/Octokit.Reactive/Clients/IObservableAuthorizationsClient.cs +++ b/Octokit.Reactive/Clients/IObservableAuthorizationsClient.cs @@ -65,7 +65,7 @@ namespace Octokit.Reactive /// Client ID for the OAuth application that is requesting the token /// The client secret /// Defines the scopes and metadata for the token - /// + /// The two-factor authentication code provided by the user /// Thrown when the user does not have permission to make /// this request. Check /// Thrown when the two-factor code is not diff --git a/Octokit.Reactive/Clients/IObservableCommitStatusClient.cs b/Octokit.Reactive/Clients/IObservableCommitStatusClient.cs index 0ff8beb2..e952d6aa 100644 --- a/Octokit.Reactive/Clients/IObservableCommitStatusClient.cs +++ b/Octokit.Reactive/Clients/IObservableCommitStatusClient.cs @@ -11,7 +11,7 @@ namespace Octokit.Reactive /// Only users with pull access can see this. /// The owner of the repository /// The name of the repository - /// The reference (SHA, branch name, or tag name) to list commits for. + /// The reference (SHA, branch name, or tag name) to list commits for /// IObservable GetAll(string owner, string name, string reference); @@ -20,8 +20,8 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// The reference (SHA, branch name, or tag name) to list commits for. - /// The commit status to create. + /// The reference (SHA, branch name, or tag name) to list commits for + /// The commit status to create /// IObservable Create(string owner, string name, string reference, NewCommitStatus commitStatus); } diff --git a/Octokit.Reactive/Clients/IObservableOrganizationMembersClient.cs b/Octokit.Reactive/Clients/IObservableOrganizationMembersClient.cs index 78a5b7f4..514872ca 100644 --- a/Octokit.Reactive/Clients/IObservableOrganizationMembersClient.cs +++ b/Octokit.Reactive/Clients/IObservableOrganizationMembersClient.cs @@ -23,7 +23,7 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. + /// The login for the organization /// IObservable GetAll(string org); @@ -31,7 +31,7 @@ namespace Octokit.Reactive /// List all users who have publicized their membership of the organization. /// /// http://developer.github.com/v3/orgs/members/#public-members-list - /// The login for the organization. + /// The login for the organization /// IObservable GetPublic(string org); @@ -42,8 +42,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// IObservable CheckMember(string org, string user); @@ -54,8 +54,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// IObservable CheckMemberPublic(string org, string user); @@ -68,8 +68,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// IObservable Delete(string org, string user); @@ -81,8 +81,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// IObservable Publicize(string org, string user); @@ -94,8 +94,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// IObservable Conceal(string org, string user); } diff --git a/Octokit.Reactive/Clients/IObservableOrganizationsClient.cs b/Octokit.Reactive/Clients/IObservableOrganizationsClient.cs index a5ff6e14..afbc7efe 100644 --- a/Octokit.Reactive/Clients/IObservableOrganizationsClient.cs +++ b/Octokit.Reactive/Clients/IObservableOrganizationsClient.cs @@ -30,7 +30,7 @@ namespace Octokit.Reactive /// /// Returns all the organizations for the specified user /// - /// The login for the user. + /// The login for the user /// IObservable GetAll(string user); } diff --git a/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs index 75a084fd..ac6fc2b2 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs @@ -33,8 +33,8 @@ namespace Octokit.Reactive /// /// Retrieves the for the specified owner and name. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// A [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] IObservable Get(string owner, string name); @@ -76,16 +76,16 @@ namespace Octokit.Reactive /// /// Returns the HTML rendered README. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// IObservable GetReadme(string owner, string name); /// /// Returns just the HTML portion of the README without the surrounding HTML document. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// IObservable GetReadmeHtml(string owner, string name); diff --git a/Octokit.Reactive/Clients/IObservableSshKeysClient.cs b/Octokit.Reactive/Clients/IObservableSshKeysClient.cs index c12e4616..72b89ec2 100644 --- a/Octokit.Reactive/Clients/IObservableSshKeysClient.cs +++ b/Octokit.Reactive/Clients/IObservableSshKeysClient.cs @@ -9,7 +9,7 @@ namespace Octokit.Reactive /// /// Retrieves the for the specified id. /// - /// The ID of the SSH key. + /// The ID of the SSH key /// A [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] IObservable Get(int id); @@ -17,7 +17,7 @@ namespace Octokit.Reactive /// /// Retrieves the for the specified id. /// - /// The login of the user. + /// The login of the user /// A of . IObservable GetAll(string user); @@ -33,7 +33,7 @@ namespace Octokit.Reactive /// /// Update the specified . /// - /// + /// The SSH Key contents /// Thrown if the client is not authenticated. /// A IObservable Create(SshKeyUpdate key); @@ -41,8 +41,8 @@ namespace Octokit.Reactive /// /// Update the specified . /// - /// - /// + /// The ID of the SSH key + /// The SSH Key contents /// Thrown if the client is not authenticated. /// A IObservable Update(int id, SshKeyUpdate key); diff --git a/Octokit.Reactive/Clients/IObservableUsersClient.cs b/Octokit.Reactive/Clients/IObservableUsersClient.cs index 2786a6fc..ef319da0 100644 --- a/Octokit.Reactive/Clients/IObservableUsersClient.cs +++ b/Octokit.Reactive/Clients/IObservableUsersClient.cs @@ -23,7 +23,7 @@ namespace Octokit.Reactive /// /// Update the specified . /// - /// The login for the user. + /// The login for the user /// Thrown if the client is not authenticated. /// A IObservable Update(UserUpdate user); diff --git a/Octokit.Reactive/Clients/ObservableAuthorizationsClient.cs b/Octokit.Reactive/Clients/ObservableAuthorizationsClient.cs index 253f80d9..9459be6e 100644 --- a/Octokit.Reactive/Clients/ObservableAuthorizationsClient.cs +++ b/Octokit.Reactive/Clients/ObservableAuthorizationsClient.cs @@ -87,7 +87,7 @@ namespace Octokit.Reactive /// Client ID for the OAuth application that is requesting the token /// The client secret /// Defines the scopes and metadata for the token - /// + /// The two-factor authentication code provided by the user /// Thrown when the user does not have permission to make /// this request. Check /// Thrown when the two-factor code is not diff --git a/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs b/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs index a1d35f14..f2e669e3 100644 --- a/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs +++ b/Octokit.Reactive/Clients/ObservableCommitStatusClient.cs @@ -24,7 +24,7 @@ namespace Octokit.Reactive /// Only users with pull access can see this. /// The owner of the repository /// The name of the repository - /// The reference (SHA, branch name, or tag name) to list commits for. + /// The reference (SHA, branch name, or tag name) to list commits for /// public IObservable GetAll(string owner, string name, string reference) { @@ -36,8 +36,8 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// The reference (SHA, branch name, or tag name) to list commits for. - /// The commit status to create. + /// The reference (SHA, branch name, or tag name) to list commits for + /// The commit status to create /// public IObservable Create(string owner, string name, string reference, NewCommitStatus commitStatus) { diff --git a/Octokit.Reactive/Clients/ObservableOrganizationMembersClient.cs b/Octokit.Reactive/Clients/ObservableOrganizationMembersClient.cs index b448a58a..8fc09701 100644 --- a/Octokit.Reactive/Clients/ObservableOrganizationMembersClient.cs +++ b/Octokit.Reactive/Clients/ObservableOrganizationMembersClient.cs @@ -40,7 +40,7 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. + /// The login for the organization /// public IObservable GetAll(string org) { @@ -53,7 +53,7 @@ namespace Octokit.Reactive /// List all users who have publicized their membership of the organization. /// /// http://developer.github.com/v3/orgs/members/#public-members-list - /// The login for the organization. + /// The login for the organization /// public IObservable GetPublic(string org) { @@ -69,8 +69,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public IObservable CheckMember(string org, string user) { @@ -87,8 +87,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public IObservable CheckMemberPublic(string org, string user) { @@ -107,8 +107,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public IObservable Delete(string org, string user) { @@ -126,8 +126,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public IObservable Publicize(string org, string user) { @@ -145,8 +145,8 @@ namespace Octokit.Reactive /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public IObservable Conceal(string org, string user) { diff --git a/Octokit.Reactive/Clients/ObservableOrganizationsClient.cs b/Octokit.Reactive/Clients/ObservableOrganizationsClient.cs index ff40d801..f5d78b97 100644 --- a/Octokit.Reactive/Clients/ObservableOrganizationsClient.cs +++ b/Octokit.Reactive/Clients/ObservableOrganizationsClient.cs @@ -52,7 +52,7 @@ namespace Octokit.Reactive /// /// Returns all the organizations for the specified user /// - /// The login for the user. + /// The login for the user /// public IObservable GetAll(string user) { diff --git a/Octokit.Reactive/Clients/ObservableSshKeysClient.cs b/Octokit.Reactive/Clients/ObservableSshKeysClient.cs index f94c6612..2d09d92c 100644 --- a/Octokit.Reactive/Clients/ObservableSshKeysClient.cs +++ b/Octokit.Reactive/Clients/ObservableSshKeysClient.cs @@ -8,8 +8,12 @@ namespace Octokit.Reactive public class ObservableSshKeysClient : IObservableSshKeysClient { readonly ISshKeysClient _client; - readonly IConnection _connection; + readonly IConnection _connection; + /// + /// Initializes a new SSH Key API client. + /// + /// An used to make the requests public ObservableSshKeysClient(IGitHubClient client) { Ensure.ArgumentNotNull(client, "client"); @@ -18,11 +22,21 @@ namespace Octokit.Reactive _connection = client.Connection; } + /// + /// Retrieves the for the specified id. + /// + /// The ID of the SSH key + /// A public IObservable Get(int id) { return _client.Get(id).ToObservable(); } + /// + /// Retrieves the for the specified id. + /// + /// The login of the user + /// A of . public IObservable GetAll(string user) { Ensure.ArgumentNotNullOrEmptyString(user, "user"); @@ -30,11 +44,22 @@ namespace Octokit.Reactive return _connection.GetAndFlattenAllPages(ApiUrls.SshKeys(user)); } + /// + /// Retrieves the for the specified id. + /// + /// Thrown if the client is not authenticated. + /// A of . public IObservable GetAllForCurrent() { return _connection.GetAndFlattenAllPages(ApiUrls.SshKeys()); } + /// + /// Update the specified . + /// + /// The SSH Key contents + /// Thrown if the client is not authenticated. + /// A public IObservable Create(SshKeyUpdate key) { Ensure.ArgumentNotNull(key, "key"); @@ -42,6 +67,13 @@ namespace Octokit.Reactive return _client.Create(key).ToObservable(); } + /// + /// Update the specified . + /// + /// The ID of the SSH key + /// The SSH Key contents + /// Thrown if the client is not authenticated. + /// A public IObservable Update(int id, SshKeyUpdate key) { Ensure.ArgumentNotNull(key, "key"); @@ -49,6 +81,12 @@ namespace Octokit.Reactive return _client.Update(id, key).ToObservable(); } + /// + /// Update the specified . + /// + /// The id of the SSH key + /// Thrown if the client is not authenticated. + /// A public IObservable Delete(int id) { return _client.Delete(id).ToObservable(); diff --git a/Octokit/Clients/ApiClient.cs b/Octokit/Clients/ApiClient.cs index 49a5d417..1358c10f 100644 --- a/Octokit/Clients/ApiClient.cs +++ b/Octokit/Clients/ApiClient.cs @@ -8,7 +8,7 @@ /// /// Initializes a new API client. /// - /// The client's connection. + /// The client's connection protected ApiClient(IApiConnection apiConnection) { Ensure.ArgumentNotNull(apiConnection, "apiConnection"); diff --git a/Octokit/Clients/AuthorizationsClient.cs b/Octokit/Clients/AuthorizationsClient.cs index eb80c64d..a991f253 100644 --- a/Octokit/Clients/AuthorizationsClient.cs +++ b/Octokit/Clients/AuthorizationsClient.cs @@ -17,7 +17,7 @@ namespace Octokit /// /// Initializes a new GitHub OAuth API client. /// - /// An API connection. + /// An API connection public AuthorizationsClient(IApiConnection apiConnection) : base(apiConnection) { } @@ -46,7 +46,7 @@ namespace Octokit /// This method requires authentication. /// See the API documentation for more information. /// - /// The ID of the to get. + /// The ID of the to get /// /// Thrown when the current user does not have permission to make this request. /// @@ -66,9 +66,9 @@ namespace Octokit /// This method requires authentication. /// See the API documentation for more information. /// - /// Client ID of the OAuth application for the token. - /// The client secret. - /// Describes the new authorization to create. + /// Client ID of the OAuth application for the token + /// The client secret + /// Describes the new authorization to create /// /// Thrown when the current user does not have permission to make this request. /// @@ -106,10 +106,10 @@ namespace Octokit /// This method requires authentication. /// See the API documentation for more information. /// - /// Client ID of the OAuth application for the token. - /// The client secret. - /// Describes the new authorization to create. - /// The two-factor authentication code in response to the current user's previous challenge. + /// Client ID of the OAuth application for the token + /// The client secret + /// Describes the new authorization to create + /// The two-factor authentication code in response to the current user's previous challenge /// /// Thrown when the current user does not have permission to make this request. /// @@ -159,8 +159,8 @@ namespace Octokit /// See the API /// documentation for more details. /// - /// ID of the to update. - /// Describes the changes to make to the authorization. + /// ID of the to update + /// Describes the changes to make to the authorization /// /// Thrown when the current user does not have permission to make the request. /// @@ -202,7 +202,7 @@ namespace Octokit /// See the API /// documentation for more details. /// - /// The system-wide ID of the authorization to delete. + /// The system-wide ID of the authorization to delete /// /// Thrown when the current user does not have permission to make the request. /// diff --git a/Octokit/Clients/CommitStatusClient.cs b/Octokit/Clients/CommitStatusClient.cs index d743c237..322139a9 100644 --- a/Octokit/Clients/CommitStatusClient.cs +++ b/Octokit/Clients/CommitStatusClient.cs @@ -16,7 +16,7 @@ namespace Octokit /// /// Initializes a new Commit Status API client. /// - /// An API connection. + /// An API connection public CommitStatusClient(IApiConnection apiConnection) : base(apiConnection) { } @@ -28,7 +28,7 @@ namespace Octokit /// Only users with pull access can see this. /// The owner of the repository /// The name of the repository - /// The reference (SHA, branch name, or tag name) to list commits for. + /// The reference (SHA, branch name, or tag name) to list commits for /// public Task> GetAll(string owner, string name, string reference) { @@ -44,8 +44,8 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The reference (SHA, branch name, or tag name) to list commits for. - /// The commit status to create. + /// The reference (SHA, branch name, or tag name) to list commits for + /// The commit status to create /// public Task Create(string owner, string name, string reference, NewCommitStatus commitStatus) { diff --git a/Octokit/Clients/IAuthorizationsClient.cs b/Octokit/Clients/IAuthorizationsClient.cs index 3bc5b39e..9195aa44 100644 --- a/Octokit/Clients/IAuthorizationsClient.cs +++ b/Octokit/Clients/IAuthorizationsClient.cs @@ -37,7 +37,7 @@ namespace Octokit /// This method requires authentication. /// See the API documentation for more information. /// - /// The ID of the to get. + /// The ID of the to get /// /// Thrown when the current user does not have permission to make this request. /// @@ -55,9 +55,9 @@ namespace Octokit /// This method requires authentication. /// See the API documentation for more information. /// - /// Client ID of the OAuth application for the token. - /// The client secret. - /// Describes the new authorization to create. + /// Client ID of the OAuth application for the token + /// The client secret + /// Describes the new authorization to create /// /// Thrown when the current user does not have permission to make this request. /// @@ -79,10 +79,10 @@ namespace Octokit /// This method requires authentication. /// See the API documentation for more information. /// - /// Client ID of the OAuth application for the token. - /// The client secret. - /// Describes the new authorization to create. - /// The two-factor authentication code in response to the current user's previous challenge. + /// Client ID of the OAuth application for the token + /// The client secret + /// Describes the new authorization to create + /// The two-factor authentication code in response to the current user's previous challenge /// /// Thrown when the current user does not have permission to make this request. /// @@ -120,8 +120,8 @@ namespace Octokit /// See the API /// documentation for more details. /// - /// ID of the to update. - /// Describes the changes to make to the authorization. + /// ID of the to update + /// Describes the changes to make to the authorization /// /// Thrown when the current user does not have permission to make the request. /// @@ -137,7 +137,7 @@ namespace Octokit /// See the API /// documentation for more details. /// - /// The system-wide ID of the authorization to delete. + /// The system-wide ID of the authorization to delete /// /// Thrown when the current user does not have permission to make the request. /// diff --git a/Octokit/Clients/ICommitStatusClient.cs b/Octokit/Clients/ICommitStatusClient.cs index 30f15d13..81daf573 100644 --- a/Octokit/Clients/ICommitStatusClient.cs +++ b/Octokit/Clients/ICommitStatusClient.cs @@ -12,7 +12,7 @@ namespace Octokit /// Only users with pull access can see this. /// The owner of the repository /// The name of the repository - /// The reference (SHA, branch name, or tag name) to list commits for. + /// The reference (SHA, branch name, or tag name) to list commits for /// Task> GetAll(string owner, string name, string reference); @@ -21,8 +21,8 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The reference (SHA, branch name, or tag name) to list commits for. - /// The commit status to create. + /// The reference (SHA, branch name, or tag name) to list commits for + /// The commit status to create /// Task Create(string owner, string name, string reference, NewCommitStatus commitStatus); } diff --git a/Octokit/Clients/IMiscellaneousClient.cs b/Octokit/Clients/IMiscellaneousClient.cs index 98cdfa4b..7c08bf4d 100644 --- a/Octokit/Clients/IMiscellaneousClient.cs +++ b/Octokit/Clients/IMiscellaneousClient.cs @@ -26,7 +26,7 @@ namespace Octokit /// /// Gets the rendered Markdown for the specified plain-text Markdown document. /// - /// A plain-text Markdown document. + /// A plain-text Markdown document /// Thrown when a general API error occurs. /// The rendered Markdown. Task RenderRawMarkdown(string markdown); diff --git a/Octokit/Clients/IOrganizationMembersClient.cs b/Octokit/Clients/IOrganizationMembersClient.cs index 60d82812..f763a908 100644 --- a/Octokit/Clients/IOrganizationMembersClient.cs +++ b/Octokit/Clients/IOrganizationMembersClient.cs @@ -23,7 +23,7 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. + /// The login for the organization /// Task> GetAll(string org); @@ -31,7 +31,7 @@ namespace Octokit /// List all users who have publicized their membership of the organization. /// /// http://developer.github.com/v3/orgs/members/#public-members-list - /// The login for the organization. + /// The login for the organization /// Task> GetPublic(string org); @@ -42,8 +42,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// Task CheckMember(string org, string user); @@ -54,8 +54,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// Task CheckMemberPublic(string org, string user); @@ -68,8 +68,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// Task Delete(string org, string user); @@ -81,8 +81,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// Task Publicize(string org, string user); @@ -94,8 +94,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// Task Conceal(string org, string user); } diff --git a/Octokit/Clients/IOrganizationsClient.cs b/Octokit/Clients/IOrganizationsClient.cs index 8f65c0af..917cd7ea 100644 --- a/Octokit/Clients/IOrganizationsClient.cs +++ b/Octokit/Clients/IOrganizationsClient.cs @@ -22,7 +22,7 @@ namespace Octokit /// /// Returns the specified . /// - /// login of the organization to get. + /// login of the organization to get /// Thrown when a general API error occurs. /// The specified . [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get" diff --git a/Octokit/Clients/IReleasesClient.cs b/Octokit/Clients/IReleasesClient.cs index 8e000eec..f3480134 100644 --- a/Octokit/Clients/IReleasesClient.cs +++ b/Octokit/Clients/IReleasesClient.cs @@ -19,8 +19,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The repository's owner. - /// The repository's name. + /// The repository's owner + /// The repository's name /// Thrown when a general API error occurs. /// The list of s for the specified repository. Task> GetAll(string owner, string name); @@ -31,9 +31,9 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The repository's owner. - /// The repository's name. - /// A description of the release to create. + /// The repository's owner + /// The repository's name + /// A description of the release to create /// Thrown when a general API error occurs. /// The created . Task CreateRelease(string owner, string name, ReleaseUpdate data); @@ -44,8 +44,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The to attach the uploaded asset to. - /// Description of the asset with its data. + /// The to attach the uploaded asset to + /// Description of the asset with its data /// Thrown when a general API error occurs. /// The created . Task UploadAsset(Release release, ReleaseAssetUpload data); diff --git a/Octokit/Clients/IRepositoriesClient.cs b/Octokit/Clients/IRepositoriesClient.cs index 0e08da1c..c2fd2910 100644 --- a/Octokit/Clients/IRepositoriesClient.cs +++ b/Octokit/Clients/IRepositoriesClient.cs @@ -20,7 +20,7 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// A instance describing the new repository to create. + /// A instance describing the new repository to create /// Thrown when a general API error occurs. /// A instance for the created repository. Task Create(NewRepository newRepository); @@ -31,8 +31,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// Login of the organization in which to create the repostiory. - /// A instance describing the new repository to create. + /// Login of the organization in which to create the repostiory + /// A instance describing the new repository to create /// Thrown when a general API error occurs. /// A instance for the created repository Task Create(string organizationLogin, NewRepository newRepository); @@ -44,8 +44,8 @@ namespace Octokit /// See the API documentation for more information. /// Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// Thrown when a general API error occurs. Task Delete(string owner, string name); @@ -55,8 +55,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// Thrown when a general API error occurs. /// A [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] @@ -108,8 +108,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// Thrown when a general API error occurs. /// Task GetReadme(string owner, string name); @@ -120,8 +120,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// Thrown when a general API error occurs. /// Task GetReadmeHtml(string owner, string name); diff --git a/Octokit/Clients/ISshKeysClient.cs b/Octokit/Clients/ISshKeysClient.cs index 23026124..a66586f3 100644 --- a/Octokit/Clients/ISshKeysClient.cs +++ b/Octokit/Clients/ISshKeysClient.cs @@ -9,7 +9,7 @@ namespace Octokit /// /// Retrieves the for the specified id. /// - /// The ID of the SSH key. + /// The ID of the SSH key /// A [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")] Task Get(int id); @@ -17,7 +17,7 @@ namespace Octokit /// /// Retrieves the for the specified id. /// - /// The login of the user. + /// The login of the user /// A of . Task> GetAll(string user); @@ -33,7 +33,7 @@ namespace Octokit /// /// Update the specified . /// - /// + /// The SSH Key contents /// Thrown if the client is not authenticated. /// A Task Create(SshKeyUpdate key); @@ -41,8 +41,8 @@ namespace Octokit /// /// Update the specified . /// - /// - /// + /// The ID of the SSH key + /// The SSH Key contents /// Thrown if the client is not authenticated. /// A Task Update(int id, SshKeyUpdate key); diff --git a/Octokit/Clients/IUsersClient.cs b/Octokit/Clients/IUsersClient.cs index 0d8767ec..a42dc2ae 100644 --- a/Octokit/Clients/IUsersClient.cs +++ b/Octokit/Clients/IUsersClient.cs @@ -24,7 +24,7 @@ namespace Octokit /// /// Update the specified . /// - /// The login for the user. + /// The login for the user /// Thrown if the client is not authenticated. /// A Task Update(UserUpdate user); diff --git a/Octokit/Clients/MiscellaneousClient.cs b/Octokit/Clients/MiscellaneousClient.cs index c4c4277b..22dece5a 100644 --- a/Octokit/Clients/MiscellaneousClient.cs +++ b/Octokit/Clients/MiscellaneousClient.cs @@ -21,7 +21,7 @@ namespace Octokit /// /// Initializes a new GitHub miscellaneous API client. /// - /// An API connection. + /// An API connection public MiscellaneousClient(IConnection connection) { Ensure.ArgumentNotNull(connection, "connection"); @@ -46,7 +46,7 @@ namespace Octokit /// /// Gets the rendered Markdown for the specified plain-text Markdown document. /// - /// A plain-text Markdown document. + /// A plain-text Markdown document /// Thrown when a general API error occurs. /// The rendered Markdown. public async Task RenderRawMarkdown(string markdown) diff --git a/Octokit/Clients/OrganizationMembersClient.cs b/Octokit/Clients/OrganizationMembersClient.cs index ba474286..1a0df2e5 100644 --- a/Octokit/Clients/OrganizationMembersClient.cs +++ b/Octokit/Clients/OrganizationMembersClient.cs @@ -9,7 +9,7 @@ namespace Octokit /// /// Initializes a new Organization Members API client. /// - /// An API connection. + /// An API connection public OrganizationMembersClient(IApiConnection apiConnection) : base(apiConnection) { } @@ -32,7 +32,7 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. + /// The login for the organization /// public Task> GetAll(string org) { @@ -45,7 +45,7 @@ namespace Octokit /// List all users who have publicized their membership of the organization. /// /// http://developer.github.com/v3/orgs/members/#public-members-list - /// The login for the organization. + /// The login for the organization /// public Task> GetPublic(string org) { @@ -61,8 +61,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public async Task CheckMember(string org, string user) { @@ -94,8 +94,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public async Task CheckMemberPublic(string org, string user) { @@ -128,8 +128,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public Task Delete(string org, string user) { @@ -147,8 +147,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public async Task Publicize(string org, string user) { @@ -180,8 +180,8 @@ namespace Octokit /// See the API documentation /// for more information. /// - /// The login for the organization. - /// The login for the user. + /// The login for the organization + /// The login for the user /// public Task Conceal(string org, string user) { diff --git a/Octokit/Clients/OrganizationsClient.cs b/Octokit/Clients/OrganizationsClient.cs index 243e115f..4d214b03 100644 --- a/Octokit/Clients/OrganizationsClient.cs +++ b/Octokit/Clients/OrganizationsClient.cs @@ -17,7 +17,7 @@ namespace Octokit /// /// Initializes a new GitHub Orgs API client. /// - /// An API connection. + /// An API connection public OrganizationsClient(IApiConnection apiConnection) : base(apiConnection) { Member = new OrganizationMembersClient(apiConnection); @@ -28,7 +28,7 @@ namespace Octokit /// /// Returns the specified . /// - /// login of the organization to get. + /// login of the organization to get /// Thrown when a general API error occurs. /// The specified . public Task Get(string org) diff --git a/Octokit/Clients/ReleasesClient.cs b/Octokit/Clients/ReleasesClient.cs index 7f4bda68..7ae5994c 100644 --- a/Octokit/Clients/ReleasesClient.cs +++ b/Octokit/Clients/ReleasesClient.cs @@ -16,7 +16,7 @@ namespace Octokit /// /// Initializes a new GitHub Releases API client. /// - /// An API connection. + /// An API connection public ReleasesClient(IApiConnection apiConnection) : base(apiConnection) { } @@ -27,8 +27,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The repository's owner. - /// The repository's name. + /// The repository's owner + /// The repository's name /// Thrown when a general API error occurs. /// The list of s for the specified repository. public Task> GetAll(string owner, string name) @@ -46,9 +46,9 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The repository's owner. - /// The repository's name. - /// A description of the release to create. + /// The repository's owner + /// The repository's name + /// A description of the release to create /// Thrown when a general API error occurs. /// The created . public Task CreateRelease(string owner, string name, ReleaseUpdate data) @@ -67,8 +67,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The to attach the uploaded asset to. - /// Description of the asset with its data. + /// The to attach the uploaded asset to + /// Description of the asset with its data /// Thrown when a general API error occurs. /// The created . public Task UploadAsset(Release release, ReleaseAssetUpload data) diff --git a/Octokit/Clients/RepositoriesClient.cs b/Octokit/Clients/RepositoriesClient.cs index 023651ca..d115e5d3 100644 --- a/Octokit/Clients/RepositoriesClient.cs +++ b/Octokit/Clients/RepositoriesClient.cs @@ -17,7 +17,7 @@ namespace Octokit /// /// Initializes a new GitHub Repos API client. /// - /// An API connection. + /// An API connection public RepositoriesClient(IApiConnection apiConnection) : base(apiConnection) { CommitStatus = new CommitStatusClient(apiConnection); @@ -29,7 +29,7 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// A instance describing the new repository to create. + /// A instance describing the new repository to create /// Thrown when a general API error occurs. /// A instance for the created repository. public Task Create(NewRepository newRepository) @@ -47,8 +47,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// Login of the organization in which to create the repostiory. - /// A instance describing the new repository to create. + /// Login of the organization in which to create the repostiory + /// A instance describing the new repository to create /// Thrown when a general API error occurs. /// A instance for the created repository public Task Create(string organizationLogin, NewRepository newRepository) @@ -68,8 +68,8 @@ namespace Octokit /// See the API documentation for more information. /// Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// Thrown when a general API error occurs. public Task Delete(string owner, string name) { @@ -86,8 +86,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// Thrown when a general API error occurs. /// A public Task Get(string owner, string name) @@ -152,8 +152,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// Thrown when a general API error occurs. /// public async Task GetReadme(string owner, string name) @@ -172,8 +172,8 @@ namespace Octokit /// /// See the API documentation for more information. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// Thrown when a general API error occurs. /// public Task GetReadmeHtml(string owner, string name) diff --git a/Octokit/Clients/SshKeysClient.cs b/Octokit/Clients/SshKeysClient.cs index 4b3c8f89..a89b78b9 100644 --- a/Octokit/Clients/SshKeysClient.cs +++ b/Octokit/Clients/SshKeysClient.cs @@ -8,10 +8,19 @@ namespace Octokit { public class SshKeysClient : ApiClient, ISshKeysClient { + /// + /// Instantiates a new SSH Key Client. + /// + /// The connection used to make requests public SshKeysClient(IApiConnection apiConnection) : base(apiConnection) { } + /// + /// Retrieves the for the specified id. + /// + /// The ID of the SSH key + /// A public Task Get(int id) { var endpoint = "user/keys/{0}".FormatUri(id); @@ -19,6 +28,11 @@ namespace Octokit return ApiConnection.Get(endpoint); } + /// + /// Retrieves the for the specified id. + /// + /// The login of the user + /// A of . public Task> GetAll(string user) { Ensure.ArgumentNotNullOrEmptyString(user, "user"); @@ -26,11 +40,22 @@ namespace Octokit return ApiConnection.GetAll(ApiUrls.SshKeys(user)); } + /// + /// Retrieves the for the specified id. + /// + /// Thrown if the client is not authenticated. + /// A of . public Task> GetAllForCurrent() { return ApiConnection.GetAll(ApiUrls.SshKeys()); } + /// + /// Update the specified . + /// + /// The SSH Key contents + /// Thrown if the client is not authenticated. + /// A public Task Create(SshKeyUpdate key) { Ensure.ArgumentNotNull(key, "key"); @@ -38,6 +63,13 @@ namespace Octokit return ApiConnection.Post(ApiUrls.SshKeys(), key); } + /// + /// Update the specified . + /// + /// The ID of the SSH key + /// The SSH Key contents + /// Thrown if the client is not authenticated. + /// A public Task Update(int id, SshKeyUpdate key) { Ensure.ArgumentNotNull(key, "key"); @@ -46,6 +78,12 @@ namespace Octokit return ApiConnection.Patch(endpoint, key); } + /// + /// Update the specified . + /// + /// The id of the SSH key + /// Thrown if the client is not authenticated. + /// A public Task Delete(int id) { var endpoint = "user/keys/{0}".FormatUri(id); diff --git a/Octokit/Clients/UsersClient.cs b/Octokit/Clients/UsersClient.cs index 00a89a7b..b61870d3 100644 --- a/Octokit/Clients/UsersClient.cs +++ b/Octokit/Clients/UsersClient.cs @@ -46,7 +46,7 @@ namespace Octokit /// /// Update the specified . /// - /// The login for the user. + /// The login for the user /// Thrown if the client is not authenticated. /// A public Task Update(UserUpdate user) diff --git a/Octokit/GitHubClient.cs b/Octokit/GitHubClient.cs index c31bee3b..9bbcd384 100644 --- a/Octokit/GitHubClient.cs +++ b/Octokit/GitHubClient.cs @@ -32,7 +32,7 @@ namespace Octokit /// The name (and optionally version) of the product using this library. This is sent to the server as part of /// the user agent for analytics purposes. /// - /// Provides credentials to the client when making requests. + /// Provides credentials to the client when making requests public GitHubClient(ProductHeaderValue productInformation, ICredentialStore credentialStore) : this(new Connection(productInformation, credentialStore)) { @@ -60,7 +60,7 @@ namespace Octokit /// The name (and optionally version) of the product using this library. This is sent to the server as part of /// the user agent for analytics purposes. /// - /// Provides credentials to the client when making requests. + /// Provides credentials to the client when making requests /// /// The address to point this client to. Typically used for GitHub Enterprise /// instances @@ -72,7 +72,7 @@ namespace Octokit /// /// Create a new instance of the GitHub API v3 client using the specified connection. /// - /// The underlying used to make requests. + /// The underlying used to make requests public GitHubClient(IConnection connection) { Ensure.ArgumentNotNull(connection, "connection"); diff --git a/Octokit/Helpers/ApiUrls.cs b/Octokit/Helpers/ApiUrls.cs index d280186f..4012a7a8 100644 --- a/Octokit/Helpers/ApiUrls.cs +++ b/Octokit/Helpers/ApiUrls.cs @@ -97,8 +97,8 @@ namespace Octokit /// /// Returns the that returns all of the releases for the specified repository. /// - /// The owner of the repository. - /// The name of the repository. + /// The owner of the repository + /// The name of the repository /// public static Uri Releases(string owner, string name) { @@ -370,7 +370,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The reference (SHA, branch name, or tag name) to list commits for. + /// The reference (SHA, branch name, or tag name) to list commits for /// public static Uri CommitStatus(string owner, string name, string reference) { diff --git a/Octokit/Helpers/Ensure.cs b/Octokit/Helpers/Ensure.cs index b43ffb3f..c817dd94 100644 --- a/Octokit/Helpers/Ensure.cs +++ b/Octokit/Helpers/Ensure.cs @@ -10,8 +10,8 @@ namespace Octokit /// /// Checks an argument to ensure it isn't null. /// - /// The argument value to check. - /// The name of the argument. + /// The argument value to check + /// The name of the argument public static void ArgumentNotNull([ValidatedNotNull]object value, string name) { if (value != null) return; @@ -22,8 +22,8 @@ namespace Octokit /// /// Checks a string argument to ensure it isn't null or empty. /// - /// The argument value to check. - /// The name of the argument. + /// The argument value to check + /// The name of the argument public static void ArgumentNotNullOrEmptyString([ValidatedNotNull]string value, string name) { ArgumentNotNull(value, name); diff --git a/Octokit/Http/ApiConnection.cs b/Octokit/Http/ApiConnection.cs index 9f5f0a8f..1703f253 100644 --- a/Octokit/Http/ApiConnection.cs +++ b/Octokit/Http/ApiConnection.cs @@ -16,7 +16,7 @@ namespace Octokit /// /// Initializes a new instance of the class. /// - /// A connection for making HTTP requests. + /// A connection for making HTTP requests public ApiConnection(IConnection connection) : this(connection, new ApiPagination()) { } @@ -24,8 +24,8 @@ namespace Octokit /// /// Initializes a new instance of the class. /// - /// A connection for making HTTP requests. - /// A paginator for paging API responses. + /// A connection for making HTTP requests + /// A paginator for paging API responses protected ApiConnection(IConnection connection, IApiPagination pagination) { Ensure.ArgumentNotNull(connection, "connection"); @@ -44,8 +44,8 @@ namespace Octokit /// Gets the API resource at the specified URI. /// /// Type of the API resource to get. - /// URI of the API resource to get. - /// Parameters to add to the API request. + /// URI of the API resource to get + /// Parameters to add to the API request /// The API resource. /// Thrown when an API error occurs. public async Task Get(Uri uri, IDictionary parameters) @@ -59,8 +59,8 @@ namespace Octokit /// /// Gets the HTML content of the API resource at the specified URI. /// - /// URI of the API resource to get. - /// Parameters to add to the API request. + /// URI of the API resource to get + /// Parameters to add to the API request /// The API resource's HTML content. /// Thrown when an API error occurs. public async Task GetHtml(Uri uri, IDictionary parameters) @@ -75,7 +75,7 @@ namespace Octokit /// Gets all API resources in the list at the specified URI. /// /// Type of the API resource in the list. - /// URI of the API resource to get. + /// URI of the API resource to get /// of the The API resources in the list. /// Thrown when an API error occurs. public Task> GetAll(Uri uri) @@ -87,8 +87,8 @@ namespace Octokit /// Gets all API resources in the list at the specified URI. /// /// Type of the API resource in the list. - /// URI of the API resource to get. - /// Parameters to add to the API request. + /// URI of the API resource to get + /// Parameters to add to the API request /// of the The API resources in the list. /// Thrown when an API error occurs. public Task> GetAll(Uri uri, IDictionary parameters) @@ -100,9 +100,9 @@ namespace Octokit /// Gets all API resources in the list at the specified URI. /// /// Type of the API resource in the list. - /// URI of the API resource to get. - /// Parameters to add to the API request. - /// Accept header to use for the API request. + /// URI of the API resource to get + /// Parameters to add to the API request + /// Accept header to use for the API request /// of the The API resources in the list. /// Thrown when an API error occurs. public Task> GetAll(Uri uri, IDictionary parameters, string accepts) @@ -117,8 +117,8 @@ namespace Octokit /// Creates a new API resource in the list at the specified URI. /// /// The API resource's type. - /// URI of the API resource to get. - /// Object that describes the new API resource; this will be serialized and used as the request's body. + /// URI of the API resource to get + /// Object that describes the new API resource; this will be serialized and used as the request's body /// The created API resource. /// Thrown when an API error occurs. public Task Post(Uri uri, object data) @@ -133,9 +133,9 @@ namespace Octokit /// Creates a new API resource in the list at the specified URI. /// /// The API resource's type. - /// URI of the API resource to get. - /// Object that describes the new API resource; this will be serialized and used as the request's body. - /// Accept header to use for the API request. + /// URI of the API resource to get + /// Object that describes the new API resource; this will be serialized and used as the request's body + /// Accept header to use for the API request /// The created API resource. /// Thrown when an API error occurs. public Task Post(Uri uri, object data, string accepts) @@ -147,10 +147,10 @@ namespace Octokit /// Creates a new API resource in the list at the specified URI. /// /// The API resource's type. - /// URI of the API resource to get. - /// Object that describes the new API resource; this will be serialized and used as the request's body. - /// Accept header to use for the API request. - /// Content type of the API request. + /// URI of the API resource to get + /// Object that describes the new API resource; this will be serialized and used as the request's body + /// Accept header to use for the API request + /// Content type of the API request /// The created API resource. /// Thrown when an API error occurs. public async Task Post(Uri uri, object data, string accepts, string contentType) @@ -170,8 +170,8 @@ namespace Octokit /// Creates or replaces the API resource at the specified URI. /// /// The API resource's type. - /// URI of the API resource to create or replace. - /// Object that describes the API resource; this will be serialized and used as the request's body. + /// URI of the API resource to create or replace + /// Object that describes the API resource; this will be serialized and used as the request's body /// The created API resource. /// Thrown when an API error occurs. public async Task Put(Uri uri, object data) @@ -188,9 +188,9 @@ namespace Octokit /// Creates or replaces the API resource at the specified URI. /// /// The API resource's type. - /// URI of the API resource to create or replace. - /// Object that describes the API resource; this will be serialized and used as the request's body. - /// The two-factor authentication code in response to the current user's previous challenge. + /// URI of the API resource to create or replace + /// Object that describes the API resource; this will be serialized and used as the request's body + /// The two-factor authentication code in response to the current user's previous challenge /// The created API resource. /// Thrown when an API error occurs. public async Task Put(Uri uri, object data, string twoFactorAuthenticationCode) @@ -208,8 +208,8 @@ namespace Octokit /// Updates the API resource at the specified URI. /// /// The API resource's type. - /// URI of the API resource to update. - /// /// Object that describes the API resource; this will be serialized and used as the request's body. + /// URI of the API resource to update + /// /// Object that describes the API resource; this will be serialized and used as the request's body /// The updated API resource. /// Thrown when an API error occurs. public async Task Patch(Uri uri, object data) @@ -225,7 +225,7 @@ namespace Octokit /// /// Deletes the API object at the specified URI. /// - /// URI of the API resource to delete. + /// URI of the API resource to delete /// A for the request's execution. public Task Delete(Uri uri) { diff --git a/Octokit/Http/Connection.cs b/Octokit/Http/Connection.cs index 36fcb14a..61d92378 100644 --- a/Octokit/Http/Connection.cs +++ b/Octokit/Http/Connection.cs @@ -42,7 +42,7 @@ namespace Octokit /// /// /// The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise - /// instance. + /// instance public Connection(ProductHeaderValue productInformation, Uri baseAddress) : this(productInformation, baseAddress, _anonymousCredentials) { @@ -55,7 +55,7 @@ namespace Octokit /// The name (and optionally version) of the product using this library. This is sent to the server as part of /// the user agent for analytics purposes. /// - /// Provides credentials to the client when making requests. + /// Provides credentials to the client when making requests public Connection(ProductHeaderValue productInformation, ICredentialStore credentialStore) : this(productInformation, _defaultGitHubApiUrl, credentialStore) { @@ -70,8 +70,8 @@ namespace Octokit /// /// /// The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise - /// instance. - /// Provides credentials to the client when making requests. + /// instance + /// Provides credentials to the client when making requests public Connection(ProductHeaderValue productInformation, Uri baseAddress, ICredentialStore credentialStore) : this(productInformation, baseAddress, credentialStore, new HttpClientAdapter(), new SimpleJsonSerializer()) { @@ -86,10 +86,10 @@ namespace Octokit /// /// /// The address to point this client to such as https://api.github.com or the URL to a GitHub Enterprise - /// instance. - /// Provides credentials to the client when making requests. - /// A raw used to make requests. - /// Class used to serialize and deserialize JSON requests. + /// instance + /// Provides credentials to the client when making requests + /// A raw used to make requests + /// Class used to serialize and deserialize JSON requests public Connection( ProductHeaderValue productInformation, Uri baseAddress, diff --git a/Octokit/Http/IApiConnection.cs b/Octokit/Http/IApiConnection.cs index 3c6ef682..1c73d21d 100644 --- a/Octokit/Http/IApiConnection.cs +++ b/Octokit/Http/IApiConnection.cs @@ -20,8 +20,8 @@ namespace Octokit /// Gets the API resource at the specified URI. /// /// Type of the API resource to get. - /// URI of the API resource to get. - /// Parameters to add to the API request. + /// URI of the API resource to get + /// Parameters to add to the API request /// The API resource. /// Thrown when an API error occurs. [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", @@ -31,8 +31,8 @@ namespace Octokit /// /// Gets the HTML content of the API resource at the specified URI. /// - /// URI of the API resource to get. - /// Parameters to add to the API request. + /// URI of the API resource to get + /// Parameters to add to the API request /// The API resource's HTML content. /// Thrown when an API error occurs. Task GetHtml(Uri uri, IDictionary parameters); @@ -41,7 +41,7 @@ namespace Octokit /// Gets all API resources in the list at the specified URI. /// /// Type of the API resource in the list. - /// URI of the API resource to get. + /// URI of the API resource to get /// of the The API resources in the list. /// Thrown when an API error occurs. Task> GetAll(Uri uri); @@ -50,8 +50,8 @@ namespace Octokit /// Gets all API resources in the list at the specified URI. /// /// Type of the API resource in the list. - /// URI of the API resource to get. - /// Parameters to add to the API request. + /// URI of the API resource to get + /// Parameters to add to the API request /// of the The API resources in the list. /// Thrown when an API error occurs. Task> GetAll(Uri uri, IDictionary parameters); @@ -60,9 +60,9 @@ namespace Octokit /// Gets all API resources in the list at the specified URI. /// /// Type of the API resource in the list. - /// URI of the API resource to get. - /// Parameters to add to the API request. - /// Accept header to use for the API request. + /// URI of the API resource to get + /// Parameters to add to the API request + /// Accept header to use for the API request /// of the The API resources in the list. /// Thrown when an API error occurs. Task> GetAll(Uri uri, IDictionary parameters, string accepts); @@ -71,8 +71,8 @@ namespace Octokit /// Creates a new API resource in the list at the specified URI. /// /// The API resource's type. - /// URI of the API resource to get. - /// Object that describes the new API resource; this will be serialized and used as the request's body. + /// URI of the API resource to get + /// Object that describes the new API resource; this will be serialized and used as the request's body /// The created API resource. /// Thrown when an API error occurs. Task Post(Uri uri, object data); @@ -81,9 +81,9 @@ namespace Octokit /// Creates a new API resource in the list at the specified URI. /// /// The API resource's type. - /// URI of the API resource to get. - /// Object that describes the new API resource; this will be serialized and used as the request's body. - /// Accept header to use for the API request. + /// URI of the API resource to get + /// Object that describes the new API resource; this will be serialized and used as the request's body + /// Accept header to use for the API request /// The created API resource. /// Thrown when an API error occurs. Task Post(Uri uri, object data, string accepts); @@ -92,10 +92,10 @@ namespace Octokit /// Creates a new API resource in the list at the specified URI. /// /// The API resource's type. - /// URI of the API resource to get. - /// Object that describes the new API resource; this will be serialized and used as the request's body. - /// Accept header to use for the API request. - /// Content type of the API request. + /// URI of the API resource to get + /// Object that describes the new API resource; this will be serialized and used as the request's body + /// Accept header to use for the API request + /// Content type of the API request /// The created API resource. /// Thrown when an API error occurs. Task Post(Uri uri, object data, string accepts, string contentType); @@ -104,8 +104,8 @@ namespace Octokit /// Creates or replaces the API resource at the specified URI. /// /// The API resource's type. - /// URI of the API resource to create or replace. - /// Object that describes the API resource; this will be serialized and used as the request's body. + /// URI of the API resource to create or replace + /// Object that describes the API resource; this will be serialized and used as the request's body /// The created API resource. /// Thrown when an API error occurs. Task Put(Uri uri, object data); @@ -114,9 +114,9 @@ namespace Octokit /// Creates or replaces the API resource at the specified URI. /// /// The API resource's type. - /// URI of the API resource to create or replace. - /// Object that describes the API resource; this will be serialized and used as the request's body. - /// The two-factor authentication code in response to the current user's previous challenge. + /// URI of the API resource to create or replace + /// Object that describes the API resource; this will be serialized and used as the request's body + /// The two-factor authentication code in response to the current user's previous challenge /// The created API resource. /// Thrown when an API error occurs. Task Put(Uri uri, object data, string twoFactorAuthenticationCode); @@ -125,8 +125,8 @@ namespace Octokit /// Updates the API resource at the specified URI. /// /// The API resource's type. - /// URI of the API resource to update. - /// /// Object that describes the API resource; this will be serialized and used as the request's body. + /// URI of the API resource to update + /// /// Object that describes the API resource; this will be serialized and used as the request's body /// The updated API resource. /// Thrown when an API error occurs. Task Patch(Uri uri, object data); @@ -134,7 +134,7 @@ namespace Octokit /// /// Deletes the API object at the specified URI. /// - /// URI of the API resource to delete. + /// URI of the API resource to delete /// A for the request's execution. Task Delete(Uri uri); } diff --git a/Octokit/Http/IHttpClient.cs b/Octokit/Http/IHttpClient.cs index e203d1c3..75c87a0c 100644 --- a/Octokit/Http/IHttpClient.cs +++ b/Octokit/Http/IHttpClient.cs @@ -14,7 +14,7 @@ namespace Octokit.Internal /// Sends the specified request and returns a response. /// /// The type of data to send - /// A that represents the HTTP request. + /// A that represents the HTTP request /// A Task> Send(IRequest request); }