Poor instructions for getting starred_at property in stargazers endpoint

[SethFalco]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/activity/starring

What part(s) of the article would you like to see updated?

Currently, it states this:

You can also find out when stars were created by passing the following custom media type via the Accept header:

But then it makes no mention of a value to use, and the page it links to doesn't provide the required header either.

The reason to use is mentioned above, in a previous section. The reality is more users are skimming through to the endpoint they need, so they may miss that and then not know what the docs are referring to.

In my opinion, it should say something more like:

You can also find out when stars were created by passing the custom media type for starring via the Accept header.

(Anchored to the section above via fragment.)

You can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json

(Just specifies the header value they need afterwards.)

Or just underneath where the request data, the accept header should state under it:

Setting to application/vnd.github.star+json is recommended.

Additional information

I wanted to PR this myself, but the only time I see this text occur is in lib/rest/static/*.json which is machine generated. 🤔

Wasn't sure where the source is and if that's accessible or maybe that's just internal GitHub stuff?

[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.

[cmwilson21]

@SethFalco Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

[docubot]

Thank you for opening this issue! Updates to the REST/GraphQL API description must be made internally. I have copied your issue to an internal issue, so I will close this issue.

[cmwilson21]

@SethFalco As docubot says, we will have to make this adjustment internally. Thank you for opening an issue 💛