Files
octokit.net/Octokit/Http/ApiInfo.cs
Mickaël Derriey 9c80b00e6f Merge master into dotnetcore (#1599)
* bugfix - PUT should have a payload for Mark as Read (#1579)

* bugfix - PUT should have a payload for Mark as Read

* also fix the Observable client test

* add integration tests for MarkRead methods

* Fixup MarkReadForRepository methods to specify a body in the PUT request

* Fix unit tests for regular and observable client

* helps if the new files are included in the test project :)

* Cloning ApiInfo object should work when some fields are null (#1580)

* Adjust ApiInfo.Clone() to work even if some elements (eg ETag) are null

* Remove c# 6 language feature and do it the old school way

* Add a test for cloning ApiInfo when some fields are null

* The 3 lists can never be null anyway so remove some un-needed statements

* Add test for null RateLimit

* Remove Rx-Main dependency from samples
This resolves #1592 - LINQPad doesn't understand how to restore this unlisted package and it's not actually needed in the samples.

* Adding RemovedFromProject and other missing EventInfoState types. (#1591)

* Adding missing review types to event info.

* Fixing whitespace.

* Reword `BaseRefChanged` comment

* Adding missing event types.

* Change response models 'Url' properties from `Uri` to `string` (#1585)

* Add convention test to ensure 'Url' properties are of type string

Closes #1582

* Change 'Url' properties from Uri to string

Global Find/Replace FTW!

* fix compilation errors in the integration tests project

* Extend 'Url' properties type check to request models

* Stick to convention tests naming convention

* Remove unused using directives in models

Changing from `Uri` to `string` means the `using System;`
directive was not needed anymore in some files

* Update exception message wording

* empty commit to trigger a new build - hopefully Travis passes

* add convention test to ensure request models have Uri 'Url' properties

* make request models 'Url' properties Uri

fix typo in convention test name

* revert some request models 'Url' properties as `string`

see https://github.com/octokit/octokit.net/pull/1585#issuecomment-297186728

* Change test so that all model types must have 'Url' properties of type string

 - Filter test input to only get types which have 'Url' properties
 - Merge response and request model types tests into one
 - Unparameterize the exception since we only check for the string type now

* Fix string.Format tokens

If this PR doesn't get rebased, it'll be my wall of shame FOREVER!

* and then it's even more embarrassing when the commit message says rebased but you really meant squashed

* Remove exclusion of `Release` from request models
2017-05-02 21:55:30 +10:00

68 lines
2.2 KiB
C#

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
namespace Octokit
{
/// <summary>
/// Extra information returned as part of each api response.
/// </summary>
public class ApiInfo
{
public ApiInfo(IDictionary<string, Uri> links,
IList<string> oauthScopes,
IList<string> acceptedOauthScopes,
string etag,
RateLimit rateLimit)
{
Ensure.ArgumentNotNull(links, "links");
Ensure.ArgumentNotNull(oauthScopes, "oauthScopes");
Ensure.ArgumentNotNull(acceptedOauthScopes, "acceptedOauthScopes");
Links = new ReadOnlyDictionary<string, Uri>(links);
OauthScopes = new ReadOnlyCollection<string>(oauthScopes);
AcceptedOauthScopes = new ReadOnlyCollection<string>(acceptedOauthScopes);
Etag = etag;
RateLimit = rateLimit;
}
/// <summary>
/// Oauth scopes that were included in the token used to make the request.
/// </summary>
public IReadOnlyList<string> OauthScopes { get; private set; }
/// <summary>
/// Oauth scopes accepted for this particular call.
/// </summary>
public IReadOnlyList<string> AcceptedOauthScopes { get; private set; }
/// <summary>
/// Etag
/// </summary>
public string Etag { get; private set; }
/// <summary>
/// Links to things like next/previous pages
/// </summary>
public IReadOnlyDictionary<string, Uri> Links { get; private set; }
/// <summary>
/// Information about the API rate limit
/// </summary>
public RateLimit RateLimit { get; private set; }
/// <summary>
/// Allows you to clone ApiInfo
/// </summary>
/// <returns>A clone of <seealso cref="ApiInfo"/></returns>
public ApiInfo Clone()
{
return new ApiInfo(Links.Clone(),
OauthScopes.Clone(),
AcceptedOauthScopes.Clone(),
Etag != null ? new string(Etag.ToCharArray()) : null,
RateLimit != null ? RateLimit.Clone() : null);
}
}
}