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

Commit 2eba3fd

Browse files
v3 Docs: link to timestamp section when referring to datetime
[#173542711] Co-authored-by: Reid Mitchell <rmitchell@pivotal.io> Co-authored-by: Merric de Launey <mdelauney@pivotal.io>
1 parent 10e3309 commit 2eba3fd

33 files changed

Lines changed: 67 additions & 67 deletions

File tree

docs/v3/source/includes/concepts/_api_resource.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Example Person Resource
3030
Name | Type | Description
3131
---- | ---- | -----------
3232
**guid** | _uuid_ | The unique identifier for the resource
33-
**created_at** | _datetime_ | The ISO8601 compatible date and time when resource was created
34-
**updated_at** | _datetime_ | The ISO8601 compatible date and time when resource was last updated
33+
**created_at** | _[timestamp](#timestamps)_ | The ISO8601 compatible date and time when resource was created
34+
**updated_at** | _[timestamp](#timestamps)_ | The ISO8601 compatible date and time when resource was last updated
3535
**links** | [_links object_](#links) | URLs to related resources and actions for the current resource
3636

3737

docs/v3/source/includes/experimental_resources/revisions/_object.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Name | Type | Description
1414
**droplet** | _object_ | The droplet used by a process running the revision
1515
**processes** | [_process snapshot object_](#the-process-snapshot-object) | An object representing process types at this revision
1616
**sidecars** | _array of [sidecar snapshot objects](#the-sidecar-snapshot-object)_ ]| The array of sidecars used by processes running the revision
17-
**created_at** | _datetime_ | The time with zone when the object was created
18-
**updated_at** | _datetime_ | The time with zone when the object was last updated
17+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
18+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
1919
**description** | _string_ | A short description of the reason for revision
2020
**deployable** _(experimental)_ | _boolean_ | Indicates if the revision's droplet is staged and the revision can be used to [create a deployment](#create-a-deployment)
2121
**relationships.app** | [_to-one relationship_](#to-one-relationships) | The app the revision is associated with

docs/v3/source/includes/experimental_resources/service_bindings/_object.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ Name | Type | Description
1212
**type** | _string_ | Service binding type; valid value is `app`
1313
**data** | _object_ | Data returned from the service broker for the service instance; valid values are `credentials`, `syslog_drain_url` and (experimental) `volume_mounts`
1414
**guid** | _uuid_ | Unique identifier for the service binding
15-
**created_at** | _datetime_ | The time with zone when the object was created
16-
**updated_at** | _datetime_ | The time with zone when the object was last updated
15+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
16+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
1717
**links** | [_links object_](#links) | Links to related resources

docs/v3/source/includes/experimental_resources/sidecars/_object.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ Name | Type | Description
1616
**memory_in_mb** | _integer_ | Reserved memory for sidecar
1717
**origin** | _string_ | Specifies whether the sidecar was created by the user or via the buildpack
1818
**relationships.app** | [_to-one relationship_](#to-one-relationships) | The app the sidecar is associated with
19-
**created_at** | _datetime_ | The time with zone when the object was created
20-
**updated_at** | _datetime_ | The time with zone when the object was last updated
19+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
20+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated

docs/v3/source/includes/resources/app_usage_events/_object.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Example App Usage Event object
1010
Name | Type | Description
1111
---- | ---- | -----------
1212
**guid** | _uuid_ | Unique identifier for the event
13-
**created_at** | _datetime_ | The time with zone when the event occurred
14-
**updated_at** | _datetime_ | Identical to `created_at` (events are created, never updated)
13+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the event occurred
14+
**updated_at** | _[timestamp](#timestamps)_ | Identical to `created_at` (events are created, never updated)
1515
**state.current** | _string_ or `null` | Current state of the app that this event pertains to, if applicable
1616
**state.previous** | _string_ or `null` | Previous state of the app that this event pertains to, if applicable
1717
**app.guid** | _string_ or `null` | Unique identifier of the app that this event pertains to, if applicable

docs/v3/source/includes/resources/apps/_object.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Example App object
1010
Name | Type | Description
1111
---- | ---- | -----------
1212
**guid** | _uuid_ | Unique identifier for the app
13-
**created_at** | _datetime_ | The time with zone when the object was created
14-
**updated_at** | _datetime_ | The time with zone when the object was last updated
13+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
14+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
1515
**name** | _string_ | Name of the app
1616
**state** | _string_ | Current desired state of the app; valid values are `STOPPED` or `STARTED`
1717
**lifecycle** | [_lifecycle object_](#the-lifecycle-object) | Provides the default lifecycle object for the application. This lifecycle will be used when staging and running the application. The staging lifecycle can be overridden on [builds](#builds)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Example Audit Event object
1010
Name | Type | Description
1111
---- | ---- | -----------
1212
**guid** | _uuid_ | Unique identifier for the event
13-
**created_at** | _datetime_ | The time with zone when the object was created
14-
**updated_at** | _datetime_ | The time with zone when the object was last updated
13+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
14+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
1515
**type** | _string_ | The type of the event
1616
**actor.guid** | _string_ | Unique identifier for the actor (user or system resource that performed the action)
1717
**actor.type** | _string_ | The actor type

docs/v3/source/includes/resources/buildpacks/_object.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Example Buildpack object
1111
Name | Type | Description
1212
-------------- | ------------------------ | ------------------------------------------------------
1313
**guid** | _uuid_ | Unique identifier for the buildpack
14-
**created_at** | _datetime_ | The time with zone when the object was created
15-
**updated_at** | _datetime_ | The time with zone when the object was last updated
14+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
15+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
1616
**name** | _string_ | The name of the buildpack; to be used by app buildpack field (only alphanumeric characters)
1717
**state** | _string_ | The state of the buildpack Valid value is: `AWAITING_UPLOAD`
1818
**stack** | _string_ | The name of the stack that the buildpack will use

docs/v3/source/includes/resources/builds/_object.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Example Build object
1010
Name | Type | Description
1111
---- | ---- | -----------
1212
**guid** | _uuid_ | Unique identifier for the build
13-
**created_at** | _datetime_ | The time with zone when the build was created
14-
**updated_at** | _datetime_ | The time with zone when the build was last updated
13+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the build was created
14+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the build was last updated
1515
**state** | _string_ | State of the build; valid states are `STAGING`, `STAGED`, or `FAILED`
1616
**error** | _string_ | A string describing errors during the build process
1717
**lifecycle** | [_lifecycle object_](#the-lifecycle-object) | Provides the lifecycle object to use during staging; this will override the build's application's default lifecycle for this build

docs/v3/source/includes/resources/deployments/_object.md.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Example Deployment object
1010
Name | Type | Description
1111
---- | ---- | -----------
1212
**guid** | _uuid_ | Unique identifier for the deployment
13-
**created_at** | _datetime_ | The time with zone when the object was created
14-
**updated_at** | _datetime_ | The time with zone when the object was last updated
13+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
14+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
1515
**state** | _string_ | **(deprecated)** This field will be removed in the future; use the `status` fields to determine deployment state instead
1616
**status.value** | _string_ | The current status of the deployment; valid values are `ACTIVE` (meaning in progress) and `FINALIZED` (meaning finished, either successfully or not)
1717
**status.reason** | _string_ | The reason for the status of the deployment;<br>following list represents valid values:<br>1. If **status.value** is `ACTIVE`<br>- `DEPLOYING`<br>- `CANCELING`<br>2. If **status.value** is `FINALIZED`<br>- `DEPLOYED`<br>- `CANCELED`<br>- `SUPERSEDED` (another deployment created for app before completion)<br>- `DEGENERATE` (the deployment was created incorrectly by the system)

0 commit comments

Comments
 (0)