Skip to content
This repository has been archived by the owner on Nov 1, 2017. It is now read-only.

Commit

Permalink
updating a bunch of links to the developer site to be https
Browse files Browse the repository at this point in the history
  • Loading branch information
konklone committed Apr 6, 2014
1 parent 54dcedd commit f647be1
Show file tree
Hide file tree
Showing 14 changed files with 38 additions and 38 deletions.
2 changes: 1 addition & 1 deletion .rbenv-version
@@ -1 +1 @@
1.9.3
1.9.3-p448
4 changes: 2 additions & 2 deletions content/guides/getting-started.md
Expand Up @@ -131,7 +131,7 @@ X-GitHub-OTP: required; :2fa-type

{
"message": "Must specify two-factor authentication OTP code.",
"documentation_url": "http://developer.github.com/v3/auth#working-with-two-factor-authentication"
"documentation_url": "https://developer.github.com/v3/auth#working-with-two-factor-authentication"
}
</pre>

Expand Down Expand Up @@ -211,7 +211,7 @@ Content-Length: 384
"updated_at": "2012-11-14T14:04:24Z",
"url": "https://api.github.com/authorizations/2",
"app": {
"url": "http://developer.github.com/v3/oauth/#oauth-authorizations-api",
"url": "https://developer.github.com/v3/oauth/#oauth-authorizations-api",
"name": "GitHub API"
},
"created_at": "2012-11-14T14:04:24Z",
Expand Down
2 changes: 1 addition & 1 deletion content/guides/rendering-data-as-graphs.md
Expand Up @@ -353,7 +353,7 @@ arguments to `drawTreemap` above, to get all the information to show up properly
[Octokit]: https://github.com/pengwynn/octokit
[D3 mortals]: http://www.recursion.org/d3-for-mere-mortals/
[D3 treemap]: http://bl.ocks.org/mbostock/4063582
[language API]: http://developer.github.com/v3/repos/#list-languages
[language API]: https://developer.github.com/v3/repos/#list-languages
[simple tree map]: http://2kittymafiasoftware.blogspot.com/2011/09/simple-treemap-visualization-with-d3.html
[platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/rendering-data-as-graphs
[new oauth application]: https://github.com/settings/applications/new
26 changes: 13 additions & 13 deletions content/guides/traversing-with-pagination.md
Expand Up @@ -12,20 +12,20 @@ Most of the time, you might even find that you're asking for _too much_ informat
and in order to keep our servers happy, the API will automatically [paginate the requested items][pagination].

In this guide, we'll make some calls to the GitHub Search API, and iterate over
the results using pagination. You can find the complete source code for this project
in the [platform-samples][platform samples] repository.
the results using pagination. You can find the complete source code for this project
in the [platform-samples][platform samples] repository.

## Basics of Pagination

To start with, it's important to know a few facts about receiving paginated items:

1. Different API calls respond with different defaults. For example, a call to
[list GitHub's public repositories](http://developer.github.com/v3/repos/#list-all-public-repositories)
[list GitHub's public repositories](https://developer.github.com/v3/repos/#list-all-public-repositories)
provides paginated items in sets of 30, whereas a call to the GitHub Search API
provides items in sets of 100
2. You can specify how many items to receive (up to a maximum of 100); but,
3. For technical reasons, not every endpoint behaves the same. For example,
[events](http://developer.github.com/v3/activity/events/) won't let you set a maximum for items to receive.
3. For technical reasons, not every endpoint behaves the same. For example,
[events](https://developer.github.com/v3/activity/events/) won't let you set a maximum for items to receive.
Be sure to read the documentation on how to handle paginated results for specific endpoints.

Information about pagination is provided in [the Link header](http://tools.ietf.org/html/rfc5988)
Expand All @@ -50,7 +50,7 @@ Nice!
Keep in mind that you should **always** rely on these link relations provided
to you. Don't try to guess or construct your own URL. Some API calls, like [listing
commits on a repository][listing commits], use pagination results that are based
on SHA values, not numbers.
on SHA values, not numbers.

### Navigating through the pages

Expand Down Expand Up @@ -106,7 +106,7 @@ pass in our [personal access token][personal token]:
# Instead, set and test environment variables, like below
client = Octokit::Client.new :access_token => ENV['MY_PERSONAL_TOKEN']

Next, we'll execute the search, using Octokit's `search_code` method. Unlike
Next, we'll execute the search, using Octokit's `search_code` method. Unlike
using `curl`, we can also immediately retrieve the number of results, so let's
do that:

Expand All @@ -133,7 +133,7 @@ this information to the user:
puts "There are #{total_count} results, on #{number_of_pages} pages!"

Finally, let's iterate through the results. You could do this with a loop `for i in 1..number_of_pages.to_i`,
but instead, let's follow the `rels[:next]` headers to retrieve information from
but instead, let's follow the `rels[:next]` headers to retrieve information from
each page. For the sake of simplicity, let's just grab the file path of the first
result from each page. To do this, we'll need a loop; and at the end of every loop,
we'll retrieve the data set for the next page by following the `rels[:next]` information.
Expand Down Expand Up @@ -179,14 +179,14 @@ your code should remain intact:

## Constructing Pagination Links

Normally, with pagination, your goal isn't to concatenate all of the possible
Normally, with pagination, your goal isn't to concatenate all of the possible
results, but rather, to produce a set of navigation, like this:

![Sample of pagination links](/images/pagination_sample.png)

Let's sketch out a micro-version of what that might entail.

From the code above, we already know we can get the `number_of_pages` in the
From the code above, we already know we can get the `number_of_pages` in the
paginated results from the first call:

#!ruby
Expand Down Expand Up @@ -230,13 +230,13 @@ individual page, by passing the `:page` option:
#!ruby
clicked_results = client.search_code('addClass user:mozilla', :page => random_page)

If we wanted to get fancy, we could also grab the previous and next pages, in
If we wanted to get fancy, we could also grab the previous and next pages, in
order to generate links for back (`<<`) and foward (`>>`) elements:

#!ruby
prev_page_href = client.last_response.rels[:prev] ? client.last_response.rels[:prev].href : "(none)"
next_page_href = client.last_response.rels[:next] ? client.last_response.rels[:next].href : "(none)"

puts "The prev page link is #{prev_page_href}"
puts "The next page link is #{next_page_href}"

Expand All @@ -245,4 +245,4 @@ order to generate links for back (`<<`) and foward (`>>`) elements:
[octokit.rb]: https://github.com/octokit/octokit.rb
[personal token]: https://help.github.com/articles/creating-an-access-token-for-command-line-use
[hypermedia-relations]: https://github.com/octokit/octokit.rb#pagination
[listing commits]: http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
[listing commits]: https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
6 changes: 3 additions & 3 deletions content/guides/working-with-comments.md
Expand Up @@ -111,8 +111,8 @@ on the entire commit.
[commit comment]: https://github.com/octocat/Spoon-Knife/commit/cbc28e7c8caee26febc8c013b0adfb97a4edd96e#commitcomment-4049848
[sample PR]: https://github.com/octocat/Spoon-Knife/pull/1176
[platform-samples]: https://github.com/github/platform-samples/tree/master/api/ruby/working-with-comments
[issues]: http://developer.github.com/v3/issues/comments/
[issues]: https://developer.github.com/v3/issues/comments/
[personal token]: https://help.github.com/articles/creating-an-access-token-for-command-line-use
[octokit.rb]: https://github.com/octokit/octokit.rb
[PR Review API]: http://developer.github.com/v3/pulls/comments/
[commit comment API]: http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
[PR Review API]: https://developer.github.com/v3/pulls/comments/
[commit comment API]: https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
10 changes: 5 additions & 5 deletions content/v3.md
Expand Up @@ -237,7 +237,7 @@ HTTP/1.1 401 Unauthorized

{
"message": "Bad credentials",
"documentation_url": "http://developer.github.com/v3"
"documentation_url": "https://developer.github.com/v3"
}
</pre>

Expand All @@ -252,7 +252,7 @@ HTTP/1.1 403 Forbidden

{
"message": "Maximum number of login attempts exceeded. Please try again later.",
"documentation_url": "http://developer.github.com/v3"
"documentation_url": "https://developer.github.com/v3"
}
</pre>

Expand Down Expand Up @@ -286,7 +286,7 @@ Requests that return multiple items will be paginated to 30 items by
default. You can specify further pages with the `?page` parameter. For some
resources, you can also set a custom page size up to 100 with the `?per_page` parameter.
Note that for technical reasons not all endpoints respect the `?per_page` parameter,
see [events](http://developer.github.com/v3/activity/events/) for example.
see [events](https://developer.github.com/v3/activity/events/) for example.

<pre class="terminal">
$ curl 'https://api.github.com/user/repos?page=2&per_page=100'
Expand Down Expand Up @@ -367,7 +367,7 @@ X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1377013266

{
"message": "API rate limit exceeded. See http://developer.github.com/v3/#rate-limiting for details."
"message": "API rate limit exceeded. See https://developer.github.com/v3/#rate-limiting for details."
}
</pre>

Expand Down Expand Up @@ -583,7 +583,7 @@ For API calls that allow for a timestamp to be specified, we use that exact
timestamp. An example of this is the [Commits API](/v3/git/commits).

These timestamps look something like `2014-02-27T15:05:06+01:00`. Also see
[this example](http://developer.github.com/v3/git/commits/#example-input) for
[this example](https://developer.github.com/v3/git/commits/#example-input) for
how these timestamps can be specified.

#### Using the `Time-Zone` header
Expand Down
2 changes: 1 addition & 1 deletion content/v3/activity/events.md
Expand Up @@ -47,7 +47,7 @@ All Events have the same response format:
## List issue events for a repository

Repository issue events have a different format than other events,
as documented in the [Issue Events API](http://developer.github.com/v3/issues/events/).
as documented in the [Issue Events API](https://developer.github.com/v3/issues/events/).

GET /repos/:owner/:repo/issues/events

Expand Down
2 changes: 1 addition & 1 deletion content/v3/activity/events/types.md
Expand Up @@ -278,7 +278,7 @@ Triggered on push to a GitHub Pages enabled branch (`gh-pages` for project pages

Key | Type | Description
----|------|------------
`build` | `object` | The [page build](http://developer.github.com/v3/repos/pages/#list-pages-builds) itself.
`build` | `object` | The [page build](https://developer.github.com/v3/repos/pages/#list-pages-builds) itself.


## PublicEvent
Expand Down
2 changes: 1 addition & 1 deletion content/v3/activity/feeds.md
Expand Up @@ -32,4 +32,4 @@ tokens.

[Atom]: http://en.wikipedia.org/wiki/Atom_(standard)
[authenticating]: /v3/#basic-authentication
[URI template]: http://developer.github.com/v3/#hypermedia
[URI template]: https://developer.github.com/v3/#hypermedia
2 changes: 1 addition & 1 deletion content/v3/meta.md
Expand Up @@ -18,6 +18,6 @@ Or, if you access this endpoint on your organization's [GitHub Enterprise](https

Name | Type | Description
-----|------|--------------
`hooks`|`array` of `strings` | An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from on GitHub.com. Subscribe to the [API Changes blog](http://developer.github.com/changes/) or follow [@GitHubAPI](https://twitter.com/GitHubAPI) on Twitter to get updated when this list changes.
`hooks`|`array` of `strings` | An Array of IP addresses in CIDR format specifying the addresses that incoming service hooks will originate from on GitHub.com. Subscribe to the [API Changes blog](https://developer.github.com/changes/) or follow [@GitHubAPI](https://twitter.com/GitHubAPI) on Twitter to get updated when this list changes.
`git`|`array` of `strings` | An Array of IP addresses in CIDR format specifying the Git servers for GitHub.com.
`verifiable_password_authentication`|`boolean` | Whether authentication with username and password is supported. (GitHub Enterprise instances using CAS or OAuth for authentication will return `false`. Features like [Basic Authentication with a username and password](/v3/auth/#via-username-and-password), [sudo mode](https://help.github.com/articles/sudo-mode), and [two-factor authentication](https://help.github.com/articles/about-two-factor-authentication) are not supported on these servers.)
12 changes: 6 additions & 6 deletions content/v3/oauth.md
Expand Up @@ -212,7 +212,7 @@ error:

http://your-application.com/callback?error=application_suspended
&error_description=Your+application+has+been+suspended.+Contact+support@github.com.
&error_uri=http://developer.github.com/v3/oauth/%23application-suspended
&error_uri=https://developer.github.com/v3/oauth/%23application-suspended
&state=xyz

Please contact [support](https://github.com/contact) to solve issues
Expand All @@ -226,7 +226,7 @@ URL with the following parameters summerizing the error:

http://your-application.com/callback?error=redirect_uri_mismatch
&error_description=The+redirect_uri+MUST+match+the+registered+callback+URL+for+this+application.
&error_uri=http://developer.github.com/v3/oauth/%23redirect-uri-mismatch
&error_uri=https://developer.github.com/v3/oauth/%23redirect-uri-mismatch
&state=xyz

To correct this error, either provide a redirect_uri that matches what
Expand All @@ -241,7 +241,7 @@ the error:

http://your-application.com/callback?error=access_denied
&error_description=The+user+has+denied+your+application+access.
&error_uri=http://developer.github.com/v3/oauth/%23access-denied
&error_uri=https://developer.github.com/v3/oauth/%23access-denied
&state=xyz

There's nothing you can do here as users are free to choose not to use
Expand All @@ -263,7 +263,7 @@ receive this error response.

<%= json :error => :incorrect_client_credentials,
:error_description => "The client_id and/or client_secret passed are incorrect.",
:error_uri => "http://developer.github.com/v3/oauth/#incorrect-client-credentials"
:error_uri => "https://developer.github.com/v3/oauth/#incorrect-client-credentials"
%>

To solve this error, go back and make sure you have the correct
Expand All @@ -278,7 +278,7 @@ with your application, you will receive this error message:

<%= json :error => :redirect_uri_mismatch,
:error_description => "The redirect_uri MUST match the registered callback URL for this application.",
:error_uri => "http://developer.github.com/v3/oauth/#redirect-uri-mismatch(2)"
:error_uri => "https://developer.github.com/v3/oauth/#redirect-uri-mismatch(2)"
%>

To correct this error, either provide a redirect_uri that matches what
Expand All @@ -295,7 +295,7 @@ receive this error.

<%= json :error => :bad_verification_code,
:error_description => "The code passed is incorrect or expired.",
:error_uri => "http://developer.github.com/v3/oauth/#bad-verification-code"
:error_uri => "https://developer.github.com/v3/oauth/#bad-verification-code"
%>

To solve this error, start the [OAuth process over from the beginning](#redirect-users-to-request-github-access)
Expand Down
2 changes: 1 addition & 1 deletion content/v3/repos/commits.md
Expand Up @@ -15,7 +15,7 @@ The Repo Commits API supports listing, viewing, and comparing commits in a repos

_A special note on pagination:_ Due to the way Git works, commits are paginated
based on SHA instead of page number. Please follow the link headers as outlined
in the [pagination overview](http://developer.github.com/v3/#pagination)
in the [pagination overview](https://developer.github.com/v3/#pagination)
instead of constructing page links yourself.

### Parameters
Expand Down
2 changes: 1 addition & 1 deletion content/v3/troubleshooting.md
Expand Up @@ -47,4 +47,4 @@ dreams with the current rate limit (but don't worry, we'll help you out).

When we send events to your server, we attempt to negotiate either SSL version 2 or 3.
If your server requires a specific SSL version and does not support SSL negotiation,
you can specify a specific version within the [webhook's config block](http://developer.github.com/v3/repos/hooks/#edit-a-hook). Include a parameter called `ssl_version`, with a value of either `2` or `3`.
you can specify a specific version within the [webhook's config block](https://developer.github.com/v3/repos/hooks/#edit-a-hook). Include a parameter called `ssl_version`, with a value of either `2` or `3`.
2 changes: 1 addition & 1 deletion content/webhooks/index.md
Expand Up @@ -84,7 +84,7 @@ Name | Description

The payloads for all hooks mirror [the payloads for the Event
types](/v3/activity/events/types/), with the exception of [the original `push`
event](http://developer.github.com/v3/activity/events/types/#pushevent),
event](https://developer.github.com/v3/activity/events/types/#pushevent),
which has a more detailed payload.

## Wildcard Event
Expand Down

0 comments on commit f647be1

Please sign in to comment.