Skip to content

Commit

Permalink
doc: Replace all Linode API docs URLs with their TechDocs equivalents (
Browse files Browse the repository at this point in the history
…#547)

* Replace all Linode API docs URLs with their TechDocs equivalents

* fix lint
  • Loading branch information
lgarber-akamai authored Jul 19, 2024
1 parent e2b4ef6 commit 45d12a9
Show file tree
Hide file tree
Showing 129 changed files with 384 additions and 385 deletions.
2 changes: 1 addition & 1 deletion docs/modules/account_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,6 @@ Get info about a Linode Account.
"zip": "19102-1234"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/account/#account-view__response-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-account) for a list of returned fields


4 changes: 2 additions & 2 deletions docs/modules/api_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Make an arbitrary Linode API request.

The Linode API documentation can be found here: https://www.linode.com/docs/api
The Linode API documentation can be found here: https://techdocs.akamai.com/linode-api/reference

- [Minimum Required Fields](#minimum-required-fields)
- [Examples](#examples)
Expand Down Expand Up @@ -43,7 +43,7 @@ The Linode API documentation can be found here: https://www.linode.com/docs/api
| `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`)** |
| `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 |
| `filters` | <center>`dict`</center> | <center>Optional</center> | A YAML structure corresponding to the X-Filter request header. See: https://techdocs.akamai.com/linode-api/reference |

## Return Values

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/database_engine_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ List and filter on Managed Database engine types.

| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable attributes can be found here: https://www.linode.com/docs/api/databases/#managed-database-engines-list__responses |
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable attributes can be found here: https://techdocs.akamai.com/linode-api/reference/get-databases-engines |
| `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. |

## Return Values
Expand All @@ -58,6 +58,6 @@ List and filter on Managed Database engine types.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-database-engines-list__response-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-engines) for a list of returned fields


4 changes: 2 additions & 2 deletions docs/modules/database_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ List and filter on Linode Managed Databases.

| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable attributes can be found here: https://www.linode.com/docs/api/databases/#managed-databases-list-all__responses |
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable attributes can be found here: https://techdocs.akamai.com/linode-api/reference/get-databases-engines |
| `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. |

## Return Values
Expand Down Expand Up @@ -82,6 +82,6 @@ List and filter on Linode Managed Databases.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-databases-list-all__response-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-instances) for a list of returned fields


8 changes: 4 additions & 4 deletions docs/modules/database_mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Manage a Linode MySQL database.
"version": "8.0.30"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-mysql-database-view__response-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance) for a list of returned fields


- `backups` - The database backups in JSON serialized form.
Expand All @@ -132,7 +132,7 @@ Manage a Linode MySQL database.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-mysql-database-backup-view__responses) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-backup) for a list of returned fields


- `ssl_cert` - The SSL CA certificate for an accessible Managed MySQL Database.
Expand All @@ -143,7 +143,7 @@ Manage a Linode MySQL database.
"ca_certificate": "LS0tLS1CRUdJ...=="
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-mysql-database-ssl-certificate-view__responses) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-ssl) for a list of returned fields


- `credentials` - The root username and password for an accessible Managed MySQL Database.
Expand All @@ -155,6 +155,6 @@ Manage a Linode MySQL database.
"username": "linroot"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-mysql-database-credentials-view__responses) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-credentials) for a list of returned fields


8 changes: 4 additions & 4 deletions docs/modules/database_mysql_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Get info about a Linode MySQL Managed Database.
"version": "8.0.30"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-mysql-database-view__response-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance) for a list of returned fields


- `backups` - The database backups in JSON serialized form.
Expand All @@ -88,7 +88,7 @@ Get info about a Linode MySQL Managed Database.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-mysql-database-backup-view__responses) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-backup) for a list of returned fields


- `ssl_cert` - The SSL CA certificate for an accessible Managed MySQL Database.
Expand All @@ -99,7 +99,7 @@ Get info about a Linode MySQL Managed Database.
"ca_certificate": "LS0tLS1CRUdJ...=="
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-mysql-database-ssl-certificate-view__responses) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-ssl) for a list of returned fields


- `credentials` - The root username and password for an accessible Managed MySQL Database.
Expand All @@ -111,6 +111,6 @@ Get info about a Linode MySQL Managed Database.
"username": "linroot"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-mysql-database-credentials-view__responses) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-credentials) for a list of returned fields


8 changes: 4 additions & 4 deletions docs/modules/database_postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Manage a Linode PostgreSQL database.
"version": "14.6"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-postgresql-database-view__response-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance) for a list of returned fields


- `backups` - The database backups in JSON serialized form.
Expand All @@ -135,7 +135,7 @@ Manage a Linode PostgreSQL database.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-postgresql-database-backups-list) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-backups) for a list of returned fields


- `ssl_cert` - The SSL CA certificate for an accessible Managed PostgreSQL Database.
Expand All @@ -146,7 +146,7 @@ Manage a Linode PostgreSQL database.
"ca_certificate": "LS0tLS1CRUdJ...=="
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-postgresql-database-ssl-certificate-view__responses) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-postgresql-instance-ssl) for a list of returned fields


- `credentials` - The root username and password for an accessible Managed PostgreSQL Database.
Expand All @@ -158,6 +158,6 @@ Manage a Linode PostgreSQL database.
"username": "linroot"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-postgresql-database-credentials-view__responses) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-credentials) for a list of returned fields


8 changes: 4 additions & 4 deletions docs/modules/database_postgresql_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Get info about a Linode PostgreSQL Managed Database.
"version": "14.6"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-postgresql-database-view__response-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance) for a list of returned fields


- `backups` - The database backups in JSON serialized form.
Expand All @@ -89,7 +89,7 @@ Get info about a Linode PostgreSQL Managed Database.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-postgresql-database-backups-list__response-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-backups) for a list of returned fields


- `ssl_cert` - The SSL CA certificate for an accessible Managed PostgreSQL Database.
Expand All @@ -100,7 +100,7 @@ Get info about a Linode PostgreSQL Managed Database.
"ca_certificate": "LS0tLS1CRUdJ...=="
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-postgresql-database-ssl-certificate-view) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-postgresql-instance-ssl) for a list of returned fields


- `credentials` - The root username and password for an accessible Managed PostgreSQL Database.
Expand All @@ -112,6 +112,6 @@ Get info about a Linode PostgreSQL Managed Database.
"username": "linroot"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/databases/#managed-postgresql-database-credentials-view__request-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-credentials) for a list of returned fields


6 changes: 3 additions & 3 deletions docs/modules/domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Manage Linode Domains.
"type": "master"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/domains/#domain-view) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain) for a list of returned fields


- `records` - The domain record in JSON serialized form.
Expand All @@ -99,7 +99,7 @@ Manage Linode Domains.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/domains/#domain-record-view) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-record) for a list of returned fields


- `zone_file` - The zone file for the last rendered zone for the specified domain.
Expand All @@ -121,6 +121,6 @@ Manage Linode Domains.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/domains/#domain-zone-file-view) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-zone) for a list of returned fields


6 changes: 3 additions & 3 deletions docs/modules/domain_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Get info about a Linode Domain.
"type": "master"
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/domains/#domain-view) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain) for a list of returned fields


- `records` - The domain record in JSON serialized form.
Expand All @@ -85,7 +85,7 @@ Get info about a Linode Domain.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/domains/#domain-record-view) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-record) for a list of returned fields


- `zone_file` - The zone file for the last rendered zone for the specified domain.
Expand All @@ -107,6 +107,6 @@ Get info about a Linode Domain.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/domains/#domain-zone-file-view) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-zone) for a list of returned fields


4 changes: 2 additions & 2 deletions docs/modules/domain_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ List and filter on Domains.

| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable attributes can be found here: https://www.linode.com/docs/api/domains/#domains-list__responses#domains-list__responses |
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable attributes can be found here: https://techdocs.akamai.com/linode-api/reference/get-domains |
| `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. |

## Return Values
Expand Down Expand Up @@ -72,6 +72,6 @@ List and filter on Domains.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/domains/#domains-list__response-samples) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domains) for a list of returned fields


2 changes: 1 addition & 1 deletion docs/modules/domain_record.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,6 @@ NOTE: Domain records are identified by their name, target, and type.
"weight": 50
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/domains/#domain-record-view) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-record) for a list of returned fields


2 changes: 1 addition & 1 deletion docs/modules/domain_record_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,6 @@ Get info about a Linode Domain Record.
"weight": 50
}
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/domains/#domain-record-view) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-record) for a list of returned fields


4 changes: 2 additions & 2 deletions docs/modules/event_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ List and filter on Linode events.

| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable attributes can be found here: https://www.linode.com/docs/api/account/#events-list__responses |
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable attributes can be found here: https://techdocs.akamai.com/linode-api/reference/get-events |
| `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. |

## Return Values
Expand Down Expand Up @@ -87,6 +87,6 @@ List and filter on Linode events.
}
]
```
- See the [Linode API response documentation](https://www.linode.com/docs/api/account/#events-list__responses) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-events) for a list of returned fields


Loading

0 comments on commit 45d12a9

Please sign in to comment.