diff --git a/Octokit/Clients/IRepositoryContentsClient.cs b/Octokit/Clients/IRepositoryContentsClient.cs
index e02cd6893f..7b4d65c101 100644
--- a/Octokit/Clients/IRepositoryContentsClient.cs
+++ b/Octokit/Clients/IRepositoryContentsClient.cs
@@ -150,11 +150,21 @@ public interface IRepositoryContentsClient
Task DeleteFile(string owner, string name, string path, DeleteFileRequest request);
}
+ ///
+ /// Supported archive formats for use when downloading repository snapshots
+ ///
public enum ArchiveFormat
{
+ ///
+ /// A tar archive
+ ///
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Tarball")]
[Parameter(Value = "tarball")]
Tarball,
+
+ ///
+ /// A zip archive
+ ///
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Zipball")]
[Parameter(Value = "zipball")]
Zipball
diff --git a/Octokit/Http/IRequest.cs b/Octokit/Http/IRequest.cs
index 31fbc578fb..09b57e9142 100644
--- a/Octokit/Http/IRequest.cs
+++ b/Octokit/Http/IRequest.cs
@@ -4,16 +4,51 @@
namespace Octokit.Internal
{
+ ///
+ /// Abstraction for creating HTTP requests
+ ///
public interface IRequest
{
+ ///
+ /// The request payload to send
+ ///
object Body { get; set; }
+
+ ///
+ /// Headers to send with the request
+ ///
Dictionary Headers { get; }
+
+ ///
+ /// The method to perform as part of the request
+ ///
HttpMethod Method { get; }
+
+ ///
+ /// Additional parameters to use in the query string
+ ///
Dictionary Parameters { get; }
+
+ ///
+ /// The base address for the request
+ ///
Uri BaseAddress { get; }
+
+ ///
+ /// The resource to query as part of the request
+ ///
Uri Endpoint { get; }
+
+ ///
+ /// Expire the request after a given time span
+ ///
TimeSpan Timeout { get; }
+
+ ///
+ /// The type of content being sent with the request
+ ///
string ContentType { get; }
+
[Obsolete("This value is no longer respected due to the necessary redirect work")]
bool AllowAutoRedirect { get; }
}
diff --git a/Octokit/Http/Request.cs b/Octokit/Http/Request.cs
index f9300fd49b..fa64a4b299 100644
--- a/Octokit/Http/Request.cs
+++ b/Octokit/Http/Request.cs
@@ -4,6 +4,9 @@
namespace Octokit.Internal
{
+ ///
+ /// Abstraction for creating HTTP requests
+ ///
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1724:TypeNamesShouldNotMatchNamespaces")]
public class Request : IRequest
{
@@ -14,13 +17,44 @@ public Request()
Timeout = TimeSpan.FromSeconds(100);
}
+ ///
+ /// The request payload to send
+ ///
public object Body { get; set; }
+
+ ///
+ /// Headers to send with the request
+ ///
public Dictionary Headers { get; private set; }
+
+ ///
+ /// The method to perform as part of the request
+ ///
public HttpMethod Method { get; set; }
+
+ ///
+ /// Additional parameters to use in the query string
+ ///
public Dictionary Parameters { get; private set; }
+
+ ///
+ /// The base address for the request
+ ///
public Uri BaseAddress { get; set; }
+
+ ///
+ /// The resource to query as part of the request
+ ///
public Uri Endpoint { get; set; }
+
+ ///
+ /// Expire the request after a given time span
+ ///
public TimeSpan Timeout { get; set; }
+
+ ///
+ /// The type of content being sent with the request
+ ///
public string ContentType { get; set; }
[Obsolete("This value is no longer respected due to the necessary redirect work")]