From be7a38cc36c39556abdb9f07fe76082fab7bc76b Mon Sep 17 00:00:00 2001 From: Mervin Nirmal John M W Date: Wed, 21 Jan 2026 15:21:25 +0530 Subject: [PATCH 1/4] Update openapi schema changes of Deployment and Processes --- .../latest/components/schemas/Deployment.yaml | 25 ++++++++++++++ apis/cf/latest/paths/Deployments.yaml | 33 +++++++++++++++++++ apis/cf/latest/paths/Processes.yaml | 14 ++++---- 3 files changed, 66 insertions(+), 6 deletions(-) diff --git a/apis/cf/latest/components/schemas/Deployment.yaml b/apis/cf/latest/components/schemas/Deployment.yaml index 3261efe..49c26a4 100644 --- a/apis/cf/latest/components/schemas/Deployment.yaml +++ b/apis/cf/latest/components/schemas/Deployment.yaml @@ -44,6 +44,31 @@ allOf: max_in_flight: type: integer description: The maximum number of new instances to deploy simultaneously + web_instances: + type: integer + description: The number of instances for the web process of the new droplet + memory_in_mb: + type: integer + description: The amount of memory in megabytes to allocate for the web process + disk_in_mb: + type: integer + description: The amount of disk space in megabytes to allocate for the web process + log_rate_limit_in_bytes_per_second: + type: integer + description: The log rate limit in bytes per second for the web process. A value of -1 indicates unlimited, 0 prevents any logs from being emitted. + canary: + type: object + description: Configuration for canary deployments. Present when strategy is 'canary'. + properties: + steps: + type: array + description: Array of steps defining the canary deployment progression + items: + type: object + properties: + instance_weight: + type: integer + description: The number of instances to deploy at this step droplet: type: object properties: diff --git a/apis/cf/latest/paths/Deployments.yaml b/apis/cf/latest/paths/Deployments.yaml index b27b47b..1ddfedf 100644 --- a/apis/cf/latest/paths/Deployments.yaml +++ b/apis/cf/latest/paths/Deployments.yaml @@ -96,6 +96,39 @@ enum: - rolling - canary + options: + type: object + properties: + max_in_flight: + type: integer + description: The maximum number of instances that will be deployed simultaneously + default: 1 + minimum: 1 + web_instances: + type: integer + description: The number of instances for the web process of the new droplet + memory_in_mb: + type: integer + description: The amount of memory in megabytes to allocate for the web process + disk_in_mb: + type: integer + description: The amount of disk space in megabytes to allocate for the web process + log_rate_limit_in_bytes_per_second: + type: integer + description: The log rate limit in bytes per second for the web process. A value of -1 indicates unlimited, 0 prevents any logs from being emitted. + canary: + type: object + description: Configuration for canary deployments. Required when strategy is 'canary'. + properties: + steps: + type: array + description: Array of steps defining the canary deployment progression + items: + type: object + properties: + instance_weight: + type: integer + description: The number of instances to deploy at this step droplet: $ref: '../components/schemas/Relationship.yaml' revision: diff --git a/apis/cf/latest/paths/Processes.yaml b/apis/cf/latest/paths/Processes.yaml index 1cddf91..bc8e41b 100644 --- a/apis/cf/latest/paths/Processes.yaml +++ b/apis/cf/latest/paths/Processes.yaml @@ -189,22 +189,22 @@ type: - integer - 'null' - - string + description: The number of instances to run memory_in_mb: type: - integer - 'null' - - string + description: The memory in MB allocated per instance disk_in_mb: type: - integer - 'null' - - string + description: The disk in MB allocated per instance log_rate_limit_in_bytes_per_second: type: - integer - 'null' - - string + description: The log rate limit in bytes per second per instance responses: '202': description: Accepted @@ -395,20 +395,22 @@ type: - integer - 'null' - - string + description: The number of instances to run memory_in_mb: type: - integer - 'null' - - string + description: The memory in MB allocated per instance disk_in_mb: type: - integer - 'null' + description: The disk in MB allocated per instance log_rate_limit_in_bytes_per_second: type: - integer - 'null' + description: The log rate limit in bytes per second per instance responses: '202': description: Accepted From 97f69be3693e12ac42a1089339b4bb730419b46d Mon Sep 17 00:00:00 2001 From: Sam Gunaratne <385176+Samze@users.noreply.github.com> Date: Wed, 21 Jan 2026 09:44:49 -0700 Subject: [PATCH 2/4] Update apis/cf/latest/components/schemas/Deployment.yaml --- apis/cf/latest/components/schemas/Deployment.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apis/cf/latest/components/schemas/Deployment.yaml b/apis/cf/latest/components/schemas/Deployment.yaml index 49c26a4..fb28d35 100644 --- a/apis/cf/latest/components/schemas/Deployment.yaml +++ b/apis/cf/latest/components/schemas/Deployment.yaml @@ -68,7 +68,7 @@ allOf: properties: instance_weight: type: integer - description: The number of instances to deploy at this step + description: The percentage of instances to be deployed as part of the canary process in this step droplet: type: object properties: From 4a36bb9bf159600d251046035d5eb6b36ad2b617 Mon Sep 17 00:00:00 2001 From: Sam Gunaratne <385176+Samze@users.noreply.github.com> Date: Wed, 21 Jan 2026 09:44:54 -0700 Subject: [PATCH 3/4] Update apis/cf/latest/paths/Deployments.yaml --- apis/cf/latest/paths/Deployments.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apis/cf/latest/paths/Deployments.yaml b/apis/cf/latest/paths/Deployments.yaml index 1ddfedf..24c66ee 100644 --- a/apis/cf/latest/paths/Deployments.yaml +++ b/apis/cf/latest/paths/Deployments.yaml @@ -128,7 +128,7 @@ properties: instance_weight: type: integer - description: The number of instances to deploy at this step + description: The percentage of instances to be deployed as part of the canary process in this step droplet: $ref: '../components/schemas/Relationship.yaml' revision: From 443905ef16cab294f85e34f0bd6af69e88ffd310 Mon Sep 17 00:00:00 2001 From: Sam Gunaratne <385176+Samze@users.noreply.github.com> Date: Wed, 21 Jan 2026 09:51:31 -0700 Subject: [PATCH 4/4] Update apis/cf/latest/paths/Deployments.yaml --- apis/cf/latest/paths/Deployments.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apis/cf/latest/paths/Deployments.yaml b/apis/cf/latest/paths/Deployments.yaml index 24c66ee..40fcc47 100644 --- a/apis/cf/latest/paths/Deployments.yaml +++ b/apis/cf/latest/paths/Deployments.yaml @@ -118,7 +118,7 @@ description: The log rate limit in bytes per second for the web process. A value of -1 indicates unlimited, 0 prevents any logs from being emitted. canary: type: object - description: Configuration for canary deployments. Required when strategy is 'canary'. + description: Canary steps to use for the deployment. Only available for deployments with strategy ‘canary’. properties: steps: type: array