FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Sync with upstream repository · github/developer.github.com@dcc049f · GitHub

This repository was archived by the owner on Nov 1, 2017. It is now read-only.
/ developer.github.com Public archive

Commit dcc049f

Browse files
gjtorikian
committed
Sync with upstream repository
1 parent 0770fad commit dcc049f

12 files changed

Lines changed: 62 additions & 44 deletions

File tree

‎Rules‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,32 +17,36 @@ compile '/changes.atom' do
1717
end
1818

1919
compile '/integrations-directory/*' do
20+
filter :'conref-fs-filter'
2021
filter :erb
2122
filter :html_pipeline, @config[:pipeline_config]
2223
layout item[:layout] || '/integrations-directory.*'
2324
end
2425

2526
compile '/v3{.*,/**/*}' do
27+
filter :'conref-fs-filter'
2628
filter :erb
2729
filter :html_pipeline, @config[:pipeline_config]
28-
filter :enterprise_only_filter
2930
layout(item[:layout] ? "/#{item[:layout]}.*" : '/api.*')
3031
end
3132

3233
compile "/changes/20*" do
34+
filter :'conref-fs-filter'
3335
filter :erb
3436
filter :html_pipeline, @config[:pipeline_config]
3537
layout '/changes.*'
3638
layout(item[:layout] ? "/#{item[:layout]}.*" : '/blog.*')
3739
end
3840

3941
compile '/guides/**/*' do
42+
filter :'conref-fs-filter'
4043
filter :html_pipeline, @config[:pipeline_config]
4144
filter :erb
4245
layout(item[:layout] ? "/#{item[:layout]}.*" : '/guides.*')
4346
end
4447

4548
compile '/webhooks/**/*' do
49+
filter :'conref-fs-filter'
4650
filter :erb
4751
filter :html_pipeline, @config[:pipeline_config]
4852
layout(item[:layout] ? "/#{item[:layout]}.*" : '/webhooks.*')
@@ -53,6 +57,7 @@ compile '/search/search-index.json' do
5357
end
5458

5559
compile '/**/*' do
60+
filter :'conref-fs-filter'
5661
filter :erb
5762
filter :html_pipeline, @config[:pipeline_config]
5863
layout(item[:layout] ? "/#{item[:layout]}.*" : '/default.*')

‎content/v3/enterprise.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ The latest release for GitHub Enterprise is <%= config[:versions][0] %>. The Git
4141

4242
Documentation for the API that's bundled with your GitHub Enterprise appliance is available for past releases:
4343

44-
* [API documentation for 2.3](https://developer.github.com/enterprise/2.3/)
45-
* [API documentation for 2.2](https://developer.github.com/enterprise/2.2/)
46-
* [API documentation for 2.1](https://developer.github.com/enterprise/2.1/)
47-
* [API documentation for 2.0](https://developer.github.com/enterprise/2.0/)
48-
* [API documentation for 11.10.340](https://developer.github.com/enterprise/11.10.340/)
44+
<% config[:versions][1..-1].each do |version| %>
45+
* [API documentation for <%= version %>](https://developer.github.com/enterprise/<%= version %>/)
46+
<% end %>

‎content/v3/oauth_authorizations.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ Make sure you understand how to [work with two-factor authentication](/v3/auth/#
2222
<li><a href="#list-your-authorizations">List your authorizations</a></li>
2323
<li><a href="#get-a-single-authorization">Get a single authorization</a></li>
2424
<li><a href="#get-or-create-an-authorization-for-a-specific-app">Get-or-create an authorization for a specific app</a> - <code>token</code> is still returned for "create" </li>
25+
{% if page.version == 'dotcom' or page.version > 2.2 %}
2526
<li><a href="#get-or-create-an-authorization-for-a-specific-app-and-fingerprint">Get-or-create an authorization for a specific app and fingerprint</a> - <code>token</code> is still returned for "create" </li>
27+
{% endif %}
2628
<li><a href="#update-an-existing-authorization">Update an existing authorization</a></li>
2729
</ul>
2830

@@ -107,7 +109,7 @@ Name | Type | Description
107109
`scopes`|`array` | A list of scopes that this authorization is in.
108110
`note`|`string` | A note to remind you what the OAuth token is for.
109111
`note_url`|`string` | A URL to remind you what app the OAuth token is for.
110-
`fingerprint`|`string` | A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).
112+
{% if page.version == 'dotcom' or page.version > 2.2 %}`fingerprint`|`string` | A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).{% endif %}
111113

112114

113115
<%= json :client_secret => "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcd", :scopes => ["public_repo"], :note => 'admin script' %>
@@ -122,6 +124,8 @@ Name | Type | Description
122124
<%= headers 200, :Location => get_resource(:oauth_access)['url'] %>
123125
<%= json(:oauth_access) { |h| h.merge("token" => "", "fingerprint" => "") } %>
124126

127+
{% if page.version == 'dotcom' or page.version > 2.2 %}
128+
125129
## Get-or-create an authorization for a specific app and fingerprint
126130

127131
This method will create a new authorization for the specified OAuth application,
@@ -156,6 +160,8 @@ Name | Type | Description
156160
<%= headers 200, :Location => get_resource(:oauth_access)['url'] %>
157161
<%= json(:oauth_access) { |h| h.merge("token" => "") } %>
158162

163+
{% endif %}
164+
159165
## Update an existing authorization
160166

161167
PATCH /authorizations/:id

‎content/v3/orgs/hooks.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,20 @@ title: Organization Webhooks
66

77
{:toc}
88

9+
{% if page.version != 'dotcom' and page.version <= 2.2 %}
10+
{{#tip}}
11+
The Organization Webhooks API is currently available for developers to preview.
12+
During the preview period, the API may change without advance notice.
13+
Please see the [blog post](/enterprise/{{ page.version }}/changes/2014-12-03-preview-the-new-organization-webhooks-api/) for full details.
14+
15+
To access the API during the preview period, you must provide a custom [media type](/enterprise/2.2/v3/media) in the `Accept` header:
16+
17+
```
18+
application/vnd.github.sersi-preview+json
19+
```
20+
{{/tip}}
21+
{% endif %}
22+
923
Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen within the organization. Subscribing to these events makes it possible to build integrations that react to actions on GitHub.com. For more information on actions you can subscribe to, check out our [Events documentation][webhook-events].
1024

1125
## Scopes & Restrictions

‎content/v3/orgs/migrations.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ title: Migrations
66

77
{:toc}
88

9-
{{#enterprise-only}}
9+
{% if page.version != 'dotcom' %}
1010

1111
{{#warning}}
1212

1313
This API is not currently available on GitHub Enterprise.
1414

1515
{{/warning}}
1616

17-
{{/enterprise-only}}
17+
{% endif %}
1818

1919
{{#tip}}
2020

‎content/v3/orgs/teams.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,12 +130,12 @@ the org that the team is associated with, or a maintainer of the team.
130130
In order to list members in a team, the team must be visible to the
131131
authenticated user.
132132

133-
{{#enterprise-only}}
133+
{% if page.version != 'dotcom' and page.version >= 2.3 %}
134134

135135
<%= fetch_content(:if_site_admin) %>
136136
you will be able to list all members for the team.
137137

138-
{{/enterprise-only}}
138+
{% endif %}
139139

140140
GET /teams/:id/members
141141

@@ -373,12 +373,12 @@ team.
373373

374374
GET /teams/:id/repos
375375

376-
{{#enterprise-only}}
376+
{% if page.version != 'dotcom' and page.version >= 2.3 %}
377377

378378
<%= fetch_content(:if_site_admin) %>
379379
you will be able to list all repositories for the team.
380380

381-
{{/enterprise-only}}
381+
{% endif %}
382382

383383
### Response
384384

‎content/v3/repos.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Note: Pagination is powered exclusively by the `since` parameter.
6767
Use the [Link header](/v3/#link-header) to get the URL for the next page of
6868
repositories.
6969

70-
{{#enterprise-only}}
70+
{% if page.version != 'dotcom' and page.version >= 2.3 %}
7171

7272
If you are an [authenticated](/v3/#authentication) site administrator for your Enterprise instance,
7373
you will be able to list all repositories including private repositories.
@@ -78,7 +78,7 @@ Name | Type | Description
7878
-----|------|--------------
7979
`visibility`|`string`| To include private repositories as well set to `all`. Default: `public`
8080

81-
{{/enterprise-only}}
81+
{% endif %}
8282

8383
GET /repositories
8484

‎content/v3/users/administration.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Prefix all the endpoints for this API with the following URL:
1414
http(s)://<em>hostname</em>/api/v3
1515
```
1616

17+
{% if page.version != 'dotcom' and page.version >= 2.3 %}
18+
1719
## Create a new user
1820

1921
POST /admin/users
@@ -84,6 +86,8 @@ Name | Type | Description
8486

8587
<%= headers 204 %>
8688

89+
{% endif %}
90+
8791
## Promote an ordinary user to a site administrator
8892

8993
PUT /users/:username/site_admin
@@ -136,6 +140,8 @@ If your GitHub Enterprise appliance has [LDAP Sync with Active Directory LDAP se
136140

137141
<%= headers 204 %>
138142

143+
{% if page.version != 'dotcom' and page.version >= 2.3 %}
144+
139145
## List all public keys
140146

141147
GET /admin/keys
@@ -147,6 +153,8 @@ If your GitHub Enterprise appliance has [LDAP Sync with Active Directory LDAP se
147153
[public_key, deploy_key.merge("id" => "2", "url" => "https://api.github.com/repos/octocat/Hello-World/keys/2")] \
148154
} %>
149155

156+
{% if page.version != 'dotcom' and page.version >= 2.4 %}
157+
150158
## Delete a user
151159

152160
{{#warning}}
@@ -163,10 +171,14 @@ You can delete any user account except your own.
163171

164172
<%= headers 204 %>
165173

174+
{% endif %}
175+
166176
## Delete a public key
167177

168178
DELETE /admin/keys/1
169179

170180
### Response
171181

172182
<%= headers 204 %>
183+
184+
{% endif %}

‎content/v3/users/emails.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ This endpoint is accessible with the user:email scope.
2222

2323
## Add email address(es)
2424

25-
{{#enterprise-only}}
25+
{% if page.version != 'dotcom' && page.version >= 2.1 %}
2626

2727
{{#warning}}
2828

2929
If your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/2.1/admin/guides/user-management/using-ldap) and the option to synchronize emails enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add an email address via the API with these options enabled.
3030

3131
{{/warning}}
3232

33-
{{/enterprise-only}}
33+
{% endif %}
3434

3535
POST /user/emails
3636

@@ -58,15 +58,15 @@ You can post a single email address or an array of addresses:
5858

5959
## Delete email address(es)
6060

61-
{{#enterprise-only}}
61+
{% if page.version != 'dotcom' && page.version >= 2.1 %}
6262

6363
{{#warning}}
6464

6565
If your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/2.1/admin/guides/user-management/using-ldap) and the option to synchronize emails enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to remove an email address via the API with these options enabled.
6666

6767
{{/warning}}
6868

69-
{{/enterprise-only}}
69+
{% endif %}
7070

7171
DELETE /user/emails
7272

‎content/v3/users/keys.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ authenticated via Basic Auth or via OAuth with at least `read:public_key`
4949
Creates a public key. Requires that you are authenticated via Basic Auth,
5050
or OAuth with at least `write:public_key` [scope](/v3/oauth/#scopes).
5151

52-
{{#enterprise-only}}
52+
{% if page.version != 'dotcom' && page.version >= 2.1 %}
5353

5454
{{#warning}}
5555

5656
If your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/2.1/admin/guides/user-management/using-ldap) and the option to synchronize SSH keys enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add an SSH key address via the API with these options enabled.
5757

5858
{{/warning}}
5959

60-
{{/enterprise-only}}
60+
{% endif %}
6161

6262
POST /user/keys
6363

@@ -81,15 +81,15 @@ instead.
8181
Removes a public key. Requires that you are authenticated via Basic Auth
8282
or via OAuth with at least `admin:public_key` [scope](/v3/oauth/#scopes).
8383

84-
{{#enterprise-only}}
84+
{% if page.version != 'dotcom' && page.version >= 2.1 %}
8585

8686
{{#warning}}
8787

8888
If your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/2.1/admin/guides/user-management/using-ldap) and the option to synchronize SSH keys enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to remove an SSH key address via the API with these options enabled.
8989

9090
{{/warning}}
9191

92-
{{/enterprise-only}}
92+
{% endif %}
9393

9494
DELETE /user/keys/:id
9595

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL