zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-20 06:05:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleared <returns>tags

Browse Source
This commit is contained in:
Alexander Efremov
2016-06-17 05:48:22 +07:00
parent b0654dbcdc
commit a207d2abb1
4 changed files with 84 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
Octokit.Reactive/Clients/IObservableReleasesClient.cs
View File

@@ -21,7 +21,7 @@ namespace Octokit.Reactive
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
IObservable<Release> GetAll(string owner, string name); IObservable<Release> GetAll(string owner, string name);
/// <summary> /// <summary>
@@ -32,7 +32,7 @@ namespace Octokit.Reactive
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
IObservable<Release> GetAll(int repositoryId); IObservable<Release> GetAll(int repositoryId);
/// <summary> /// <summary>
@@ -45,7 +45,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
IObservable<Release> GetAll(string owner, string name, ApiOptions options); IObservable<Release> GetAll(string owner, string name, ApiOptions options);
/// <summary> /// <summary>
@@ -57,7 +57,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
IObservable<Release> GetAll(int repositoryId, ApiOptions options); IObservable<Release> GetAll(int repositoryId, ApiOptions options);
/// <summary> /// <summary>
@@ -70,7 +70,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns> /// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")]
IObservable<Release> Get(string owner, string name, int id); IObservable<Release> Get(string owner, string name, int id);
@@ -83,7 +83,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns> /// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")]
IObservable<Release> Get(int repositoryId, int id); IObservable<Release> Get(int repositoryId, int id);
@@ -96,7 +96,7 @@ namespace Octokit.Reactive
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The latest <see cref="Release"/> specified by the repository</returns> /// <returns></returns>
IObservable<Release> GetLatest(string owner, string name); IObservable<Release> GetLatest(string owner, string name);
/// <summary> /// <summary>
@@ -107,7 +107,7 @@ namespace Octokit.Reactive
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The latest <see cref="Release"/> specified by the repository</returns> /// <returns></returns>
IObservable<Release> GetLatest(int repositoryId); IObservable<Release> GetLatest(int repositoryId);
/// <summary> /// <summary>
@@ -120,7 +120,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="data">A description of the release to create</param> /// <param name="data">A description of the release to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="Release"/>.</returns> /// <returns></returns>
IObservable<Release> Create(string owner, string name, NewRelease data); IObservable<Release> Create(string owner, string name, NewRelease data);
/// <summary> /// <summary>
@@ -132,7 +132,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="data">A description of the release to create</param> /// <param name="data">A description of the release to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="Release"/>.</returns> /// <returns></returns>
IObservable<Release> Create(int repositoryId, NewRelease data); IObservable<Release> Create(int repositoryId, NewRelease data);
/// <summary> /// <summary>
@@ -146,7 +146,7 @@ namespace Octokit.Reactive
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param> /// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns> /// <returns></returns>
IObservable<Release> Edit(string owner, string name, int id, ReleaseUpdate data); IObservable<Release> Edit(string owner, string name, int id, ReleaseUpdate data);
/// <summary> /// <summary>
@@ -159,7 +159,7 @@ namespace Octokit.Reactive
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param> /// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns> /// <returns></returns>
IObservable<Release> Edit(int repositoryId, int id, ReleaseUpdate data); IObservable<Release> Edit(int repositoryId, int id, ReleaseUpdate data);
/// <summary> /// <summary>
@@ -197,7 +197,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
IObservable<ReleaseAsset> GetAllAssets(string owner, string name, int id); IObservable<ReleaseAsset> GetAllAssets(string owner, string name, int id);
/// <summary> /// <summary>
@@ -209,7 +209,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
IObservable<ReleaseAsset> GetAllAssets(int repositoryId, int id); IObservable<ReleaseAsset> GetAllAssets(int repositoryId, int id);
/// <summary> /// <summary>
@@ -223,7 +223,7 @@ namespace Octokit.Reactive
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
IObservable<ReleaseAsset> GetAllAssets(string owner, string name, int id, ApiOptions options); IObservable<ReleaseAsset> GetAllAssets(string owner, string name, int id, ApiOptions options);
/// <summary> /// <summary>
@@ -236,7 +236,7 @@ namespace Octokit.Reactive
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
IObservable<ReleaseAsset> GetAllAssets(int repositoryId, int id, ApiOptions options); IObservable<ReleaseAsset> GetAllAssets(int repositoryId, int id, ApiOptions options);
/// <summary> /// <summary>
@@ -248,7 +248,7 @@ namespace Octokit.Reactive
/// <param name="release">The <see cref="Release"/> to attach the uploaded asset to</param> /// <param name="release">The <see cref="Release"/> to attach the uploaded asset to</param>
/// <param name="data">Description of the asset with its data</param> /// <param name="data">Description of the asset with its data</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
IObservable<ReleaseAsset> UploadAsset(Release release, ReleaseAssetUpload data); IObservable<ReleaseAsset> UploadAsset(Release release, ReleaseAssetUpload data);
/// <summary> /// <summary>
@@ -260,7 +260,7 @@ namespace Octokit.Reactive
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <returns>The <see cref="ReleaseAsset"/> specified by the asset id.</returns> /// <returns></returns>
IObservable<ReleaseAsset> GetAsset(string owner, string name, int assetId); IObservable<ReleaseAsset> GetAsset(string owner, string name, int assetId);
/// <summary> /// <summary>
@@ -271,7 +271,7 @@ namespace Octokit.Reactive
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <returns>The <see cref="ReleaseAsset"/> specified by the asset id.</returns> /// <returns></returns>
IObservable<ReleaseAsset> GetAsset(int repositoryId, int assetId); IObservable<ReleaseAsset> GetAsset(int repositoryId, int assetId);
/// <summary> /// <summary>
@@ -284,7 +284,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <param name="data">Description of the asset with its amended data</param> /// <param name="data">Description of the asset with its amended data</param>
/// <returns>The edited <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
IObservable<ReleaseAsset> EditAsset(string owner, string name, int assetId, ReleaseAssetUpdate data); IObservable<ReleaseAsset> EditAsset(string owner, string name, int assetId, ReleaseAssetUpdate data);
/// <summary> /// <summary>
@@ -296,7 +296,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <param name="data">Description of the asset with its amended data</param> /// <param name="data">Description of the asset with its amended data</param>
/// <returns>The edited <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
IObservable<ReleaseAsset> EditAsset(int repositoryId, int assetId, ReleaseAssetUpdate data); IObservable<ReleaseAsset> EditAsset(int repositoryId, int assetId, ReleaseAssetUpdate data);
/// <summary> /// <summary>

42
Octokit.Reactive/Clients/ObservableReleasesClient.cs
View File

@@ -33,7 +33,7 @@ namespace Octokit.Reactive
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
public IObservable<Release> GetAll(string owner, string name) public IObservable<Release> GetAll(string owner, string name)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -50,7 +50,7 @@ namespace Octokit.Reactive
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
public IObservable<Release> GetAll(int repositoryId) public IObservable<Release> GetAll(int repositoryId)
{ {
return GetAll(repositoryId, ApiOptions.None); return GetAll(repositoryId, ApiOptions.None);
@@ -66,7 +66,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
public IObservable<Release> GetAll(string owner, string name, ApiOptions options) public IObservable<Release> GetAll(string owner, string name, ApiOptions options)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -85,7 +85,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
public IObservable<Release> GetAll(int repositoryId, ApiOptions options) public IObservable<Release> GetAll(int repositoryId, ApiOptions options)
{ {
Ensure.ArgumentNotNull(options, "options"); Ensure.ArgumentNotNull(options, "options");
@@ -103,7 +103,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns> /// <returns></returns>
public IObservable<Release> Get(string owner, string name, int id) public IObservable<Release> Get(string owner, string name, int id)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -121,7 +121,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns> /// <returns></returns>
public IObservable<Release> Get(int repositoryId, int id) public IObservable<Release> Get(int repositoryId, int id)
{ {
return _client.Get(repositoryId, id).ToObservable(); return _client.Get(repositoryId, id).ToObservable();
@@ -136,7 +136,7 @@ namespace Octokit.Reactive
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The latest <see cref="Release"/> specified by the repository</returns> /// <returns></returns>
public IObservable<Release> GetLatest(string owner, string name) public IObservable<Release> GetLatest(string owner, string name)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -153,7 +153,7 @@ namespace Octokit.Reactive
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The latest <see cref="Release"/> specified by the repository</returns> /// <returns></returns>
public IObservable<Release> GetLatest(int repositoryId) public IObservable<Release> GetLatest(int repositoryId)
{ {
return _client.GetLatest(repositoryId).ToObservable(); return _client.GetLatest(repositoryId).ToObservable();
@@ -169,7 +169,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="data">A description of the release to create</param> /// <param name="data">A description of the release to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="Release"/>.</returns> /// <returns></returns>
public IObservable<Release> Create(string owner, string name, NewRelease data) public IObservable<Release> Create(string owner, string name, NewRelease data)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -188,7 +188,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="data">A description of the release to create</param> /// <param name="data">A description of the release to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="Release"/>.</returns> /// <returns></returns>
public IObservable<Release> Create(int repositoryId, NewRelease data) public IObservable<Release> Create(int repositoryId, NewRelease data)
{ {
Ensure.ArgumentNotNull(data, "data"); Ensure.ArgumentNotNull(data, "data");
@@ -207,7 +207,7 @@ namespace Octokit.Reactive
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param> /// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns> /// <returns></returns>
public IObservable<Release> Edit(string owner, string name, int id, ReleaseUpdate data) public IObservable<Release> Edit(string owner, string name, int id, ReleaseUpdate data)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -227,7 +227,7 @@ namespace Octokit.Reactive
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param> /// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns> /// <returns></returns>
public IObservable<Release> Edit(int repositoryId, int id, ReleaseUpdate data) public IObservable<Release> Edit(int repositoryId, int id, ReleaseUpdate data)
{ {
Ensure.ArgumentNotNull(data, "data"); Ensure.ArgumentNotNull(data, "data");
@@ -279,7 +279,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
public IObservable<ReleaseAsset> GetAllAssets(string owner, string name, int id) public IObservable<ReleaseAsset> GetAllAssets(string owner, string name, int id)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -297,7 +297,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
public IObservable<ReleaseAsset> GetAllAssets(int repositoryId, int id) public IObservable<ReleaseAsset> GetAllAssets(int repositoryId, int id)
{ {
return GetAllAssets(repositoryId, id, ApiOptions.None); return GetAllAssets(repositoryId, id, ApiOptions.None);
@@ -314,7 +314,7 @@ namespace Octokit.Reactive
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
public IObservable<ReleaseAsset> GetAllAssets(string owner, string name, int id, ApiOptions options) public IObservable<ReleaseAsset> GetAllAssets(string owner, string name, int id, ApiOptions options)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -334,7 +334,7 @@ namespace Octokit.Reactive
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
public IObservable<ReleaseAsset> GetAllAssets(int repositoryId, int id, ApiOptions options) public IObservable<ReleaseAsset> GetAllAssets(int repositoryId, int id, ApiOptions options)
{ {
Ensure.ArgumentNotNull(options, "options"); Ensure.ArgumentNotNull(options, "options");
@@ -351,7 +351,7 @@ namespace Octokit.Reactive
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <returns>The <see cref="ReleaseAsset"/> specified by the asset id.</returns> /// <returns></returns>
public IObservable<ReleaseAsset> GetAsset(string owner, string name, int assetId) public IObservable<ReleaseAsset> GetAsset(string owner, string name, int assetId)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -369,7 +369,7 @@ namespace Octokit.Reactive
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <returns>The <see cref="ReleaseAsset"/> specified by the asset id.</returns> /// <returns></returns>
public IObservable<ReleaseAsset> GetAsset(int repositoryId, int assetId) public IObservable<ReleaseAsset> GetAsset(int repositoryId, int assetId)
{ {
Ensure.ArgumentNotNull(assetId, "assetId"); Ensure.ArgumentNotNull(assetId, "assetId");
@@ -386,7 +386,7 @@ namespace Octokit.Reactive
/// <param name="release">The <see cref="Release"/> to attach the uploaded asset to</param> /// <param name="release">The <see cref="Release"/> to attach the uploaded asset to</param>
/// <param name="data">Description of the asset with its data</param> /// <param name="data">Description of the asset with its data</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
public IObservable<ReleaseAsset> UploadAsset(Release release, ReleaseAssetUpload data) public IObservable<ReleaseAsset> UploadAsset(Release release, ReleaseAssetUpload data)
{ {
Ensure.ArgumentNotNull(release, "release"); Ensure.ArgumentNotNull(release, "release");
@@ -405,7 +405,7 @@ namespace Octokit.Reactive
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <param name="data">Description of the asset with its amended data</param> /// <param name="data">Description of the asset with its amended data</param>
/// <returns>The edited <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
public IObservable<ReleaseAsset> EditAsset(string owner, string name, int assetId, ReleaseAssetUpdate data) public IObservable<ReleaseAsset> EditAsset(string owner, string name, int assetId, ReleaseAssetUpdate data)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -424,7 +424,7 @@ namespace Octokit.Reactive
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <param name="data">Description of the asset with its amended data</param> /// <param name="data">Description of the asset with its amended data</param>
/// <returns>The edited <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
public IObservable<ReleaseAsset> EditAsset(int repositoryId, int assetId, ReleaseAssetUpdate data) public IObservable<ReleaseAsset> EditAsset(int repositoryId, int assetId, ReleaseAssetUpdate data)
{ {
Ensure.ArgumentNotNull(data, "data"); Ensure.ArgumentNotNull(data, "data");

42
Octokit/Clients/IReleasesClient.cs
View File

@@ -23,7 +23,7 @@ namespace Octokit
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
Task<IReadOnlyList<Release>> GetAll(string owner, string name); Task<IReadOnlyList<Release>> GetAll(string owner, string name);
/// <summary> /// <summary>
@@ -34,7 +34,7 @@ namespace Octokit
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
Task<IReadOnlyList<Release>> GetAll(int repositoryId); Task<IReadOnlyList<Release>> GetAll(int repositoryId);
/// <summary> /// <summary>
@@ -47,7 +47,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
Task<IReadOnlyList<Release>> GetAll(string owner, string name, ApiOptions options); Task<IReadOnlyList<Release>> GetAll(string owner, string name, ApiOptions options);
/// <summary> /// <summary>
@@ -59,7 +59,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
Task<IReadOnlyList<Release>> GetAll(int repositoryId, ApiOptions options); Task<IReadOnlyList<Release>> GetAll(int repositoryId, ApiOptions options);
/// <summary> /// <summary>
@@ -72,7 +72,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns> /// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")]
Task<Release> Get(string owner, string name, int id); Task<Release> Get(string owner, string name, int id);
@@ -85,7 +85,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns> /// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")]
Task<Release> Get(int repositoryId, int id); Task<Release> Get(int repositoryId, int id);
@@ -98,7 +98,7 @@ namespace Octokit
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The latest <see cref="Release"/> specified by the repository</returns> /// <returns></returns>
Task<Release> GetLatest(string owner, string name); Task<Release> GetLatest(string owner, string name);
/// <summary> /// <summary>
@@ -109,7 +109,7 @@ namespace Octokit
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The latest <see cref="Release"/> specified by the repository</returns> /// <returns></returns>
Task<Release> GetLatest(int repositoryId); Task<Release> GetLatest(int repositoryId);
/// <summary> /// <summary>
@@ -122,7 +122,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="data">A description of the release to create</param> /// <param name="data">A description of the release to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="Release"/>.</returns> /// <returns></returns>
Task<Release> Create(string owner, string name, NewRelease data); Task<Release> Create(string owner, string name, NewRelease data);
/// <summary> /// <summary>
@@ -134,7 +134,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="data">A description of the release to create</param> /// <param name="data">A description of the release to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="Release"/>.</returns> /// <returns></returns>
Task<Release> Create(int repositoryId, NewRelease data); Task<Release> Create(int repositoryId, NewRelease data);
/// <summary> /// <summary>
@@ -148,7 +148,7 @@ namespace Octokit
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param> /// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns> /// <returns></returns>
Task<Release> Edit(string owner, string name, int id, ReleaseUpdate data); Task<Release> Edit(string owner, string name, int id, ReleaseUpdate data);
/// <summary> /// <summary>
@@ -161,7 +161,7 @@ namespace Octokit
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param> /// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns> /// <returns></returns>
Task<Release> Edit(int repositoryId, int id, ReleaseUpdate data); Task<Release> Edit(int repositoryId, int id, ReleaseUpdate data);
/// <summary> /// <summary>
@@ -199,7 +199,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(string owner, string name, int id); Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(string owner, string name, int id);
/// <summary> /// <summary>
@@ -211,7 +211,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(int repositoryId, int id); Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(int repositoryId, int id);
/// <summary> /// <summary>
@@ -225,7 +225,7 @@ namespace Octokit
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(string owner, string name, int id, ApiOptions options); Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(string owner, string name, int id, ApiOptions options);
/// <summary> /// <summary>
@@ -238,7 +238,7 @@ namespace Octokit
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(int repositoryId, int id, ApiOptions options); Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(int repositoryId, int id, ApiOptions options);
/// <summary> /// <summary>
@@ -250,7 +250,7 @@ namespace Octokit
/// <param name="release">The <see cref="Release"/> to attach the uploaded asset to</param> /// <param name="release">The <see cref="Release"/> to attach the uploaded asset to</param>
/// <param name="data">Description of the asset with its data</param> /// <param name="data">Description of the asset with its data</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
Task<ReleaseAsset> UploadAsset(Release release, ReleaseAssetUpload data); Task<ReleaseAsset> UploadAsset(Release release, ReleaseAssetUpload data);
/// <summary> /// <summary>
@@ -262,7 +262,7 @@ namespace Octokit
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <returns>The <see cref="ReleaseAsset"/> specified by the asset id.</returns> /// <returns></returns>
Task<ReleaseAsset> GetAsset(string owner, string name, int assetId); Task<ReleaseAsset> GetAsset(string owner, string name, int assetId);
/// <summary> /// <summary>
@@ -273,7 +273,7 @@ namespace Octokit
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <returns>The <see cref="ReleaseAsset"/> specified by the asset id.</returns> /// <returns></returns>
Task<ReleaseAsset> GetAsset(int repositoryId, int assetId); Task<ReleaseAsset> GetAsset(int repositoryId, int assetId);
/// <summary> /// <summary>
@@ -286,7 +286,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <param name="data">Description of the asset with its amended data</param> /// <param name="data">Description of the asset with its amended data</param>
/// <returns>The edited <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
Task<ReleaseAsset> EditAsset(string owner, string name, int assetId, ReleaseAssetUpdate data); Task<ReleaseAsset> EditAsset(string owner, string name, int assetId, ReleaseAssetUpdate data);
/// <summary> /// <summary>
@@ -298,7 +298,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <param name="data">Description of the asset with its amended data</param> /// <param name="data">Description of the asset with its amended data</param>
/// <returns>The edited <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
Task<ReleaseAsset> EditAsset(int repositoryId, int assetId, ReleaseAssetUpdate data); Task<ReleaseAsset> EditAsset(int repositoryId, int assetId, ReleaseAssetUpdate data);
/// <summary> /// <summary>

42
Octokit/Clients/ReleasesClient.cs
View File

@@ -30,7 +30,7 @@ namespace Octokit
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
public Task<IReadOnlyList<Release>> GetAll(string owner, string name) public Task<IReadOnlyList<Release>> GetAll(string owner, string name)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -47,7 +47,7 @@ namespace Octokit
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
public Task<IReadOnlyList<Release>> GetAll(int repositoryId) public Task<IReadOnlyList<Release>> GetAll(int repositoryId)
{ {
return GetAll(repositoryId, ApiOptions.None); return GetAll(repositoryId, ApiOptions.None);
@@ -63,7 +63,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
public Task<IReadOnlyList<Release>> GetAll(string owner, string name, ApiOptions options) public Task<IReadOnlyList<Release>> GetAll(string owner, string name, ApiOptions options)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -83,7 +83,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="Release"/>s for the specified repository.</returns> /// <returns></returns>
public Task<IReadOnlyList<Release>> GetAll(int repositoryId, ApiOptions options) public Task<IReadOnlyList<Release>> GetAll(int repositoryId, ApiOptions options)
{ {
Ensure.ArgumentNotNull(options, "options"); Ensure.ArgumentNotNull(options, "options");
@@ -102,7 +102,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns> /// <returns></returns>
public Task<Release> Get(string owner, string name, int id) public Task<Release> Get(string owner, string name, int id)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -121,7 +121,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The <see cref="Release"/> specified by the id</returns> /// <returns></returns>
public Task<Release> Get(int repositoryId, int id) public Task<Release> Get(int repositoryId, int id)
{ {
var endpoint = ApiUrls.Releases(repositoryId, id); var endpoint = ApiUrls.Releases(repositoryId, id);
@@ -137,7 +137,7 @@ namespace Octokit
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The latest <see cref="Release"/> specified by the repository</returns> /// <returns></returns>
public Task<Release> GetLatest(string owner, string name) public Task<Release> GetLatest(string owner, string name)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -155,7 +155,7 @@ namespace Octokit
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The latest <see cref="Release"/> specified by the repository</returns> /// <returns></returns>
public Task<Release> GetLatest(int repositoryId) public Task<Release> GetLatest(int repositoryId)
{ {
var endpoint = ApiUrls.LatestRelease(repositoryId); var endpoint = ApiUrls.LatestRelease(repositoryId);
@@ -172,7 +172,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="data">A description of the release to create</param> /// <param name="data">A description of the release to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="Release"/>.</returns> /// <returns></returns>
public Task<Release> Create(string owner, string name, NewRelease data) public Task<Release> Create(string owner, string name, NewRelease data)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -192,7 +192,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="data">A description of the release to create</param> /// <param name="data">A description of the release to create</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="Release"/>.</returns> /// <returns></returns>
public Task<Release> Create(int repositoryId, NewRelease data) public Task<Release> Create(int repositoryId, NewRelease data)
{ {
Ensure.ArgumentNotNull(data, "data"); Ensure.ArgumentNotNull(data, "data");
@@ -212,7 +212,7 @@ namespace Octokit
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param> /// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns> /// <returns></returns>
public Task<Release> Edit(string owner, string name, int id, ReleaseUpdate data) public Task<Release> Edit(string owner, string name, int id, ReleaseUpdate data)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -233,7 +233,7 @@ namespace Octokit
/// <param name="id">The id of the release</param> /// <param name="id">The id of the release</param>
/// <param name="data">A description of the release to edit</param> /// <param name="data">A description of the release to edit</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The updated <see cref="Release"/>.</returns> /// <returns></returns>
public Task<Release> Edit(int repositoryId, int id, ReleaseUpdate data) public Task<Release> Edit(int repositoryId, int id, ReleaseUpdate data)
{ {
Ensure.ArgumentNotNull(data, "data"); Ensure.ArgumentNotNull(data, "data");
@@ -288,7 +288,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
public Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(string owner, string name, int id) public Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(string owner, string name, int id)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -306,7 +306,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
public Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(int repositoryId, int id) public Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(int repositoryId, int id)
{ {
return GetAllAssets(repositoryId, id, ApiOptions.None); return GetAllAssets(repositoryId, id, ApiOptions.None);
@@ -323,7 +323,7 @@ namespace Octokit
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
public Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(string owner, string name, int id, ApiOptions options) public Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(string owner, string name, int id, ApiOptions options)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -344,7 +344,7 @@ namespace Octokit
/// <param name="id">The id of the <see cref="Release"/>.</param> /// <param name="id">The id of the <see cref="Release"/>.</param>
/// <param name="options">Options for changing the API response</param> /// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The list of <see cref="ReleaseAsset"/> for the specified release of the specified repository.</returns> /// <returns></returns>
public Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(int repositoryId, int id, ApiOptions options) public Task<IReadOnlyList<ReleaseAsset>> GetAllAssets(int repositoryId, int id, ApiOptions options)
{ {
Ensure.ArgumentNotNull(options, "options"); Ensure.ArgumentNotNull(options, "options");
@@ -362,7 +362,7 @@ namespace Octokit
/// <param name="release">The <see cref="Release"/> to attach the uploaded asset to</param> /// <param name="release">The <see cref="Release"/> to attach the uploaded asset to</param>
/// <param name="data">Description of the asset with its data</param> /// <param name="data">Description of the asset with its data</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception> /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>The created <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
public Task<ReleaseAsset> UploadAsset(Release release, ReleaseAssetUpload data) public Task<ReleaseAsset> UploadAsset(Release release, ReleaseAssetUpload data)
{ {
Ensure.ArgumentNotNull(release, "release"); Ensure.ArgumentNotNull(release, "release");
@@ -396,7 +396,7 @@ namespace Octokit
/// <param name="owner">The repository's owner</param> /// <param name="owner">The repository's owner</param>
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <returns>The <see cref="ReleaseAsset"/> specified by the asset id.</returns> /// <returns></returns>
public Task<ReleaseAsset> GetAsset(string owner, string name, int assetId) public Task<ReleaseAsset> GetAsset(string owner, string name, int assetId)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -414,7 +414,7 @@ namespace Octokit
/// </remarks> /// </remarks>
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <returns>The <see cref="ReleaseAsset"/> specified by the asset id.</returns> /// <returns></returns>
public Task<ReleaseAsset> GetAsset(int repositoryId, int assetId) public Task<ReleaseAsset> GetAsset(int repositoryId, int assetId)
{ {
var endpoint = ApiUrls.Asset(repositoryId, assetId); var endpoint = ApiUrls.Asset(repositoryId, assetId);
@@ -431,7 +431,7 @@ namespace Octokit
/// <param name="name">The repository's name</param> /// <param name="name">The repository's name</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <param name="data">Description of the asset with its amended data</param> /// <param name="data">Description of the asset with its amended data</param>
/// <returns>The edited <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
public Task<ReleaseAsset> EditAsset(string owner, string name, int assetId, ReleaseAssetUpdate data) public Task<ReleaseAsset> EditAsset(string owner, string name, int assetId, ReleaseAssetUpdate data)
{ {
Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -451,7 +451,7 @@ namespace Octokit
/// <param name="repositoryId">The repository's ID</param> /// <param name="repositoryId">The repository's ID</param>
/// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param> /// <param name="assetId">The id of the <see cref="ReleaseAsset"/></param>
/// <param name="data">Description of the asset with its amended data</param> /// <param name="data">Description of the asset with its amended data</param>
/// <returns>The edited <see cref="ReleaseAsset"/>.</returns> /// <returns></returns>
public Task<ReleaseAsset> EditAsset(int repositoryId, int assetId, ReleaseAssetUpdate data) public Task<ReleaseAsset> EditAsset(int repositoryId, int assetId, ReleaseAssetUpdate data)
{ {
Ensure.ArgumentNotNull(data, "data"); Ensure.ArgumentNotNull(data, "data");