Change :user to refer to :username

gjtorikian · gjtorikian · commit 66406d9c39e2 · 2014-06-24T18:27:48.000-07:00
diff --git a/content/v3/activity/events.md b/content/v3/activity/events.md
@@ -65,26 +65,26 @@ These are events that you've received by watching repos and following
 users.  If you are authenticated as the given user, you will see private
 events.  Otherwise, you'll only see public events.
 
-    GET /users/:user/received_events
+    GET /users/:username/received_events
 
 ## List public events that a user has received
 
-    GET /users/:user/received_events/public
+    GET /users/:username/received_events/public
 
 ## List events performed by a user
 
 If you are authenticated as the given user, you will see your private
 events.  Otherwise, you'll only see public events.
 
-    GET /users/:user/events
+    GET /users/:username/events
 
 ## List public events performed by a user
 
-    GET /users/:user/events/public
+    GET /users/:username/events/public
 
 ## List events for an organization
 
 This is the user's organization dashboard.  You must be authenticated as
 the user to view this.
 
-    GET /users/:user/events/orgs/:org
+    GET /users/:username/events/orgs/:org
diff --git a/content/v3/activity/starring.md b/content/v3/activity/starring.md
@@ -34,15 +34,15 @@ for more details.
 
 List repositories being starred by a user.
 
-    GET /users/:user/starred
+    GET /users/:username/starred
 
 List repositories being starred by the authenticated user.
 
     GET /user/starred
 
 ### Parameters
 
-Name | Type | Description 
+Name | Type | Description
 -----|------|--------------
 `sort`|`string` | One of `created` (when the repository was starred) or `updated` (when it was last pushed to). Default: `created`
 `direction`|`string` | One of `asc` (ascending) or `desc` (descending). Default: `desc`
diff --git a/content/v3/activity/watching.md b/content/v3/activity/watching.md
@@ -36,7 +36,7 @@ post](/changes/2012-9-5-watcher-api/) for more details.
 
 List repositories being watched by a user.
 
-    GET /users/:user/subscriptions
+    GET /users/:username/subscriptions
 
 List repositories being watched by the authenticated user.
 
@@ -66,7 +66,7 @@ List repositories being watched by the authenticated user.
 
 ### Parameters
 
-Name | Type | Description 
+Name | Type | Description
 -----|------|--------------
 `subscribed`|`boolean`| Determines if notifications should be received from this repository.
 `ignored`|`boolean`| Determines if all notifications should be blocked from this repository.
diff --git a/content/v3/gists.md b/content/v3/gists.md
@@ -19,7 +19,7 @@ The API will return a 401 "Bad credentials" response if the gists scope was give
 
 List a user's gists:
 
-    GET /users/:user/gists
+    GET /users/:username/gists
 
 List the authenticated user's gists or if called anonymously, this will
 return all public gists:
@@ -78,7 +78,7 @@ The keys in the `files` hash are the `string` filename, and the value is another
 
 <div class="alert">
   <p>
-    <strong>Note</strong>: Don't name your files "gistfile" with a numerical suffix.  This is the format of the automatic naming scheme that Gist uses internally. 
+    <strong>Note</strong>: Don't name your files "gistfile" with a numerical suffix.  This is the format of the automatic naming scheme that Gist uses internally.
 	</p>
 </div>
 
diff --git a/content/v3/orgs.md b/content/v3/orgs.md
@@ -11,7 +11,7 @@ title: Organizations | GitHub API
 
 List all public organizations for an unauthenticated user. Lists private *and* public organizations for authenticated users.
 
-    GET /users/:user/orgs
+    GET /users/:username/orgs
 
 List public and private organizations for the authenticated user.
 
@@ -37,7 +37,7 @@ List public and private organizations for the authenticated user.
 
 ### Input
 
-Name | Type | Description 
+Name | Type | Description
 -----|------|--------------
 `billing_email`|`string` | Billing email address. This address is not publicized.
 `company`|`string` | The company name.
diff --git a/content/v3/orgs/members.md b/content/v3/orgs/members.md
@@ -38,7 +38,7 @@ Name    | Type    | Description
 
 Check if a user is, publicly or privately, a member of the organization.
 
-    GET /orgs/:org/members/:user
+    GET /orgs/:org/members/:username
 
 ### Response if requester is an organization member and user is a member
 
@@ -66,7 +66,7 @@ To add someone as a member to an org, you must add them to a
 Removing a user from this list will remove them from all teams and
 they will no longer have any access to the organization's repositories.
 
-    DELETE /orgs/:org/members/:user
+    DELETE /orgs/:org/members/:username
 
 ### Response
 
@@ -86,7 +86,7 @@ publicized or not.
 
 ## Check public membership
 
-    GET /orgs/:org/public_members/:user
+    GET /orgs/:org/public_members/:username
 
 ### Response if user is a public member
 
@@ -101,15 +101,15 @@ publicized or not.
 The user can publicize their own membership.
 (A user cannot publicize the membership for another user.)
 
-    PUT /orgs/:org/public_members/:user
+    PUT /orgs/:org/public_members/:username
 
 ### Response
 
 <%= headers 204 %>
 
 ## Conceal a user's membership
 
-    DELETE /orgs/:org/public_members/:user
+    DELETE /orgs/:org/public_members/:username
 
 ### Response
 
diff --git a/content/v3/orgs/teams.md b/content/v3/orgs/teams.md
@@ -38,7 +38,7 @@ In order to create a team, the authenticated user must be an owner of
 
 ### Parameters
 
-Name | Type | Description 
+Name | Type | Description
 -----|------|--------------
 `name`|`string` | **Required**. The name of the team.
 `repo_names`|`array` of `strings` | The repositories to add the team to.
@@ -65,7 +65,7 @@ the org that the team is associated with.
 
 ### Parameters
 
-Name | Type | Description 
+Name | Type | Description
 -----|------|--------------
 `name`|`string` | **Required**. The name of the team.
 `permission`|`string` | The permission to grant the team. Can be one of:<br/> * `pull` - team members can pull, but not push to or administer these repositories.<br/> * `push` - team members can pull and push, but not administer these repositories.<br/> * `admin` - team members can pull, push and administer these repositories. Default: `pull`
@@ -109,7 +109,7 @@ member of the team.
 In order to get if a user is a member of a team, the authenticated user
 must be a member of the team.
 
-    GET /teams/:id/members/:user
+    GET /teams/:id/members/:username
 
 ### Response if user is a member
 
@@ -125,7 +125,7 @@ In order to add a user to a team, the authenticated user must have
 'admin' permissions to the team or be an owner of the org that the team
 is associated with.
 
-    PUT /teams/:id/members/:user
+    PUT /teams/:id/members/:username
 
 ### Response
 
@@ -150,7 +150,7 @@ In order to remove a user from a team, the authenticated user must have
 is associated with.
 NOTE: This does not delete the user, it just remove them from the team.
 
-    DELETE /teams/:id/members/:user
+    DELETE /teams/:id/members/:username
 
 ### Response
 
diff --git a/content/v3/repos.md b/content/v3/repos.md
@@ -30,7 +30,7 @@ Name | Type | Description
 
 List public repositories for the specified user.
 
-    GET /users/:user/repos
+    GET /users/:username/repos
 
 ### Parameters
 
diff --git a/content/v3/repos/collaborators.md b/content/v3/repos/collaborators.md
@@ -23,7 +23,7 @@ collaborators list.
 
 ## Check if a user is a collaborator {#get}
 
-    GET /repos/:owner/:repo/collaborators/:user
+    GET /repos/:owner/:repo/collaborators/:username
 
 ### Response if user is a collaborator
 
@@ -35,15 +35,15 @@ collaborators list.
 
 ## Add user as a collaborator {#add-collaborator}
 
-    PUT /repos/:owner/:repo/collaborators/:user
+    PUT /repos/:owner/:repo/collaborators/:username
 
 ### Response
 
 <%= headers 204 %>
 
 ## Remove user as a collaborator {#remove-collaborator}
 
-    DELETE /repos/:owner/:repo/collaborators/:user
+    DELETE /repos/:owner/:repo/collaborators/:username
 
 ### Response
 
diff --git a/content/v3/users.md b/content/v3/users.md
@@ -9,16 +9,13 @@ title: Users | GitHub API
 
 Many of the resources on the users API provide a shortcut for getting
 information about the currently authenticated user. If a request URL
-does not include a `:user` parameter then the response will be for the
+does not include a `:username` parameter then the response will be for the
 logged in user (and you must pass [authentication
 information](/v3/#authentication) with your request).
 
-Throughout this documentation, the `:user` parameter denotes the username,
-not the user ID.
-
 ## Get a single user
 
-    GET /users/:user
+    GET /users/:username
 
 ### Response
 
diff --git a/content/v3/users/followers.md b/content/v3/users/followers.md
@@ -11,7 +11,7 @@ title: User Followers | GitHub API
 
 List a user's followers:
 
-    GET /users/:user/followers
+    GET /users/:username/followers
 
 List the authenticated user's followers:
 
@@ -26,7 +26,7 @@ List the authenticated user's followers:
 
 List who a user is following:
 
-    GET /users/:user/following
+    GET /users/:username/following
 
 List who the authenticated user is following:
 
@@ -39,7 +39,7 @@ List who the authenticated user is following:
 
 ## Check if you are following a user
 
-    GET /user/following/:user
+    GET /user/following/:username
 
 ### Response if you are following this user
 
@@ -51,7 +51,7 @@ List who the authenticated user is following:
 
 ## Check if one user follows another
 
-    GET /users/:user/following/:target_user
+    GET /users/:username/following/:target_user
 
 ### Response if user follows target user
 
@@ -63,7 +63,7 @@ List who the authenticated user is following:
 
 ## Follow a user
 
-    PUT /user/following/:user
+    PUT /user/following/:username
 
 Following a user requires the user to be logged in and authenticated with basic
 auth or OAuth with the `user:follow` scope.
@@ -74,7 +74,7 @@ auth or OAuth with the `user:follow` scope.
 
 ## Unfollow a user
 
-    DELETE /user/following/:user
+    DELETE /user/following/:username
 
 Unfollowing a user requires the user to be logged in and authenticated with basic
 auth or OAuth with the `user:follow` scope.
diff --git a/content/v3/users/keys.md b/content/v3/users/keys.md
@@ -9,7 +9,7 @@ title: User Public Keys | GitHub API
 
 ## List public keys for a user
 
-    GET /users/:user/keys
+    GET /users/:username/keys
 
 Lists the _verified_ public keys for a user.  This is accessible by anyone.
 
diff --git a/content/v3/versions.md b/content/v3/versions.md
@@ -129,7 +129,7 @@ The [beta API](/v3) is deprecated. Its current functionality is stable and uncha
   responses that include users or orgs. A default size is no longer
   included in the URL.
 * Creating new gists (both anonymously and with an authenticated user)
-  should use `POST /gists` from now on. `POST /users/:user/gists` is no
+  should use `POST /gists` from now on. `POST /users/:username/gists` is no
   longer supported.
 
 ### June 1st, 2011:
