Skip to content

Commit

Permalink
Address copy comments p2
Browse files Browse the repository at this point in the history
  • Loading branch information
StephenVarela committed Dec 2, 2024
1 parent bca6088 commit 59aa82b
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion specification/DigitalOcean-public.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ tags:
- name: Autoscale Pools
description: |-
Autoscale for droplets manages horizontal scaling for your applications based on resource usage or a static configuration.
Autoscaling for Droplets manages horizontal scaling for your applications based on resource usage or a static configuration.
When you use autoscaling, you create one or more autoscaling pools. An autoscaling pool has 2 components: scaling configuration, which determines how the pool scales up and down,
and a Droplet template, which defines the configuration of the Droplets in the pool.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ operationId: autoscalepools_list_members
summary: List members

description: |
To list the members (resources) in an autoscale pool, send a GET request to `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/members`.
To list the Droplets in an autoscale pool, send a GET request to `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/members`.
The response body will be a JSON object with a key of `droplets`. This will be
set to an array containing information about each of the Droplets in the autoscale pool.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ summary: Update Autoscale Pool

description: |
To update the configuration of an existing autoscale pool, send a PUT request to
`/v2/droplets/autoscale/$AUTOSCALE_POOL_ID`. The request should contain a full representation
`/v2/droplets/autoscale/$AUTOSCALE_POOL_ID`. The request must contain a full representation
of the autoscale pool including existing attributes.
tags:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@ properties:
id:
type: string
example: 0d3db13e-a604-4944-9827-7ec2642d32ac
description: A unique identifier for each Autoscale pool instance. This is
automatically generated upon Autoscale Pool creation.
description: A unique identifier for each autoscale pool instance. This is
automatically generated upon autoscale pool creation.

name:
type: string
example: my-autoscale-pool
description: The human-readable name set for the Autoscale Pool.
description: The human-readable name set for the autoscale pool.

config:
oneOf:
- $ref: ../models/autoscale_pool_static_config.yml
- $ref: ../models/autoscale_pool_dynamic_config.yml
type: object
description: This is the scaling configuration for an autoscale pool
Currently 2 methods are supported for how an autoscaling pool scales up and down.
Additional methods may be added in future releases.
description: The scaling configuration for an autoscale pool, which
is how the pool scales up and down (either by resource utilization
or static configuration).

droplet_template:
$ref: ../models/autoscale_pool_droplet_template.yml
Expand All @@ -33,15 +33,15 @@ properties:
type: string
example: 2020-07-28T18:00:00Z
description: A time value given in ISO8601 combined date and time format
that represents when the Autoscale Pool was created.
that represents when the autoscale pool was created.

updated_at:
format: date-time
title: When the autoscale pool was last updated
type: string
example: 2020-07-28T18:00:00Z
description: A time value given in ISO8601 combined date and time format
that represents when the Autoscale Pool was last updated.
that represents when the autoscale pool was last updated.

status:
type: string
Expand All @@ -55,7 +55,7 @@ properties:
active_resources_count:
type: integer
example: 1
description: The number of active resources in the autoscale pool.
description: The number of active Droplets in the autoscale pool.

required:
- id
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@ type: object

properties:
name:
example: "my-autoscaler-group"
example: "my-autoscale-pool"
type: string
description: "The human-readable name of the autoscaler group. This field cannot be updated"
description: "The human-readable name of the autoscale pool. This field cannot be updated"
config:
oneOf:
- $ref: ../models/autoscale_pool_static_config.yml
- $ref: ../models/autoscale_pool_dynamic_config.yml
type: object
description: This is the scaling configuration for an autoscale pool
Currently 2 methods are supported for how an autoscaling pool scales up and down.
Additional methods may be added in future releases.
description: The scaling configuration for an autoscale pool, which
is how the pool scales up and down (either by resource utilization
or static configuration).
droplet_template:
$ref: ../models/autoscale_pool_droplet_template.yml

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ properties:
min_instances:
type: integer
example: 5
description: The minimum number of Droplets in an autoscaling pool.
description: The minimum number of Droplets in an autoscale pool.
minimum: 0
maximum: 500
max_instances:
type: integer
example: 10
description: The maximum number of Droplets in an autoscaling pool.
description: The maximum number of Droplets in an autoscale pool.
minimum: 0
maximum: 1000
target_cpu_utilization:
Expand All @@ -30,7 +30,7 @@ properties:
cooldown_minutes:
type: integer
example: 5
description: The number of minutes to wait between scaling events in an autoscaling pool. Defaults to 10 minutes.
description: The number of minutes to wait between scaling events in an autoscale pool. Defaults to 10 minutes.
minimum: 5
maximum: 20

Expand Down
2 changes: 1 addition & 1 deletion specification/resources/autoscale_pools/models/member.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ properties:
droplet_id:
type: integer
example: 459903570
description: The unique identifier of the droplet.
description: The unique identifier of the Droplet.
created_at:
format: date-time
description: The creation time of the Droplet in ISO8601 combined date and time format.
Expand Down

0 comments on commit 59aa82b

Please sign in to comment.