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(data_source_github_organization): update users shape #2206

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

omsmith
Copy link

@omsmith omsmith commented Mar 22, 2024

Updates the shape of the user objects on the github_organization data source to better match that of the github_user data source.

Particularly, exposing the database_id allows this user list to drive some other resources (such as github_repository_environment.reviewers) which require numeric ids without additional github_user data sources.

  • Adds new node_id property for the GraphQL Node ID
  • Deprecates id property in favour of using node_id
  • Adds new database_id property which exposes the integer id of the user

Proposal is for v7 to switch id to the integer id, deprecating database_id. v8 would then drop database_id.

Resolves #2207


Before the change?

After the change?

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No (To the best of my knowledge)

Updates the shape of the user objects on the github_organization data
source to better match that of the github_user data source.

Particularly, exposing the database_id allows this user list to drive
some other resources (such as github_repository_environment.reviewers)
which require numeric ids without additional github_user data sources.

* Adds new node_id property for the GraphQL Node ID
* Deprecates id property in favour of using node_id
* Adds new database_id property which exposes the integer id of the
  user

Proposal is for v7 to switch id to the integer id, deprecating
database_id. v8 would then drop database_id.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG]: data.github_organization.my_org.users[*].id is unexpectedly a Node ID
1 participant