Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Event API docs mention field which does not exist for CommitCommentEvent #3190

Closed
wayofthepie opened this issue Jan 26, 2021 · 2 comments
Closed
Labels
content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team

Comments

@wayofthepie
Copy link

wayofthepie commented Jan 26, 2021

What article on docs.github.com is affected?

https://docs.github.com/en/developers/webhooks-and-events/github-event-types#commitcommentevent

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

The docs mention that a CommitCommentEvent should contain an action when retrieved via the events API's. However, the action is only available on webhooks and never appears when you are retrieving from an events API. I'm not sure if this is an issue with the docs, and the docs should say this field is only available in webhooks, or if this is a bug in the model for this event in the events API. Thanks.

Additional information

Example event from /events:

{
  "id": "14949432760",
  "type": "CommitCommentEvent",
 
  "payload": {
    "comment": {
      
    }
  },
  "public": true,
  "created_at": "2021-01-26T11:31:43Z"
}

The payload field has no action. Example from webhooks:

{
  "action": "created",
  "comment": {
    
  }
}

This does have the action.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 26, 2021
@janiceilene
Copy link
Contributor

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

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team and removed triage Do not begin working on this issue until triaged by the team labels Jan 26, 2021
@janiceilene
Copy link
Contributor

Thank so much @wayofthepie! Sorry about the delayed response, I talked to some folks and it sounds like this would be best handled by our wonderful support team!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team
Projects
None yet
Development

No branches or pull requests

2 participants