Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 10e3309

Browse files
v3 Docs: Add section for timestamps
[finishes #173542711] Co-authored-by: Reid Mitchell <rmitchell@pivotal.io> Co-authored-by: Merric de Launey <mdelauney@pivotal.io>
1 parent 666bcd5 commit 10e3309

3 files changed

Lines changed: 12 additions & 1 deletion

File tree

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## Timestamps
2+
3+
Timestamps generally appear in `created_at` and `updated_at` fields on resources. Precision beyond
4+
seconds is not supported, even if the underlying database supports it (e.g. Postgres). As a result,
5+
filtering on sub-second timestamps is not allowed.
6+
7+
All v3 timestamps have the following format `YYYY-MM-DDThh:mm:ssZ`.
8+
9+
Example timestamp (June 30, 2020 at 11:49:04 PM UTC): `2020-06-30T23:49:04Z`
10+

docs/v3/source/includes/resources/audit_events/_list.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Retrieve all audit events the user has access to.
3030

3131
Name | Type | Description
3232
---- | ---- | ------------
33-
**created_at** (*experimental*)| _iso8601 timestamp_ | Timestamp to filter by. Only supports relational operators, see [relational operators](#relational-operators-experimental)
33+
**created_at** (*experimental*)| _[timestamp](#timestamps)_ | Timestamp to filter by. Only supports relational operators, see [relational operators](#relational-operators-experimental)
3434
**types** | _list of strings_ | Comma-delimited list of event types to filter by
3535
**target_guids** | _list of strings_ | Comma-delimited list of target guids to filter by
3636
**space_guids** | _list of strings_ | Comma-delimited list of space guids to filter by

docs/v3/source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ includes:
5555
- concepts/procfiles
5656
- concepts/relationships
5757
- concepts/status_codes
58+
- concepts/timestamps
5859
- concepts/warnings
5960
- resources/header
6061
- resources/admin/header

0 commit comments

Comments
 (0)