Skip to content

Commit 54fc6fa

Browse files
authored
docs(openapi): document lifecycle credentials and custom stacks (#5644)
1 parent 76bae23 commit 54fc6fa

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

‎docs/openapi/apis/cf/latest/components/schemas/Lifecycle.yaml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@ properties:
1515
description: List of the names of buildpacks, URLs from which they may be downloaded, or null to auto-detect a suitable buildpack during staging (applicable for buildpack and cnb lifecycles)
1616
stack:
1717
type: [string, "null"]
18-
description: The root filesystem to use with the buildpack, for example cflinuxfs4 (applicable for buildpack lifecycle)
18+
description: >
19+
The root filesystem to use with buildpack or cnb lifecycles, for example cflinuxfs4.
20+
With the diego_custom_stacks feature flag enabled, this can be a docker:// container image URI (experimental).
1921
credentials:
20-
type: object
22+
type: [object, string, "null"]
2123
additionalProperties:
2224
type: object
2325
properties:
@@ -27,6 +29,6 @@ properties:
2729
type: [string, "null"]
2830
token:
2931
type: string
30-
description: Credentials used to download the configured buildpacks (applicable for cnb lifecycle)
32+
description: Credentials used to download custom buildpacks or pull custom stacks, keyed by host (applicable for buildpack and cnb lifecycles)
3133
description: >
3234
The lifecycle type defines how the application droplet is created and run. The following lifecycle types are supported: - buildpack: Traditional buildpacks for Cloud Foundry applications. - cnb: Cloud Native Buildpacks that are OCI-compliant. - docker: Run pre-built Docker images.

‎docs/openapi/apis/cf/latest/paths/FeatureFlags.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@
8686
- app_scaling
8787
- diego_docker
8888
- diego_cnb
89+
- diego_custom_stacks
8990
- env_var_visibility
9091
- hide_marketplace_from_unauthenticated_users
9192
- private_domain_creation
@@ -142,6 +143,7 @@
142143
- app_scaling
143144
- diego_docker
144145
- diego_cnb
146+
- diego_custom_stacks
145147
- env_var_visibility
146148
- hide_marketplace_from_unauthenticated_users
147149
- private_domain_creation

0 commit comments

Comments
 (0)