Documented all $id parameters in API classes as int

morozov · morozov · commit 116322f2f94b · 2017-10-24T20:48:54.000-07:00
diff --git a/lib/Github/Api/CurrentUser/Notifications.php b/lib/Github/Api/CurrentUser/Notifications.php
@@ -75,8 +75,8 @@ public function markAsReadInRepository($username, $repository, array $params = a
      *
      * @link http://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
      *
-     * @param string $id     the notification number
-     * @param array  $params
+     * @param int   $id     the notification number
+     * @param array $params
      *
      * @return array
      */
@@ -90,7 +90,7 @@ public function markAsRead($id, array $params)
      *
      * @link http://developer.github.com/v3/activity/notifications/#view-a-single-thread
      *
-     * @param string $id the notification number
+     * @param int $id the notification number
      *
      * @return array
      */
@@ -104,7 +104,7 @@ public function show($id)
      *
      * @link http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription
      *
-     * @param string $id the notification number
+     * @param int $id the notification number
      *
      * @return array
      */
@@ -118,8 +118,8 @@ public function showSubscription($id)
      *
      * @link http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription
      *
-     * @param string $id     the notification number
-     * @param array  $params
+     * @param int   $id     the notification number
+     * @param array $params
      *
      * @return array
      */
@@ -133,7 +133,7 @@ public function createSubscription($id, array $params)
      *
      * @link http://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription
      *
-     * @param string $id the notification number
+     * @param int $id the notification number
      *
      * @return array
      */
diff --git a/lib/Github/Api/CurrentUser/PublicKeys.php b/lib/Github/Api/CurrentUser/PublicKeys.php
@@ -28,7 +28,7 @@ public function all()
      *
      * @link https://developer.github.com/v3/users/keys/
      *
-     * @param string $id
+     * @param int $id
      *
      * @return array
      */
@@ -62,7 +62,7 @@ public function create(array $params)
      *
      * @link https://developer.github.com/v3/users/keys/
      *
-     * @param string $id
+     * @param int $id
      *
      * @return array
      */
diff --git a/lib/Github/Api/Deployment.php b/lib/Github/Api/Deployment.php
@@ -68,8 +68,8 @@ public function create($username, $repository, array $params)
      *
      * @param string $username the username
      * @param string $repository the repository
-     * @param string $id the deployment number
-     * @param array $params The information about the deployment update.
+     * @param int    $id the deployment number
+     * @param array  $params The information about the deployment update.
      *                       Must include a "state" field of pending, success, error, or failure.
      *                       May also be given a target_url and description, ßee link for more details.
      * @return array information about the deployment
diff --git a/lib/Github/Api/Issue.php b/lib/Github/Api/Issue.php
@@ -104,7 +104,7 @@ public function org($organization, $state, array $params = array())
      *
      * @param string $username   the username
      * @param string $repository the repository
-     * @param string $id         the issue number
+     * @param int    $id         the issue number
      *
      * @return array information about the issue
      */
@@ -143,7 +143,7 @@ public function create($username, $repository, array $params)
      *
      * @param string $username   the username
      * @param string $repository the repository
-     * @param string $id         the issue number
+     * @param int    $id         the issue number
      * @param array  $params     key=>value user attributes to update.
      *                           key can be title or body
      *
@@ -161,7 +161,7 @@ public function update($username, $repository, $id, array $params)
      *
      * @param string $username
      * @param string $repository
-     * @param string $id
+     * @param int    $id
      *
      * @return string
      */
@@ -177,7 +177,7 @@ public function lock($username, $repository, $id)
      *
      * @param string $username
      * @param string $repository
-     * @param string $id
+     * @param int    $id
      *
      * @return string
      */
diff --git a/lib/Github/Api/PullRequest.php b/lib/Github/Api/PullRequest.php
@@ -75,7 +75,7 @@ public function all($username, $repository, array $params = array())
      *
      * @param string $username   the username
      * @param string $repository the repository
-     * @param string $id         the ID of the pull request for which details are retrieved
+     * @param int    $id         the ID of the pull request for which details are retrieved
      *
      * @return array|string pull request details
      */
@@ -101,7 +101,7 @@ public function files($username, $repository, $id)
      *
      * @param string $username   the username
      * @param string $repository the repository
-     * @param string $id         the ID of the pull request for which statuses are retrieved
+     * @param int    $id         the ID of the pull request for which statuses are retrieved
      *
      * @return array array of statuses for the project
      */

Original file line number	Diff line number	Diff line change
`@@ -75,8 +75,8 @@ public function markAsReadInRepository($username, $repository, array $params = a`
`75`	`75`	`*`
`76`	`76`	`* @link http://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read`
`77`	`77`	`*`
`78`		`- * @param string $id the notification number`
`79`		`- * @param array $params`
	`78`	`+ * @param int $id the notification number`
	`79`	`+ * @param array $params`
`80`	`80`	`*`
`81`	`81`	`* @return array`
`82`	`82`	`*/`
`@@ -90,7 +90,7 @@ public function markAsRead($id, array $params)`
`90`	`90`	`*`
`91`	`91`	`* @link http://developer.github.com/v3/activity/notifications/#view-a-single-thread`
`92`	`92`	`*`
`93`		`- * @param string $id the notification number`
	`93`	`+ * @param int $id the notification number`
`94`	`94`	`*`
`95`	`95`	`* @return array`
`96`	`96`	`*/`
`@@ -104,7 +104,7 @@ public function show($id)`
`104`	`104`	`*`
`105`	`105`	`* @link http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription`
`106`	`106`	`*`
`107`		`- * @param string $id the notification number`
	`107`	`+ * @param int $id the notification number`
`108`	`108`	`*`
`109`	`109`	`* @return array`
`110`	`110`	`*/`
`@@ -118,8 +118,8 @@ public function showSubscription($id)`
`118`	`118`	`*`
`119`	`119`	`* @link http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription`
`120`	`120`	`*`
`121`		`- * @param string $id the notification number`
`122`		`- * @param array $params`
	`121`	`+ * @param int $id the notification number`
	`122`	`+ * @param array $params`
`123`	`123`	`*`
`124`	`124`	`* @return array`
`125`	`125`	`*/`
`@@ -133,7 +133,7 @@ public function createSubscription($id, array $params)`
`133`	`133`	`*`
`134`	`134`	`* @link http://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription`
`135`	`135`	`*`
`136`		`- * @param string $id the notification number`
	`136`	`+ * @param int $id the notification number`
`137`	`137`	`*`
`138`	`138`	`* @return array`
`139`	`139`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function all()`
`28`	`28`	`*`
`29`	`29`	`* @link https://developer.github.com/v3/users/keys/`
`30`	`30`	`*`
`31`		`- * @param string $id`
	`31`	`+ * @param int $id`
`32`	`32`	`*`
`33`	`33`	`* @return array`
`34`	`34`	`*/`
`@@ -62,7 +62,7 @@ public function create(array $params)`
`62`	`62`	`*`
`63`	`63`	`* @link https://developer.github.com/v3/users/keys/`
`64`	`64`	`*`
`65`		`- * @param string $id`
	`65`	`+ * @param int $id`
`66`	`66`	`*`
`67`	`67`	`* @return array`
`68`	`68`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ public function org($organization, $state, array $params = array())`
`104`	`104`	`*`
`105`	`105`	`* @param string $username the username`
`106`	`106`	`* @param string $repository the repository`
`107`		`- * @param string $id the issue number`
	`107`	`+ * @param int $id the issue number`
`108`	`108`	`*`
`109`	`109`	`* @return array information about the issue`
`110`	`110`	`*/`
`@@ -143,7 +143,7 @@ public function create($username, $repository, array $params)`
`143`	`143`	`*`
`144`	`144`	`* @param string $username the username`
`145`	`145`	`* @param string $repository the repository`
`146`		`- * @param string $id the issue number`
	`146`	`+ * @param int $id the issue number`
`147`	`147`	`* @param array $params key=>value user attributes to update.`
`148`	`148`	`* key can be title or body`
`149`	`149`	`*`
`@@ -161,7 +161,7 @@ public function update($username, $repository, $id, array $params)`
`161`	`161`	`*`
`162`	`162`	`* @param string $username`
`163`	`163`	`* @param string $repository`
`164`		`- * @param string $id`
	`164`	`+ * @param int $id`
`165`	`165`	`*`
`166`	`166`	`* @return string`
`167`	`167`	`*/`
`@@ -177,7 +177,7 @@ public function lock($username, $repository, $id)`
`177`	`177`	`*`
`178`	`178`	`* @param string $username`
`179`	`179`	`* @param string $repository`
`180`		`- * @param string $id`
	`180`	`+ * @param int $id`
`181`	`181`	`*`
`182`	`182`	`* @return string`
`183`	`183`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public function all($username, $repository, array $params = array())`
`75`	`75`	`*`
`76`	`76`	`* @param string $username the username`
`77`	`77`	`* @param string $repository the repository`
`78`		`- * @param string $id the ID of the pull request for which details are retrieved`
	`78`	`+ * @param int $id the ID of the pull request for which details are retrieved`
`79`	`79`	`*`
`80`	`80`	`* @return array\|string pull request details`
`81`	`81`	`*/`
`@@ -101,7 +101,7 @@ public function files($username, $repository, $id)`
`101`	`101`	`*`
`102`	`102`	`* @param string $username the username`
`103`	`103`	`* @param string $repository the repository`
`104`		`- * @param string $id the ID of the pull request for which statuses are retrieved`
	`104`	`+ * @param int $id the ID of the pull request for which statuses are retrieved`
`105`	`105`	`*`
`106`	`106`	`* @return array array of statuses for the project`
`107`	`107`	`*/`