hashicorp / terraform-provider-time

Utility provider that provides Time-Based Resources
https://registry.terraform.io/providers/hashicorp/time/latest
Mozilla Public License 2.0
105 stars 30 forks source link

Update docs on the id attribute #359

Open Thomsen96 opened 1 month ago

Thomsen96 commented 1 month ago

Terraform CLI and Provider Versions

provider "registry.terraform.io/hashicorp/time" { version = "0.12.1" constraints = "<= 1.0.0" hashes = [ ... ] }

Use Cases or Problem Statement

I used the id of the resource as it weren't clear to me that it were the time stamp from creation and not the offset.

So for me and other users in the future to not make this mistake, am i suggesting this change.

Proposal

commit bf7229839dddd1e54d2bc504d8e18e2ad52385b3
Author: Jonas Thomsen <jonastoftehomsen@gmail.com>
Date:   Wed Oct 9 10:46:01 2024 +0200

    Avoid confusion on the id attribute versus the rfc3339 attribute

diff --git a/docs/resources/offset.md b/docs/resources/offset.md
index 05875a1..8731668 100644
--- a/docs/resources/offset.md
+++ b/docs/resources/offset.md
@@ -81,7 +81,7 @@ resource "aws_instance" "server" {

 - `day` (Number) Number day of offset timestamp.
 - `hour` (Number) Number hour of offset timestamp.
-- `id` (String) RFC3339 format of the offset timestamp, e.g. `2020-02-12T06:36:13Z`.
+- `id` (String) RFC3339 format of the resource creation timestamp, e.g. `2020-02-12T06:36:13Z`.
 - `minute` (Number) Number minute of offset timestamp.
 - `month` (Number) Number month of offset timestamp.
 - `rfc3339` (String) RFC3339 format of the offset timestamp, e.g. `2020-02-12T06:36:13Z`.

How much impact is this issue causing?

Low

Additional Information

No response

Code of Conduct