Skip to content

Commit

Permalink
Add docs for staged_memory_in_mb and staged_disk_in_mb in builds
Browse files Browse the repository at this point in the history
Co-authored-by: Seth Boyles <sboyles@pivotal.io>
Co-authored-by: Teal Stannard <tstannard@pivotal.io>
  • Loading branch information
sethboyles and Teal Stannard committed Jun 9, 2021
1 parent 248cb6e commit 83913d2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/v3/source/includes/api_resources/_builds.erb
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
"email": "bill@example.com"
},
"state": "STAGING",
"staging_memory_in_mb": 1024,
"staging_disk_in_mb": 1024,
"error": null,
"lifecycle": {
"type": "buildpack",
Expand Down Expand Up @@ -70,6 +72,8 @@
"email": "bill@example.com"
},
"state": "STAGING",
"staging_memory_in_mb": 1024,
"staging_disk_in_mb": 1024,
"error": null,
"lifecycle": {
"type": "buildpack",
Expand Down Expand Up @@ -115,6 +119,8 @@
"email": "bill@example.com"
},
"state": "STAGED",
"staging_memory_in_mb": 1024,
"staging_disk_in_mb": 1024,
"error": null,
"lifecycle": {
"type": "buildpack",
Expand Down
2 changes: 2 additions & 0 deletions docs/v3/source/includes/resources/builds/_object.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Name | Type | Description
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the build was created
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the build was last updated
**state** | _string_ | State of the build; valid states are `STAGING`, `STAGED`, or `FAILED`
**staging_memory_in_mb** | _integer_ | Memory in MB allocated for staging of the build
**staging_disk_in_mb** | _integer_ | Disk space in MB allocated for staging of the build
**error** | _string_ | A string describing errors during the build process
**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
**package.guid** | _string_ | The package that is the input to the staging process
Expand Down

0 comments on commit 83913d2

Please sign in to comment.