You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ Direct the user to the following URL in their browser:
44
44
45
45
When your GitHub App specifies a `login` parameter, it prompts users with a specific account they can use for signing in and authorizing your app.
46
46
47
-
#### Parameters
47
+
#### Input parameters for `GET {% data variables.product.oauth_host_code %}/login/oauth/authorize`
48
48
49
49
Name | Type | Description
50
50
-----|------|------------
@@ -78,7 +78,7 @@ Make a request to the following endpoint to receive an access token:
78
78
79
79
POST {% data variables.product.oauth_host_code %}/login/oauth/access_token
80
80
81
-
#### Parameters
81
+
#### Input parameters for `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
82
82
83
83
Name | Type | Description
84
84
-----|------|------------
@@ -87,7 +87,7 @@ Name | Type | Description
87
87
`code` | `string` | **Required.** The code you received as a response to Step 1.
88
88
`redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to {% ifversion fpt or ghes or ghec %} one of the URLs you provided as a **Callback URL** {% else %} the URL you provided in the **User authorization callback URL** field{% endif %} when setting up your GitHub App and can't contain any additional parameters.
89
89
90
-
#### Response
90
+
#### Response from `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
91
91
92
92
By default, the response takes the following form. The response parameters `expires_in`, `refresh_token`, and `refresh_token_expires_in` are only returned when you enable expiring user-to-server access tokens.
Copy file name to clipboardexpand all lines: content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ The web application flow to authorize users for your app is:
46
46
47
47
When your GitHub App specifies a `login` parameter, it prompts users with a specific account they can use for signing in and authorizing your app.
48
48
49
-
#### Parameters
49
+
#### Input parameters for `GET {% data variables.product.oauth_host_code %}/login/oauth/authorize`
50
50
51
51
Name | Type | Description
52
52
-----|------|--------------
@@ -65,7 +65,7 @@ Exchange this `code` for an access token:
65
65
66
66
POST {% data variables.product.oauth_host_code %}/login/oauth/access_token
67
67
68
-
#### Parameters
68
+
#### Input parameters for `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
69
69
70
70
Name | Type | Description
71
71
-----|------|--------------
@@ -74,7 +74,7 @@ Name | Type | Description
74
74
`code` | `string` | **Required.** The code you received as a response to Step 1.
75
75
`redirect_uri` | `string` | The URL in your application where users are sent after authorization.
76
76
77
-
#### Response
77
+
#### Response from `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
78
78
79
79
By default, the response takes the following form:
80
80
@@ -143,14 +143,14 @@ Before you can use the device flow to authorize and identify users, you must fir
143
143
144
144
Your app must request a user verification code and verification URL that the app will use to prompt the user to authenticate in the next step. This request also returns a device verification code that the app must use to receive an access token and check the status of user authentication.
145
145
146
-
#### Input Parameters
146
+
#### Input parameters for `POST {% data variables.product.oauth_host_code %}/login/device/code`
147
147
148
148
Name | Type | Description
149
149
-----|------|--------------
150
150
`client_id` | `string` | **Required.** The client ID you received from {% data variables.product.product_name %} for your app.
151
151
`scope` | `string` | The scope that your app is requesting access to.
152
152
153
-
#### Response
153
+
#### Response from `POST {% data variables.product.oauth_host_code %}/login/device/code`
154
154
155
155
By default, the response takes the following form:
156
156
@@ -182,7 +182,7 @@ Accept: application/xml
182
182
</OAuth>
183
183
```
184
184
185
-
#### Response parameters
185
+
#### Response parameters for `POST {% data variables.product.oauth_host_code %}/login/device/code`
186
186
187
187
Name | Type | Description
188
188
-----|------|--------------
@@ -208,15 +208,15 @@ The user must enter a valid code within 15 minutes (or 900 seconds). After 15 mi
208
208
209
209
Once the user has authorized, the app will receive an access token that can be used to make requests to the API on behalf of a user.
210
210
211
-
#### Input parameters
211
+
#### Input parameters for `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
212
212
213
213
Name | Type | Description
214
214
-----|------|--------------
215
215
`client_id` | `string` | **Required.** The client ID you received from {% data variables.product.product_name %} for your {% data variables.product.prodname_oauth_app %}.
216
216
`device_code` | `string` | **Required.** The device verification code you received from the `POST {% data variables.product.oauth_host_code %}/login/device/code` request.
217
217
`grant_type` | `string` | **Required.** The grant type must be `urn:ietf:params:oauth:grant-type:device_code`.
218
218
219
-
#### Response
219
+
#### Response from `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
220
220
221
221
By default, the response takes the following form:
Copy file name to clipboardexpand all lines: content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -26,17 +26,17 @@ Here are guidelines about the fields you'll need to fill out in the **Listing de
26
26
27
27
Your listing's name will appear on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace). The name is limited to 255 characters and can be different from your app's name. Your listing cannot have the same name as an existing account on {% data variables.location.product_location %}, unless the name is your own user or organization name.
28
28
29
-
### Very short description
29
+
### Very short description of listing
30
30
31
31
The community will see the "very short" description under your app's name on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace).
32
32
33
33

34
34
35
-
#### Length
35
+
#### Length of "Very short description"
36
36
37
37
We recommend keeping short descriptions to 40-80 characters. Although you are allowed to use more characters, concise descriptions are easier for customers to read and understand quickly.
38
38
39
-
#### Content
39
+
#### Content of "Very short description"
40
40
41
41
- Describe the app’s functionality. Don't use this space for a call to action. For example:
42
42
@@ -52,7 +52,7 @@ We recommend keeping short descriptions to 40-80 characters. Although you are al
52
52
53
53
**DON'T:** Skycap is a container-native continuous integration tool
54
54
55
-
#### Formatting
55
+
#### Formatting of "Very short description"
56
56
57
57
- Always use sentence-case capitalization. Only capitalize the first letter and proper nouns.
Follow these guidelines for writing these descriptions.
144
144
145
-
### Length
145
+
### Length of "Introductory description" and "Detailed description"
146
146
147
147
We recommend writing a 1-2 sentence high-level summary between 150-250 characters in the required "Introductory description" field when [listing your app](/marketplace/listing-on-github-marketplace/). Although you are allowed to use more characters, concise summaries are easier for customers to read and understand quickly.
148
148
149
149
You can add more information in the optional "Detailed description" field. You see this description when you click **Read more...** below the introductory description on your app's landing page. A detailed description consists of 3-5 [value propositions](https://en.wikipedia.org/wiki/Value_proposition), with 1-2 sentences describing each one. You can use up to 1,000 characters for this description.
150
150
151
-
### Content
151
+
### Content of "Introductory description" and "Detailed description"
152
152
153
153
- Always begin introductory descriptions with your app's name.
154
154
155
155
- Always write descriptions and value propositions using the active voice.
156
156
157
-
### Formatting
157
+
### Formatting of "Introductory description" and "Detailed description"
158
158
159
159
- Always use sentence-case capitalization in value proposition titles. Only capitalize the first letter and proper nouns.
0 commit comments