Skip to content

Commit c93ad65

Browse files
committed
Edit docs
1 parent 0f5f84f commit c93ad65

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed

docs/data-sources/project_milestone.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ data "gitlab_project_milestone" "example" {
3434

3535
### Required
3636

37-
- `milestone_id` (Number) The ID of the project’s milestone in Gitlab DB.
37+
- `milestone_id` (Number) The global ID of the project’s milestone.
3838
- `project_id` (String) The ID or URL-encoded path of the project owned by the authenticated user.
3939

4040
### Optional
@@ -43,15 +43,15 @@ data "gitlab_project_milestone" "example" {
4343

4444
### Read-Only
4545

46-
- `created_at` (String) The time of creation of the milestone.
46+
- `created_at` (String) The time of creation of the milestone. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.
4747
- `description` (String) The description of the milestone.
48-
- `due_date` (String) The due date of the milestone.
48+
- `due_date` (String) The due date of the milestone. Date time string in the format YYYY-MM-DD, for example 2016-03-11.
4949
- `expired` (Boolean) Bool, true if milestore expired.
50-
- `iid` (Number) The ID of the project’s milestone.
51-
- `start_date` (String) The start date of the milestone.
50+
- `iid` (Number) The ID of the milestone only in one project.
51+
- `start_date` (String) The start date of the milestone. Date time string in the format YYYY-MM-DD, for example 2016-03-11.
5252
- `state` (String) The state of the milestone. Valid values are: `active`, `closed`.
5353
- `title` (String) The title of a milestone.
54-
- `updated_at` (String) The last update time of the milestone.
54+
- `updated_at` (String) The last update time of the milestone. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.
5555
- `web_url` (String) The web URL of the milestone.
5656

5757

docs/resources/project_milestone.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,19 @@ resource "gitlab_project_milestone" "example" {
3939

4040
### Optional
4141

42-
- `created_at` (String) The time of creation of the milestone.
42+
- `created_at` (String) The time of creation of the milestone. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.
4343
- `description` (String) The description of the milestone.
44-
- `due_date` (String) The due date of the milestone.
44+
- `due_date` (String) The due date of the milestone. Date time string in the format YYYY-MM-DD, for example 2016-03-11.
4545
- `id` (String) The ID of this resource.
46-
- `start_date` (String) The start date of the milestone.
46+
- `start_date` (String) The start date of the milestone. Date time string in the format YYYY-MM-DD, for example 2016-03-11.
4747
- `state` (String) The state of the milestone. Valid values are: `active`, `closed`.
48-
- `updated_at` (String) The last update time of the milestone.
48+
- `updated_at` (String) The last update time of the milestone. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.
4949

5050
### Read-Only
5151

5252
- `expired` (Boolean) Bool, true if milestore expired.
53-
- `iid` (Number) The ID of the project’s milestone.
54-
- `milestone_id` (Number) The ID of the project’s milestone in Gitlab DB.
53+
- `iid` (Number) The ID of the milestone only in one project.
54+
- `milestone_id` (Number) The global ID of the project’s milestone.
5555
- `web_url` (String) The web URL of the milestone.
5656

5757
## Import

internal/provider/schema_gitlab_project_milestone.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ func gitlabProjectMilestoneGetSchema() map[string]*schema.Schema {
1414

1515
return map[string]*schema.Schema{
1616
"iid": {
17-
Description: "The ID of the project’s milestone.",
17+
Description: "The ID of the milestone only in one project.",
1818
Type: schema.TypeInt,
1919
Computed: true,
2020
},
2121
"milestone_id": {
22-
Description: "The ID of the project’s milestone in Gitlab DB.",
22+
Description: "The global ID of the project’s milestone.",
2323
Type: schema.TypeInt,
2424
Computed: true,
2525
},
@@ -40,19 +40,19 @@ func gitlabProjectMilestoneGetSchema() map[string]*schema.Schema {
4040
Optional: true,
4141
},
4242
"due_date": {
43-
Description: "The due date of the milestone.",
43+
Description: "The due date of the milestone. Date time string in the format YYYY-MM-DD, for example 2016-03-11.",
4444
Type: schema.TypeString,
4545
Optional: true,
4646
ValidateDiagFunc: isISO6801Date,
4747
},
4848
"start_date": {
49-
Description: "The start date of the milestone.",
49+
Description: "The start date of the milestone. Date time string in the format YYYY-MM-DD, for example 2016-03-11.",
5050
Type: schema.TypeString,
5151
Optional: true,
5252
ValidateDiagFunc: isISO6801Date,
5353
},
5454
"updated_at": {
55-
Description: "The last update time of the milestone.",
55+
Description: "The last update time of the milestone. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.",
5656
Type: schema.TypeString,
5757
Computed: true,
5858
Optional: true,
@@ -61,7 +61,7 @@ func gitlabProjectMilestoneGetSchema() map[string]*schema.Schema {
6161
ValidateDiagFunc: validation.ToDiagFunc(validation.IsRFC3339Time),
6262
},
6363
"created_at": {
64-
Description: "The time of creation of the milestone.",
64+
Description: "The time of creation of the milestone. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z.",
6565
Type: schema.TypeString,
6666
Computed: true,
6767
Optional: true,

0 commit comments

Comments
 (0)