feat: add display_name filter to github_external_groups data source#3410
Open
mattias-fjellstrom wants to merge 1 commit into
Conversation
Add an optional display_name argument to the github_external_groups data source. When provided, it filters external groups server-side using the GitHub API's display_name query parameter, reducing the amount of data returned and stored in state. Changes: - Add display_name optional string attribute to data source schema - Pass display_name to ListExternalGroupsOptions when set - Include display_name in resource ID for uniqueness - Add acceptance tests for both filtered and unfiltered queries - Update documentation and add filtered usage example Closes integrations#3409 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an optional
display_nameargument to thegithub_external_groupsdata source. When provided, it filters external groups server-side using the GitHub API'sdisplay_namequery parameter, reducing the amount of data returned and stored in state.Closes #3409
Changes
github/data_source_github_external_groups.go— Addeddisplay_nameoptional string attribute to the schema; passes it toListExternalGroupsOptions.DisplayNamewhen set; includesdisplay_namein the resource ID for uniquenessgithub/data_source_github_external_groups_test.go— New acceptance tests for both filtered and unfiltered queries (gated byskipUnlessEMUEnterprise)examples/data-sources/external_groups/example_2.tf— New example showing filtered usagetemplates/data-sources/external_groups.md.tmpl+docs/data-sources/external_groups.md— Updated documentation with new argument and exampleUsage
Notes
ListExternalGroupsOptionsalready supports theDisplayNamefield — no SDK changes neededdisplay_nameis optional and defaults to no filter