Skip to content

Commit 83cedaa

Browse files
committed
Revise date-time naming guidance to use At suffix
1 parent eefd5d1 commit 83cedaa

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

azure/ConsiderationsForServiceDesign.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -116,17 +116,9 @@ For example, `collectedItems` not `itemsCollected`
116116

117117
For example, `nextUrl` not `nextURL`.
118118

119-
:ballot_box_with_check: **YOU SHOULD** use "DateTime" suffix in names of `date-time` values.
119+
:ballot_box_with_check: **YOU SHOULD** use an "At" suffix in names of `date-time` values.
120120

121-
For example, `createdDateTime` not `createdAt` or `createdTime`. Common date-time properties and their recommended names are:
122-
123-
| Property Name | Description |
124-
| --- | --- |
125-
| createdDateTime | The date and time the resource was created. |
126-
| lastModifiedDateTime | The date and time the resource was last modified. |
127-
| deletedDateTime | The date and time the resource was deleted. |
128-
| startDateTime | The starting date and time of an interval. |
129-
| endDateTime | The ending date and time of an interval. |
121+
For example, `createdAt` not `created` or `createdDateTime`.
130122

131123
:ballot_box_with_check: **YOU SHOULD** use a suffix of the unit of measurement for values with a clear unit of measurement (such as bytes, miles, and so on). Use a generally accepted abbreviation for the units (e.g. "Km" rather than "Kilometers") when appropriate.
132124

@@ -152,8 +144,9 @@ The following are recommended names for properties that match the associated des
152144

153145
| Name | Description |
154146
|------------- | --- |
155-
| createdDateTime | The date-time that the resource was created |
156-
| updatedDateTime | The date-time that the resource was last updated/modified |
147+
| createdAt | The date and time the resource was created. |
148+
| lastModifiedAt | The date and time the resource was last modified. |
149+
| deletedAt | The date and time the resource was deleted. |
157150
| kind | The discriminator value for a polymorphic resource |
158151

159152
### `name` vs `id`

0 commit comments

Comments
 (0)