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.

Sign up for GitHub

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

Jump to bottom

[Docs]: data source aws_route53_zone missing id and name attribute #37908

Closed
wesleung opened this issue Jun 10, 2024 · 5 comments · Fixed by #37994
Closed

[Docs]: data source aws_route53_zone missing id and name attribute #37908

wesleung opened this issue Jun 10, 2024 · 5 comments · Fixed by #37994
Labels
documentation Introduces or discusses updates to documentation. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. service/route53 Issues and PRs that pertain to the route53 service.
Milestone
v5.56.0

Comments

@wesleung
Copy link

wesleung commented Jun 10, 2024 •
edited

Documentation Link

https://registry.terraform.io/providers/hashicorp/aws/5.53.0/docs/data-sources/route53_zone

Description

Missing attribute id for data source aws_route53_zone

This is used when querying for the zone_id of a route53 zone. This functionality does work but not stated in the documentation.

data "aws_route53_zone" "selected" {
  name         = "test.com."
}

output "zone_id" {
  value = data.aws_route53_zone.id
}

output "zone_name" {
  value = data.aws_route53_zone.name
}

References

No response

Would you like to implement a fix?

None
@wesleung wesleung added the documentation Introduces or discusses updates to documentation. label Jun 10, 2024
@github-actions GitHub Actions
Copy link

Community Note

Voting for Prioritization

  • Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this 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.

Volunteering to Work on This Issue

  • If you are interested in working on this issue, please leave a comment.
  • If this would be your first contribution, please review the contribution guide.

@github-actions github-actions bot added the service/route53 Issues and PRs that pertain to the route53 service. label Jun 10, 2024
@terraform-aws-provider terraform-aws-provider bot added the needs-triage Waiting for first response or review from a maintainer. label Jun 10, 2024
@wesleung wesleung changed the title [Docs]: data source aws_route53_zone missing id attribute [Docs]: data source aws_route53_zone missing id and name attribute Jun 10, 2024
@justinretzolk justinretzolk added good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. and removed needs-triage Waiting for first response or review from a maintainer. labels Jun 11, 2024
@stefanfreitag
Copy link

I can pick this up, but would need clarification before:

  • the documentation for the data resource states under section Attribute Reference:

    All of the argument attributes are also exported as result attributes.

    One can find details on name in the Argument Reference. So, is an additional entry for name under Attribute Reference really required?

  • For the id field - as it maps to the already documented Zone Identifier (link to source code): should we add a line to the existing Zone Identifier documentation or explicitly add id to the Attribute Reference? I checked other resources but could not identify a pattern.

@wesleung
Copy link
Author

I didn't read the paragraph below, I wonder how many other terraform programmers run into the same problem.

I wanted to query for the Zone ID and I knew I could do that, but when I glanced at the docs and it wasn't listed in the attributes section I was confused as I knew I did this before. I looked at my old code to confirm.

Other data sources generally do not have that additional paragraph. I would prefer to remove the paragraph and add the arguments listed to the attribute section. But this is more of a personal preference. I leave it up to you what you want to do about the reference documentation.

@stefanfreitag
Copy link

@justinretzolk is there any kind of standard to follow?

This was referenced Jun 15, 2024
Merged
Open
@github-actions GitHub Actions
Copy link

Warning

This issue has been closed, meaning that any additional comments are hard for our team to see. Please assume that the maintainers will not see them.

Ongoing conversations amongst community members are welcome, however, the issue will be locked after 30 days. Moving conversations to another venue, such as the AWS Provider forum, is recommended. If you have additional concerns, please open a new issue, referencing this one where needed.

@github-actions github-actions bot added this to the v5.56.0 milestone Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Introduces or discusses updates to documentation. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. service/route53 Issues and PRs that pertain to the route53 service.
Projects
None yet
Milestone
v5.56.0
Development

Successfully merging a pull request may close this issue.

doc: add fields to attribute reference of route53 zone data stefanfreitag/terraform-provider-aws
3 participants
@wesleung @stefanfreitag @justinretzolk