Skip to content

MINOR Add structured Limit objects for rate limiting API, deprecate getRateLimits() #733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

robbieaverill
Copy link
Contributor

@robbieaverill robbieaverill commented Sep 2, 2018

This adds structured link objects for each of the rate limiting resources that is returned from GitHub, including adding GraphQL. The previous methods are still backwards compatible and working, but are now deprecated in favour of the new methods.

@robbieaverill robbieaverill force-pushed the pulls/2.10/improve-rate-limit-api branch from cd6dac7 to d2f55a5 Compare September 2, 2018 11:22
…etRateLimits()

This adds structured link objects for each of the rate limiting resources that
is returned from GitHub, including adding GraphQL. The previous methods are
still backwards compatible and working, but are now deprecated in favour of
the new methods.
@robbieaverill robbieaverill force-pushed the pulls/2.10/improve-rate-limit-api branch from d2f55a5 to bed4454 Compare September 2, 2018 11:23
#### Get GraphQL Rate Limit

```php
$searchLimit = $client->api('rate_limit')->getResource('graphql')->getLimit();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there an resource for graphql included in the rest api result? I can't find it in the docs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, you're right it's not in there - not sure why. It is in the results of the existing API result from using this SDK though.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes indeed I've just checked it with a curl call. So let's keep it in the docs!

@robbieaverill robbieaverill force-pushed the pulls/2.10/improve-rate-limit-api branch from 1637257 to ce8f418 Compare September 5, 2018 19:30
@robbieaverill robbieaverill force-pushed the pulls/2.10/improve-rate-limit-api branch from ce8f418 to 121d814 Compare September 5, 2018 19:32
@acrobat
Copy link
Collaborator

acrobat commented Sep 5, 2018

Thanks @robbieaverill

@acrobat acrobat merged commit 74d6231 into KnpLabs:master Sep 5, 2018
@robbieaverill robbieaverill deleted the pulls/2.10/improve-rate-limit-api branch September 6, 2018 07:25
@robbieaverill
Copy link
Contributor Author

Thanks for reviewing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants