Confusing parameter description in REST API docs for /users

[abhijit-hota]

What is the current behavior?

I was browsing through the REST API docs for Users and I couldn't quite get this piece of description (bordered in orange):

What changes are you suggesting?

I think the parameter description for since is confusing/wrong and should be corrected.

Additional information

Opened a discussion here and came to know that it was an issue.
Edit: As @felicitymay described here, the type pf since might also be wrong.

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[runleonarun]

Nice catch, @abhijit-hota! The since parameter should be an integer and it should say something like, "The ID of the user where you want to begin the list of users."

Note that we need to fix this issue in an internal repo, but we will report back here when its fixed!

[abhijit-hota]

Thanks!

The since parameter should be an integer and it should say something like, "The ID of the user where you want to begin the list of users."

Yep. Got it. My two cents:

The word since is used in context of time and that's the reason I did not doubt the timestamp type.
But, the input is an ID. So IMO, it should be something like from or fromID to avoid confusion. (I'm not suggesting the change to the docs team but to the API developers although changing the API may break some applications that use this param. 😅)

but we will report back here when its fixed!

Great!

[skedwards88]

https://github.com/github/docs-content/issues/3116 will address this as well as the other places where the since parameter is mis-documented. I am closing this issue to avoid duplication. Thank you for bringing it to our attention!

The word since is used in context of time and that's the reason I did not doubt the timestamp type.
But, the input is an ID. So IMO, it should be something like from or fromID to avoid confusion. (I'm not suggesting the change to the docs team but to the API developers although changing the API may break some applications that use this param. 😅)

Great suggestion! I I have created an issue for the API team.