Skip to content

Commit ac5c065

Browse files
committed
Bump v3 API docs version release-candidate
1 parent c8c65d1 commit ac5c065

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

‎version/release-candidate/index.html‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1068,6 +1068,11 @@ <h4 id="buildpack-lifecycle-object">Buildpack lifecycle object</h4>
10681068
<td><em>string</em></td>
10691069
<td>The root filesystem to use with the buildpack, for example <code class="prettyprint">cflinuxfs4</code></td>
10701070
</tr>
1071+
<tr>
1072+
<td><strong>data.credentials</strong></td>
1073+
<td><em>object</em></td>
1074+
<td>Credentials used to download custom buildpacks from private git repositories, keyed by host. Each entry is a username/password pair. If any buildpack URL embeds credentials, <strong>data.credentials</strong> must be empty; provide credentials in one place only.</td>
1075+
</tr>
10711076
</tbody></table>
10721077

10731078
<p>For records whose historical lifecycle data is no longer available,
@@ -1121,7 +1126,7 @@ <h4 id="cloud-native-buildpacks-lifecycle-object">Cloud Native Buildpacks lifecy
11211126
<tr>
11221127
<td><strong>data.credentials</strong></td>
11231128
<td><em>object</em></td>
1124-
<td>Credentials used to download the configured buildpacks. This can either contain username/password or a token.</td>
1129+
<td>Credentials used to download the configured buildpacks, keyed by registry host. Each entry contains either a username/password pair or a token. CNB buildpack URLs must not embed credentials; use <strong>data.credentials</strong> instead.</td>
11251130
</tr>
11261131
<tr>
11271132
<td><strong>data.stack</strong></td>
@@ -11502,6 +11507,16 @@ <h4 id="app-level-configuration"><a name="space-manifest-app-level-configuration
1150211507
<td>a) An empty array, which will automatically select the appropriate default buildpack according to the coding language (incompatible with <strong>lifecycle: cnb</strong>) <br>b) An array of one or more URLs pointing to buildpacks <br>c) An array of one or more installed buildpack names <br>Replaces the legacy <code class="prettyprint">buildpack</code> field</td>
1150311508
</tr>
1150411509
<tr>
11510+
<td><strong>credentials</strong></td>
11511+
<td><em>object</em></td>
11512+
<td>Credentials used to download custom buildpacks (buildpack lifecycle) or buildpack OCI images (cnb lifecycle) from private git repositories or registries, keyed by host. For the buildpack lifecycle each entry is a username/password pair; for the cnb lifecycle each entry is a username/password pair or a token. Set to <code class="prettyprint">null</code> to clear previously stored credentials. If any buildpack URL embeds credentials, <strong>credentials</strong> must be empty; provide credentials in one place only.</td>
11513+
</tr>
11514+
<tr>
11515+
<td><strong>cnb-credentials</strong></td>
11516+
<td><em>object</em></td>
11517+
<td>Backward-compatible alias for <strong>credentials</strong>. Specifying both <strong>credentials</strong> and <strong>cnb-credentials</strong> is an error.</td>
11518+
</tr>
11519+
<tr>
1150511520
<td><strong>docker</strong></td>
1150611521
<td><em>object</em></td>
1150711522
<td>If present, the created app will have Docker lifecycle type; the value of this key is ignored by the API but may be used by clients to source the registry address of the image and credentials, if needed; the <a href="#generate-a-manifest-for-an-app">generate manifest endpoint</a> will return the registry address of the image and username provided with this key</td>

0 commit comments

Comments
 (0)