Skip to content

Commit

Permalink
Fix fmt
Browse files Browse the repository at this point in the history
  • Loading branch information
@lgarber-akamai
lgarber-akamai committed Feb 14, 2023
1 parent bc573a9 commit 8fa36d9
Show file tree
Hide file tree
Showing 18 changed files with 39 additions and 39 deletions.
4 changes: 2 additions & 2 deletions docs/modules/api_request.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ The Linode API documentation can be found here: https://www.linode.com/docs/api
|-----------|------|----------|------------------------------------------------------------------------------|
| `path` | <center>`str`</center> | <center>**Required**</center> | The relative path to the endpoint to make a request to. e.g. "linode/instances" |
| `method` | <center>`str`</center> | <center>**Required**</center> | The HTTP method of the request or response. **(Choices: `POST`, `PUT`, `GET`, `DELETE`)** |
| `body` | <center>`dict`</center> | <center>Optional</center> | The body of the request. This is a YAML structure that will be marshalled to JSON. **(Conflicts With:`body_json`)** |
| `body_json` | <center>`str`</center> | <center>Optional</center> | The body of the request in JSON format. **(Conflicts With:`body`)** |
| `body` | <center>`dict`</center> | <center>Optional</center> | The body of the request. This is a YAML structure that will be marshalled to JSON. **(Conflicts With: `body_json`)** |
| `body_json` | <center>`str`</center> | <center>Optional</center> | The body of the request in JSON format. **(Conflicts With: `body`)** |
| `filters` | <center>`dict`</center> | <center>Optional</center> | A YAML structure corresponding to the X-Filter request header. See: https://www.linode.com/docs/api/#filtering-and-sorting |


Expand Down
4 changes: 2 additions & 2 deletions docs/modules/database_mysql_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode MySQL Managed Database.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`str`</center> | <center>Optional</center> | The ID of the MySQL Database. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the MySQL Database. **(Conflicts With:`id`)** |
| `id` | <center>`str`</center> | <center>Optional</center> | The ID of the MySQL Database. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the MySQL Database. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/database_postgresql_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode PostgreSQL Managed Database.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`str`</center> | <center>Optional</center> | The ID of the PostgreSQL Database. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the PostgreSQL Database. **(Conflicts With:`id`)** |
| `id` | <center>`str`</center> | <center>Optional</center> | The ID of the PostgreSQL Database. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the PostgreSQL Database. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/domain_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode Domain.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`int`</center> | <center>Optional</center> | The unique domain name of the Domain. Optional if `domain` is defined. **(Conflicts With:`domain`)** |
| `domain` | <center>`str`</center> | <center>Optional</center> | The unique id of the Domain. Optional if `id` is defined. **(Conflicts With:`id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The unique domain name of the Domain. Optional if `domain` is defined. **(Conflicts With: `domain`)** |
| `domain` | <center>`str`</center> | <center>Optional</center> | The unique id of the Domain. Optional if `id` is defined. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/domain_record.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ NOTE: Domain records are identified by their name, target, and type.
| `state` | <center>`str`</center> | <center>**Required**</center> | The desired state of the target. **(Choices: `present`, `absent`)** |
| `domain_id` | <center>`int`</center> | <center>Optional</center> | The ID of the parent Domain. |
| `domain` | <center>`str`</center> | <center>Optional</center> | The name of the parent Domain. |
| `record_id` | <center>`int`</center> | <center>Optional</center> | The id of the record to modify. **(Conflicts With:`name`)** |
| `name` | <center>`str`</center> | <center>Optional</center> | The name of this Record. NOTE: If the name of the record ends with the domain, it will be dropped from the resulting record's name. **(Conflicts With:`record_id`)** |
| `record_id` | <center>`int`</center> | <center>Optional</center> | The id of the record to modify. **(Conflicts With: `name`)** |
| `name` | <center>`str`</center> | <center>Optional</center> | The name of this Record. NOTE: If the name of the record ends with the domain, it will be dropped from the resulting record's name. **(Conflicts With: `record_id`)** |
| `port` | <center>`int`</center> | <center>Optional</center> | The port this Record points to. Only valid and required for SRV record requests. **(Updatable)** |
| `priority` | <center>`int`</center> | <center>Optional</center> | The priority of the target host for this Record. Lower values are preferred. Only valid for MX and SRV record requests. Required for SRV record requests. **(Updatable)** |
| `protocol` | <center>`str`</center> | <center>Optional</center> | The protocol this Record’s service communicates with. An underscore (_) is prepended automatically to the submitted value for this property. **(Updatable)** |
Expand Down
8 changes: 4 additions & 4 deletions docs/modules/domain_record_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ Get info about a Linode Domain Record.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `domain_id` | <center>`int`</center> | <center>Optional</center> | The ID of the parent Domain. Optional if `domain` is defined. **(Conflicts With:`domain`)** |
| `domain` | <center>`str`</center> | <center>Optional</center> | The name of the parent Domain. Optional if `domain_id` is defined. **(Conflicts With:`domain_id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The unique id of the subdomain. Optional if `name` is defined. **(Conflicts With:`name`)** |
| `name` | <center>`str`</center> | <center>Optional</center> | The name of the domain record. Optional if `id` is defined. **(Conflicts With:`id`)** |
| `domain_id` | <center>`int`</center> | <center>Optional</center> | The ID of the parent Domain. Optional if `domain` is defined. **(Conflicts With: `domain`)** |
| `domain` | <center>`str`</center> | <center>Optional</center> | The name of the parent Domain. Optional if `domain_id` is defined. **(Conflicts With: `domain_id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The unique id of the subdomain. Optional if `name` is defined. **(Conflicts With: `name`)** |
| `name` | <center>`str`</center> | <center>Optional</center> | The name of the domain record. Optional if `id` is defined. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/firewall_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode Firewall.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`int`</center> | <center>Optional</center> | The unique id of the Firewall. Optional if `label` is defined. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The Firewall’s label. Optional if `id` is defined. **(Conflicts With:`id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The unique id of the Firewall. Optional if `label` is defined. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The Firewall’s label. Optional if `id` is defined. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/image.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ Manage a Linode Image.
| `label` | <center>`str`</center> | <center>**Required**</center> | This Image's unique label. |
| `state` | <center>`str`</center> | <center>**Required**</center> | The state of this Image. **(Choices: `present`, `absent`)** |
| `description` | <center>`str`</center> | <center>Optional</center> | A description for the Image. **(Updatable)** |
| `disk_id` | <center>`int`</center> | <center>Optional</center> | The ID of the disk to clone this image from. **(Conflicts With:`source_file`)** |
| `disk_id` | <center>`int`</center> | <center>Optional</center> | The ID of the disk to clone this image from. **(Conflicts With: `source_file`)** |
| `recreate` | <center>`bool`</center> | <center>Optional</center> | If true, the image with the given label will be deleted and recreated **(Default: `False`)** |
| `region` | <center>`str`</center> | <center>Optional</center> | The Linode region to upload this image to. **(Default: `us-east`)** |
| `source_file` | <center>`str`</center> | <center>Optional</center> | An image file to create this image with. **(Conflicts With:`disk_id`)** |
| `source_file` | <center>`str`</center> | <center>Optional</center> | An image file to create this image with. **(Conflicts With: `disk_id`)** |
| `wait` | <center>`bool`</center> | <center>Optional</center> | Wait for the image to have status `available` before returning. **(Default: `True`)** |
| `wait_timeout` | <center>`int`</center> | <center>Optional</center> | The amount of time, in seconds, to wait for an image to have status `available`. **(Default: `600`)** |

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/image_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode Image.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`str`</center> | <center>Optional</center> | The ID of the image. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the image. **(Conflicts With:`id`)** |
| `id` | <center>`str`</center> | <center>Optional</center> | The ID of the image. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the image. **(Conflicts With: `id`)** |



Expand Down
8 changes: 4 additions & 4 deletions docs/modules/instance.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,17 +79,17 @@ Manage Linode Instances, Configs, and Disks.
| `state` | <center>`str`</center> | <center>**Required**</center> | The desired state of the target. **(Choices: `present`, `absent`)** |
| `type` | <center>`str`</center> | <center>Optional</center> | The unique label to give this instance. |
| `region` | <center>`str`</center> | <center>Optional</center> | The location to deploy the instance in. See the [Linode API documentation](https://api.linode.com/v4/regions). |
| `image` | <center>`str`</center> | <center>Optional</center> | The image ID to deploy the instance disk from. **(Conflicts With:`disks`,`configs`)** |
| `image` | <center>`str`</center> | <center>Optional</center> | The image ID to deploy the instance disk from. **(Conflicts With: `disks`,`configs`)** |
| `authorized_keys` | <center>`list`</center> | <center>Optional</center> | A list of SSH public key parts to deploy for the root user. |
| `root_pass` | <center>`str`</center> | <center>Optional</center> | The password for the root user. If not specified, one will be generated. This generated password will be available in the task success JSON. |
| `stackscript_id` | <center>`int`</center> | <center>Optional</center> | The ID of the StackScript to use when creating the instance. See the [Linode API documentation](https://www.linode.com/docs/api/stackscripts/). |
| `stackscript_data` | <center>`dict`</center> | <center>Optional</center> | An object containing arguments to any User Defined Fields present in the StackScript used when creating the instance. Only valid when a stackscript_id is provided. See the [Linode API documentation](https://www.linode.com/docs/api/stackscripts/). |
| `private_ip` | <center>`bool`</center> | <center>Optional</center> | If true, the created Linode will have private networking enabled. |
| `group` | <center>`str`</center> | <center>Optional</center> | The group that the instance should be marked under. Please note, that group labelling is deprecated but still supported. The encouraged method for marking instances is to use tags. **(Updatable)** |
| `boot_config_label` | <center>`str`</center> | <center>Optional</center> | The label of the config to boot from. |
| [`configs` (sub-options)](#configs) | <center>`list`</center> | <center>Optional</center> | A list of Instance configs to apply to the Linode. See the [Linode API documentation](https://www.linode.com/docs/api/linode-instances/#configuration-profile-create). **(Updatable; Conflicts With:`image`,`interfaces`)** |
| [`disks` (sub-options)](#disks) | <center>`list`</center> | <center>Optional</center> | A list of Disks to create on the Linode. See the [Linode API documentation](https://www.linode.com/docs/api/linode-instances/#disk-create). **(Updatable; Conflicts With:`image`,`interfaces`)** |
| [`interfaces` (sub-options)](#interfaces) | <center>`list`</center> | <center>Optional</center> | A list of network interfaces to apply to the Linode. See the [Linode API documentation](https://www.linode.com/docs/api/linode-instances/#linode-create__request-body-schema). **(Conflicts With:`disks`,`configs`)** |
| [`configs` (sub-options)](#configs) | <center>`list`</center> | <center>Optional</center> | A list of Instance configs to apply to the Linode. See the [Linode API documentation](https://www.linode.com/docs/api/linode-instances/#configuration-profile-create). **(Updatable; Conflicts With: `image`,`interfaces`)** |
| [`disks` (sub-options)](#disks) | <center>`list`</center> | <center>Optional</center> | A list of Disks to create on the Linode. See the [Linode API documentation](https://www.linode.com/docs/api/linode-instances/#disk-create). **(Updatable; Conflicts With: `image`,`interfaces`)** |
| [`interfaces` (sub-options)](#interfaces) | <center>`list`</center> | <center>Optional</center> | A list of network interfaces to apply to the Linode. See the [Linode API documentation](https://www.linode.com/docs/api/linode-instances/#linode-create__request-body-schema). **(Conflicts With: `disks`,`configs`)** |
| `booted` | <center>`bool`</center> | <center>Optional</center> | Whether the new Instance should be booted. This will default to True if the Instance is deployed from an Image or Backup. |
| `backup_id` | <center>`int`</center> | <center>Optional</center> | The id of the Backup to restore to the new Instance. May not be provided if "image" is given. |
| `wait` | <center>`bool`</center> | <center>Optional</center> | Wait for the instance to have status "running" before returning. **(Default: `True`)** |
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/instance_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode Instance.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`int`</center> | <center>Optional</center> | The instance’s label. Optional if `label` is defined. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The unique ID of the Instance. Optional if `id` is defined. **(Conflicts With:`id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The instance’s label. Optional if `label` is defined. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The unique ID of the Instance. Optional if `id` is defined. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/lke_cluster_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode LKE cluster.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the LKE cluster. Optional if `label` is defined. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the LKE cluster. Optional if `id` is defined. **(Conflicts With:`id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the LKE cluster. Optional if `label` is defined. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the LKE cluster. Optional if `id` is defined. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/nodebalancer_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode NodeBalancer.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of this NodeBalancer. Optional if `label` is defined. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of this NodeBalancer. Optional if `id` is defined. **(Conflicts With:`id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of this NodeBalancer. Optional if `label` is defined. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of this NodeBalancer. Optional if `id` is defined. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ssh_key_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about the Linode SSH public key.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the SSH key. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the SSH key. **(Conflicts With:`id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the SSH key. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the SSH key. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/stackscript_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode StackScript.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the StackScript. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the StackScript. **(Conflicts With:`id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the StackScript. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the StackScript. **(Conflicts With: `id`)** |



Expand Down
4 changes: 2 additions & 2 deletions docs/modules/token_info.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Get info about a Linode Personal Access Token.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the token. **(Conflicts With:`label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the token. **(Conflicts With:`id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the token. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the token. **(Conflicts With: `id`)** |



Expand Down
Loading

0 comments on commit 8fa36d9

Please sign in to comment.