mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-06 03:55:55 +00:00
Ryan Gribble
3c818934b8
* Add release notes and bump version to 0.24 * run "build FormatCode" to fix up whitespace/formatting issues * Fix failing Ssh key tests due to "validation exception". This key must be in use on github (under another user, most likely from these tests failing). Changed to a new SSH key and tweaked tests to reduce chance of a key being created and not destroyed * Assignee and Assignees cant both be specified on NewIssue. We missed this one in the PR. Marked Assignee as [Obsolete] and fixed tests to use Assignees * Fix a couple of Reactions tests that were calling the wrong client methods * Fix timeline tests - looks like the response class has changed shape a bit, it now has an Issue object in the payload and Id field isnt present (leaving Id field there in case other timeline events do use it) * Fix some following tests that require the test user to follow more than 1 other user * Unskip these Event tests now because apparently they work! * add breaking changes notes * Update ApiErrorMessageSafe to return null for empty and whitespace strings (#1540) * return null if ApiError.Message is empty or whitespace * Uncomment test, which now passes * update release notes to include PR1540 * Add "Bot" AccountType, was causing a deserialization exception when running the integration test "SearchForExcludedLanguage" (#1541) * Update to include PR1541 * add bullets to make release notes easier to read * markup additional code mentions in notes * Fix grammar fields => field
286 lines
10 KiB
C#
286 lines
10 KiB
C#
using System;
|
||
using System.Collections.Generic;
|
||
using System.Diagnostics.CodeAnalysis;
|
||
using System.Threading.Tasks;
|
||
|
||
namespace Octokit
|
||
{
|
||
/// <summary>
|
||
/// A client for GitHub's Gists API.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// See the <a href="http://developer.github.com/v3/gists/">Gists API documentation</a> for more information.
|
||
/// </remarks>
|
||
public interface IGistsClient
|
||
{
|
||
IGistCommentsClient Comment { get; set; }
|
||
|
||
/// <summary>
|
||
/// Gets a gist
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#get-a-single-gist
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
||
Justification = "Method makes a network request")]
|
||
Task<Gist> Get(string id);
|
||
|
||
/// <summary>
|
||
/// List the authenticated user’s gists or if called anonymously,
|
||
/// this will return all public gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
Task<IReadOnlyList<Gist>> GetAll();
|
||
|
||
/// <summary>
|
||
/// List the authenticated user’s gists or if called anonymously,
|
||
/// this will return all public gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<Gist>> GetAll(ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// List the authenticated user’s gists or if called anonymously,
|
||
/// this will return all public gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="since">Only gists updated at or after this time are returned</param>
|
||
Task<IReadOnlyList<Gist>> GetAll(DateTimeOffset since);
|
||
|
||
/// <summary>
|
||
/// List the authenticated user’s gists or if called anonymously,
|
||
/// this will return all public gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="since">Only gists updated at or after this time are returned</param>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<Gist>> GetAll(DateTimeOffset since, ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// Lists all public gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
Task<IReadOnlyList<Gist>> GetAllPublic();
|
||
|
||
/// <summary>
|
||
/// Lists all public gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<Gist>> GetAllPublic(ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// Lists all public gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="since">Only gists updated at or after this time are returned</param>
|
||
Task<IReadOnlyList<Gist>> GetAllPublic(DateTimeOffset since);
|
||
|
||
/// <summary>
|
||
/// Lists all public gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="since">Only gists updated at or after this time are returned</param>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<Gist>> GetAllPublic(DateTimeOffset since, ApiOptions options);
|
||
|
||
|
||
|
||
/// <summary>
|
||
/// List the authenticated user’s starred gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
Task<IReadOnlyList<Gist>> GetAllStarred();
|
||
|
||
/// <summary>
|
||
/// List the authenticated user’s starred gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<Gist>> GetAllStarred(ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// List the authenticated user’s starred gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="since">Only gists updated at or after this time are returned</param>
|
||
Task<IReadOnlyList<Gist>> GetAllStarred(DateTimeOffset since);
|
||
|
||
/// <summary>
|
||
/// List the authenticated user’s starred gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="since">Only gists updated at or after this time are returned</param>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<Gist>> GetAllStarred(DateTimeOffset since, ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// List a user's gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="user">The user</param>
|
||
Task<IReadOnlyList<Gist>> GetAllForUser(string user);
|
||
|
||
/// <summary>
|
||
/// List a user's gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="user">The user</param>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<Gist>> GetAllForUser(string user, ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// List a user's gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="user">The user</param>
|
||
/// <param name="since">Only gists updated at or after this time are returned</param>
|
||
Task<IReadOnlyList<Gist>> GetAllForUser(string user, DateTimeOffset since);
|
||
|
||
/// <summary>
|
||
/// List a user's gists
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists
|
||
/// </remarks>
|
||
/// <param name="user">The user</param>
|
||
/// <param name="since">Only gists updated at or after this time are returned</param>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<Gist>> GetAllForUser(string user, DateTimeOffset since, ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// List gist commits
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists-commits
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
Task<IReadOnlyList<GistHistory>> GetAllCommits(string id);
|
||
|
||
/// <summary>
|
||
/// List gist commits
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists-commits
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<GistHistory>> GetAllCommits(string id, ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// List gist forks
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists-forks
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
Task<IReadOnlyList<GistFork>> GetAllForks(string id);
|
||
|
||
/// <summary>
|
||
/// List gist forks
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#list-gists-forks
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
Task<IReadOnlyList<GistFork>> GetAllForks(string id, ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// Creates a new gist
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#create-a-gist
|
||
/// </remarks>
|
||
/// <param name="newGist">The new gist to create</param>
|
||
Task<Gist> Create(NewGist newGist);
|
||
|
||
/// <summary>
|
||
/// Creates a fork of a gist
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#fork-a-gist
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist to fork</param>
|
||
Task<Gist> Fork(string id);
|
||
|
||
/// <summary>
|
||
/// Edits a gist
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#delete-a-gist
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
/// <param name="gistUpdate">The update to the gist</param>
|
||
Task<Gist> Edit(string id, GistUpdate gistUpdate);
|
||
|
||
/// <summary>
|
||
/// Deletes a gist
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#delete-a-gist
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
Task Delete(string id);
|
||
|
||
/// <summary>
|
||
/// Stars a gist
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#star-a-gist
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
Task Star(string id);
|
||
|
||
/// <summary>
|
||
/// Unstars a gist
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#unstar-a-gist
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Unstar")]
|
||
Task Unstar(string id);
|
||
|
||
/// <summary>
|
||
/// Checks if the gist is starred
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// http://developer.github.com/v3/gists/#check-if-a-gist-is-starred
|
||
/// </remarks>
|
||
/// <param name="id">The id of the gist</param>
|
||
Task<bool> IsStarred(string id);
|
||
}
|
||
} |