Skip to content

Commit

Permalink
Relax naming convention for date/time properties
Browse files Browse the repository at this point in the history
As discussed in the guild meeting 2024-06-11. Not all date/time properties should have the `_at` suffix.
  • Loading branch information
tfrauenstein authored Jun 11, 2024
1 parent 8ba7497 commit 1c47b0a
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions chapters/json-guidelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -146,21 +146,18 @@ declaring possible values for a <<137,rule 137>> [`sort` parameter].


[#235]
== {SHOULD} name date/time properties with `_at` suffix
== {SHOULD} use naming convention for date/time properties

Dates and date-time properties should end with `_at` to distinguish them from
boolean properties which otherwise would have very similar or even identical
names:
Naming of date and data-time properties should comply with the following convention:
The name either (i) contains `date`, `day`, `time`, `timestamp` or similar type indicators,
or (ii) end with the `_at` suffix. The convention allows easy identification of date/time
typed properties and distinguishing them e.g. from boolean properties like `created` vs. `created_at`.
Examples of valid date/time property names:

- {created_at} rather than {created},
- {modified_at} rather than {modified},
- `occurred_at` rather than `occurred`, and
- `returned_at` rather than `returned`.
- `created_at`, `modified_at`, `occurred_at`, `returned_at` -- instead of `created`, `modified`, ...
- `campaign_start_time`, `arrival_date`, `checkout_time` -- instead of `campaign_start`, `arrival`, ...

**Hint:** Use `format: date-time` (or as `format: date`) as required in <<238>>.

**Note:** {created} and {modified} were mentioned in an earlier version of the
guideline and are therefore still accepted for APIs that predate this rule.
**Hint:** Use `format: date-time` or `format: date` as required in <<238>>.


[#216]
Expand Down

0 comments on commit 1c47b0a

Please sign in to comment.