Skip to content

Commit 48ceda6

Browse files
committed
Clean up Firewall Create descriptions
1 parent 2302de0 commit 48ceda6

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

openapi.yaml

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10200,15 +10200,19 @@ paths:
1020010200
description: |
1020110201
Creates a Firewall to filter network traffic. Use the `rules` property to
1020210202
create inbound and outbound access rules. Use the `devices` property to assign the
10203-
Firewall to a Linode service. Currently, Firewalls can only be assigned to Linode
10203+
Firewall to a service. Currently, Firewalls can only be assigned to Linode
1020410204
instances.
1020510205

10206-
A Firewall can be assigned to a single Linode service at a time.
10206+
A Firewall can be assigned to multiple Linode instances at a time.
10207+
10208+
A Linode instance can have one active, assigned Firewall at a time.
10209+
Additional disabled Firewalls can still be added to a Linode instance.
1020710210

1020810211
A `firewall_create` Event is generated when this endpoint returns successfully.
1020910212

10210-
Cloud Firewall is not available in every data center region. For the current list of availability, access the Regions List ([GET /regions](/docs/api/regions/#regions-list)) endpoint or see the [Cloud Firewall Product Documentation](https://www.linode.com/docs/products/networking/cloud-firewall/).notice will be removed when this endpoint is out of
10211-
beta.
10213+
Cloud Firewall is not available in every data center region. For the current list
10214+
of availability, access the Regions List ([GET /regions](/docs/api/regions/#regions-list))
10215+
endpoint or see the [Cloud Firewall Product Documentation](https://www.linode.com/docs/products/networking/cloud-firewall/).
1021210216
operationId: createFirewalls
1021310217
x-linode-cli-action: create
1021410218
security:
@@ -10231,23 +10235,14 @@ paths:
1023110235
properties:
1023210236
devices:
1023310237
type: object
10234-
description: >
10235-
A Firewall Device assigns a Firewall to a Linode service. Currently, Firewalls
10236-
can only be assigned to Linode instances.
10237-
10238-
* A Firewall can be assigned to a single Linode service at a time.
10239-
10240-
* Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if five other active Firewalls
10241-
are already assigned to the same service.
10242-
10243-
10244-
**Note:** When a Firewall is assigned to a Linode and you attempt
10245-
to [migrate the Linode to a data center](/docs/api/linode-instances/#dc-migrationpending-host-migration-initiate) that does not support Cloud Firewalls, the migration will fail.
10246-
Use the [List Regions](/docs/api/regions/#regions-list) endpoint to view a list of a data center's capabilities.
10238+
description: |
10239+
Devices to create for this Firewall.
10240+
When a Device is created, the Firewall is assigned to its associated service.
10241+
Currently, Devices can only be created for Linode instances.
1024710242
properties:
1024810243
linodes:
1024910244
description: >
10250-
An array of Linode IDs. A Firewall Device will be created for each ID.
10245+
An array of Linode IDs. A Firewall Device is created for each ID.
1025110246
type: array
1025210247
items:
1025310248
type: integer
@@ -17003,6 +16998,7 @@ components:
1700316998
x-linode-cli-display: 5
1700416999
status:
1700517000
type: string
17001+
readOnly: true
1700617002
description: >
1700717003
The status of this Firewall.
1700817004

@@ -20815,8 +20811,10 @@ components:
2081520811
example: true
2081620812
referrals:
2081720813
type: object
20818-
description: >
20814+
description: |
2081920815
Information about your status in our referral program.
20816+
20817+
This information becomes accessible after this Profile's Account has established at least $25.00 USD of total payments.
2082020818
readOnly: true
2082120819
properties:
2082220820
code:

0 commit comments

Comments
 (0)