docs icon indicating copy to clipboard operation
docs copied to clipboard

Mismatching types descriptions

Open liloven opened this issue 1 year ago • 4 comments

Code of Conduct

What article on docs.github.com is affected?

https://github.com/github/docs/blob/main/content/rest/using-the-rest-api/github-event-types.md

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

In the section "Event object common properties", the Event API attribute name id of the objects repo, actor and org describes the that the relative types are presented as string instead of integer.

The doc should be change to be a representation of the real scenario of these attribute types.

Additional information

No response

liloven avatar Aug 20 '24 01:08 liloven

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.

welcome[bot] avatar Aug 20 '24 01:08 welcome[bot]

⚡️ Received Bonus

Mehran0029 avatar Aug 20 '24 06:08 Mehran0029

EQBClCK3uH9OsYgTgiABIDSLbm9JqakxQXu1ZA4LrXlfcSGs

Mehran0029 avatar Aug 20 '24 06:08 Mehran0029

@fornazierr Thank you for opening an issue! I'll get this triaged for review ✨

nguyenalex836 avatar Aug 20 '24 18:08 nguyenalex836

Hi @fornazierr 👋🏻

Thanks for flagging this discrepancy. I looked in the schema and you're right about these three identifiers. The Event API attribute id of the objects repo, actor and org are all of type integer.

felicitymay avatar Sep 02 '24 15:09 felicitymay