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

Improve doc accuracy for aws_vpc_security_group_ingress_rule and `a… #32148

Merged

Conversation

mattburgess
Copy link
Collaborator

@mattburgess mattburgess commented Jun 21, 2023

…ws_vpc_security_group_egress_rule`

  • ip_protocol was marked as Required in the schema but Optional in the docs
  • security_group_id is Required but was Optional in the schema
  • Try to clarify the situations where Optional arguments are actually Required

Description

Relations

Closes #29895
Closes #32089
Relates #29893

References

Note that although this technically includes what looks like a breaking change, it's impossible for practitioners to create security group rules without specifying a security group ID so this is actually just a quality-of-life improvement by getting early validation feedback without waiting for the AWS API call to be made.

Output from Acceptance Testing

$ make testacc TESTS=TestAccXXX PKG=ec2

...

@github-actions
Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added size/XS Managed by automation to categorize the size of a PR. documentation Introduces or discusses updates to documentation. service/vpc Issues and PRs that pertain to the vpc service. needs-triage Waiting for first response or review from a maintainer. labels Jun 21, 2023
…ws_vpc_security_group_egress_rule`

* `ip_protocol` was marked as `Required` in the schema but `Optional` in the docs
* `security_group_id` is `Required` but was `Optional` in the schema
* Try to clarify the situations where `Optional` arguments are actually `Required`
* Make examples less confusing by using a single port; using different ports makes it look like some kind of port mapping
@mattburgess mattburgess force-pushed the update-security-group-rule-docs branch from bdf5995 to ee8af4f Compare June 21, 2023 21:13
Copy link
Member

@justinretzolk justinretzolk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've got a couple of minor suggestions, but overall this looks great to me. Thanks for taking the time to do this!

I saw you'd discussed this a bit on #32089 too. I'm happy to add the commits, but based on what you'd already looked at, could we update the aws_security_group resource documentation with what you've already written here?

@justinretzolk justinretzolk removed the needs-triage Waiting for first response or review from a maintainer. label Jun 21, 2023
@mattburgess mattburgess force-pushed the update-security-group-rule-docs branch from 51db979 to 571a5d8 Compare June 21, 2023 23:13
@mattburgess
Copy link
Collaborator Author

I've got a couple of minor suggestions, but overall this looks great to me. Thanks for taking the time to do this!

I saw you'd discussed this a bit on #32089 too. I'm happy to add the commits, but based on what you'd already looked at, could we update the aws_security_group resource documentation with what you've already written here?

Sure, I've also updated aws_security_group_rule too. Thanks for the super quick review!

@justinretzolk justinretzolk merged commit 43290b2 into hashicorp:main Jun 26, 2023
@github-actions github-actions bot added this to the v5.6.0 milestone Jun 26, 2023
@github-actions
Copy link

This functionality has been released in v5.6.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 30, 2023
@justinretzolk justinretzolk added the external-maintainer Contribution from a trusted external contributor. label Jul 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. external-maintainer Contribution from a trusted external contributor. service/vpc Issues and PRs that pertain to the vpc service. size/XS Managed by automation to categorize the size of a PR.
Projects
None yet
3 participants