docs: *.getById method descriptions (#718)

octokit · Jan 25, 2018 · 04b7876 · 04b7876
1 parent 34109d6
commit 04b7876
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/lib/routes.json b/lib/routes.json
@@ -6535,7 +6535,8 @@
       "params": {
         "id": {
           "type": "string",
-          "required": true
+          "required": true,
+          "description": "Numerical ID of the repository."
         }
       },
       "description": "Get a single repo by id."
@@ -9680,10 +9681,11 @@
       "params": {
         "id": {
           "type": "string",
-          "required": true
+          "required": true,
+          "description": "Numerical ID of the user."
         }
       },
-      "description": "Get a single user by GitHub ID"
+      "description": "Get a single user by GitHub ID. This method uses numerical user ID. Use users.getForUser method if you need to get a user by username."
     },
     "getAll": {
       "url": "/users",