Skip to content

Commit c216e3e

Browse files
committed
Preference for IANA special case domains in examples
Since some-site.com is active, and foo.com is a for sale sign, it may be better to use the IANA domains set aside for examples and illustrative cases.
1 parent 068c0ce commit c216e3e

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

content/v3.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ you if there are problems.
332332

333333
## Conditional requests
334334

335-
Most responses return `Last-Modified` and `Etag` headers. You can use the values
335+
Most responses return `Last-Modified` and `ETag` headers. You can use the values
336336
of these headers to make subsequent requests to those resources using the
337337
`If-Modified-Since` and `If-None-Match` headers, respectively. If the resource
338338
has not changed, the server will return a `304 Not Modified`. Also note: making
@@ -378,9 +378,9 @@ you can read the [CORS W3C working draft](http://www.w3.org/TR/cors), or
378378
HTML 5 Security Guide.
379379

380380
Here's a sample request sent from a browser hitting
381-
`http://some-site.com`:
381+
`http://example.com`:
382382

383-
$ curl -i https://api.github.com -H "Origin: http://some-site.com"
383+
$ curl -i https://api.github.com -H "Origin: http://example.com"
384384
HTTP/1.1 302 Found
385385

386386
Any domain that is registered as an OAuth Application is accepted.
@@ -429,7 +429,7 @@ foo({
429429
})
430430
</pre>
431431

432-
You can write a javascript handler to process the callback like this:
432+
You can write a JavaScript handler to process the callback like this:
433433

434434
<pre class="highlight"><code class="language-javascript">function foo(response) {
435435
var meta = response.meta

content/v3/oauth.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,13 +105,13 @@ redirect users to the callback URL configured in the OAuth Application
105105
settings. If provided, the redirect URL must match the callback URL's
106106
host.
107107

108-
CALLBACK: http://foo.com
108+
CALLBACK: http://example.com
109109

110-
GOOD: https://foo.com
111-
GOOD: http://foo.com/bar
112-
BAD: http://foo.com:8080
113-
BAD: http://oauth.foo.com:8080
114-
BAD: http://bar.com
110+
GOOD: https://example.com
111+
GOOD: http://example.com/bar
112+
BAD: http://example.com:8080
113+
BAD: http://oauth.example.com:8080
114+
BAD: http://example.org
115115

116116
## Scopes
117117

content/v3/repos/hooks.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ The payloads for all of the hooks mirror [the payloads for the Event
3939
types](/v3/activity/events/types/), with the exception of [the original `push`
4040
event](http://help.github.com/post-receive-hooks/).
4141

42-
A number of external services have already been integrated through the open source
43-
[github-services](https://github.com/github/github-services) project, including the generic
44-
[Web Service](https://github.com/github/github-services/blob/master/services/web.rb) service which can be used to
45-
define your own custom hooks. All possible names for hooks, the events they support, and their configuration can be seen at [/hooks](https://api.github.com/hooks).
42+
A number of external services have already been integrated through the open source
43+
[github-services](https://github.com/github/github-services) project, including the generic
44+
[Web Service](https://github.com/github/github-services/blob/master/services/web.rb) service which can be used to
45+
define your own custom hooks. All possible names for hooks, the events they support, and their configuration can be seen at [/hooks](https://api.github.com/hooks).
4646

4747
For a Hook to go through, the Hook needs to be configured to trigger for
4848
an event, and the Service has to listen to it. Most of the Services only listen for `push` events. However, the generic [Web Service](https://github.com/github/github-services/blob/master/services/web.rb) listens for all events. Other services like the [IRC Service](https://github.com/github/github-services/blob/master/services/irc.rb) may only listen for `push`, `issues`, and `pull_request` events.
@@ -106,7 +106,7 @@ legacy format):
106106
:active => true,
107107
:events => ['push', 'pull_request'],
108108
:config => {
109-
:url => 'http://something.com/webhook',
109+
:url => 'http://example.com/webhook',
110110
:content_type => 'json'}
111111
%>
112112

@@ -137,7 +137,7 @@ JSON true/false values will be converted automatically.
137137

138138

139139

140-
You can change a hook to send straight JSON by
140+
You can change a hook to send straight JSON by
141141

142142
`events`
143143
: _Optional_ **array** - Determines what events the hook is triggered

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy