Skip to content

Commit 7059ed1

Browse files
authored
Merge pull request #725 from wildmanonline/misc-updates-20221212
Miscellaneous changes
2 parents a5f36b5 + 89729b7 commit 7059ed1

File tree

1 file changed

+24
-37
lines changed

1 file changed

+24
-37
lines changed

openapi.yaml

Lines changed: 24 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ info:
2222

2323
## Changelog
2424

25-
<a target="_top" href="https://developers.linode.com/changelog">View our Changelog</a> to see release
25+
<a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release
2626
notes on all changes made to our API.
2727

2828
## Access and Authentication
@@ -54,7 +54,7 @@ info:
5454
If you're designing an application that can authenticate with an arbitrary Linode user, then
5555
you should use the OAuth 2.0 workflows presented in this section.
5656

57-
For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/platform/api/how-to-create-an-oauth-app-with-the-linode-python-api-library/#oauth-2-authentication-exchange).
57+
For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange).
5858

5959
Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients):
6060

@@ -1759,8 +1759,7 @@ paths:
17591759
description: |
17601760
The type of Payment Method.
17611761

1762-
Alternative Payment Methods including Google Pay and PayPal can be added using Linode Cloud Manager. See our
1763-
guide on [Managing Billing in the Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/)
1762+
Alternative Payment Methods including Google Pay and PayPal can be added using the Cloud Manager. See the [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/) guide
17641763
for details and instructions.
17651764
example: 'credit_card'
17661765
is_default:
@@ -2072,9 +2071,7 @@ paths:
20722071
- Account
20732072
summary: PayPal Payment Stage
20742073
description: |
2075-
**Note**: This endpoint is disabled and no longer accessible. PayPal can be
2076-
designated as a Payment Method for automated payments using
2077-
[Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/#adding-a-new-payment-method).
2074+
**Note**: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/).
20782075
operationId: createPayPalPayment
20792076
x-linode-cli-action: paypal-start
20802077
security:
@@ -2140,9 +2137,7 @@ paths:
21402137
- Account
21412138
summary: Staged/Approved PayPal Payment Execute
21422139
description: |
2143-
**Note**: This endpoint is disabled and no longer accessible. PayPal can be
2144-
designated as a Payment Method for automated payments using
2145-
[Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/#adding-a-new-payment-method).
2140+
**Note**: This endpoint is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](/docs/products/platform/billing/guides/payment-methods/).
21462141
operationId: executePayPalPayment
21472142
x-linode-cli-action: paypal-execute
21482143
security:
@@ -2641,7 +2636,7 @@ paths:
26412636
description: >
26422637
Enables Linode Managed for the entire account and sends a welcome email to the account's associated
26432638
email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See
2644-
our [Linode Managed guide](/docs/platform/linode-managed/)
2639+
our [Linode Managed guide](/docs/guides/linode-managed/)
26452640
to learn more.
26462641
operationId: enableAccountManaged
26472642
x-linode-cli-action: enable-managed
@@ -6788,7 +6783,7 @@ paths:
67886783

67896784
In an effort to fight spam, Linode restricts outbound connections on ports 25, 465, and 587
67906785
on all Linodes for new accounts created after November 5th, 2019. For more information,
6791-
see [Sending Email on Linode](/docs/email/running-a-mail-server/#sending-email-on-linode).
6786+
see [Sending Email on Linode](/docs/guides/running-a-mail-server/#sending-email-on-linode).
67926787

67936788
Linodes can be created in a number of ways:
67946789

@@ -6821,7 +6816,7 @@ paths:
68216816

68226817
* Attached to a private VLAN.
68236818
* Review the `interfaces` property of the [Request Body Schema](/docs/api/linode-instances/#linode-create__request-body-schema) for details.
6824-
* For more information, see our guide on [Getting Started with VLANs](/docs/guides/getting-started-with-vlans/).
6819+
* For more information, see our guide on [Getting Started with VLANs](/docs/products/networking/vlans/get-started/).
68256820

68266821
* Create an empty Linode.
68276822
* The Linode will remain `offline` and must be manually started.
@@ -9756,7 +9751,7 @@ paths:
97569751
If the request is not authenticated, only public StackScripts are returned.
97579752

97589753

9759-
For more information on StackScripts, please read our [StackScripts guides](/docs/platform/stackscripts/).
9754+
For more information on StackScripts, please read our [StackScripts documentation](/docs/products/tools/stackscripts/).
97609755
operationId: getStackScripts
97619756
x-linode-cli-action:
97629757
- list
@@ -12132,7 +12127,7 @@ paths:
1213212127
summary: Managed SSH Key View
1213312128
description: |
1213412129
Returns the unique SSH public key assigned to your Linode account's
12135-
Managed service. If you [add this public key](/docs/platform/linode-managed/#adding-the-public-key) to a Linode on your account,
12130+
Managed service. If you [add this public key](/docs/guides/linode-managed/#adding-the-public-key) to a Linode on your account,
1213612131
Linode special forces will be able to log in to the Linode with this key
1213712132
when attempting to resolve issues.
1213812133

@@ -14271,7 +14266,7 @@ paths:
1427114266
the migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,
1427214267
you will be prompted to select a different data center or contact support.
1427314268

14274-
**Note:** See our guide on [Getting Started with VLANs](/docs/guides/getting-started-with-vlans/) to view additional [limitations](/docs/guides/getting-started-with-vlans/#limitations).
14269+
**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) to view additional specifications and limitations.
1427514270
operationId: getVLANs
1427614271
x-linode-cli-action:
1427714272
- list
@@ -16590,7 +16585,7 @@ paths:
1659016585
description: |
1659116586
The amount of outbound data transfer used by your account's Object Storage buckets.
1659216587
Object Storage adds 1 terabyte of outbound data transfer to your data transfer pool.
16593-
See the [Object Storage Pricing and Limitations](/docs/guides/pricing-and-limitations/)
16588+
See the [Object Storage Overview](/docs/products/storage/object-storage/#pricing)
1659416589
guide for details on Object Storage transfer quotas.
1659516590

1659616591
tags:
@@ -20776,7 +20771,7 @@ components:
2077620771
description: |
2077720772
This field is required only if the StackScript being deployed requires input
2077820773
data from the User for successful completion. See
20779-
[User Defined Fields (UDFs)](/docs/guides/writing-scripts-for-use-with-linode-stackscripts-a-tutorial/#user-defined-fields-udfs)
20774+
[User Defined Fields (UDFs)](/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs)
2078020775
for more details. This field is required to be valid JSON.
2078120776
Domain:
2078220777
type: object
@@ -20962,9 +20957,7 @@ components:
2096220957
- CAA
2096320958
description: >
2096420959
The type of Record this is in the DNS system. For example, A
20965-
records associate a domain name with an IPv4 address, and AAAA
20966-
records associate a domain name with an IPv6 address. For more information, see our guide on
20967-
[DNS Records](/docs/guides/dns-records-an-introduction).
20960+
records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. For more information, see the guides on [DNS Record Types](/docs/products/networking/dns-manager/guides/#dns-record-types).
2096820961
example: A
2096920962
x-linode-filterable: true
2097020963
x-linode-cli-display: 2
@@ -20990,7 +20983,7 @@ components:
2099020983
`CAA`: The subdomain. Omit or enter an empty string (`""`) to apply to the entire Domain.
2099120984

2099220985
`PTR`: See our guide on how to [Configure Your Linode for Reverse DNS
20993-
(rDNS)](/docs/guides/configure-your-linode-for-reverse-dns).
20986+
(rDNS)](/docs/guides/configure-rdns/).
2099420987
minLength: 1
2099520988
maxLength: 100
2099620989
example: test
@@ -21027,7 +21020,7 @@ components:
2102721020
* `iodef`: Must be either (1) a valid domain, (2) a valid domain prepended with `http://` or `https://`, or (3) a valid email address prepended with `mailto:`.
2102821021

2102921022
`PTR`: Required. See our guide on how to [Configure Your Linode for Reverse DNS
21030-
(rDNS)](/docs/guides/configure-your-linode-for-reverse-dns).
21023+
(rDNS)](/docs/guides/configure-rdns/).
2103121024

2103221025
With the exception of A, AAAA, and CAA records, this field accepts a trailing period.
2103321026
example: 192.0.2.0
@@ -23171,7 +23164,7 @@ components:
2317123164

2317223165
Only used for `vlan` purpose interfaces. Must be an empty string or `null` for `public` purpose interfaces.
2317323166

23174-
The Linode is configured to use this address for the associated interface upon reboot if Network Helper is enabled. If Network Helper is disabled, the address can be enabled with [manual static IP configuration](/docs/guides/linux-static-ip-configuration/).
23167+
The Linode is configured to use this address for the associated interface upon reboot if Network Helper is enabled. If Network Helper is disabled, the address can be enabled with [manual static IP configuration](/docs/guides/manual-network-configuration/).
2317523168

2317623169
Must be unique among the Linode's interfaces.
2317723170
example: '10.0.0.1/24'
@@ -23218,7 +23211,7 @@ components:
2321823211
the migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility,
2321923212
you will be prompted to select a different data center or contact support.
2322023213

23221-
**Note:** See our guide on [Getting Started with VLANs](/docs/guides/getting-started-with-vlans/) to view additional [limitations](/docs/guides/getting-started-with-vlans/#limitations).
23214+
**Note:** See the [VLANs Overview](/docs/products/networking/vlans/#technical-specifications) guide to view additional specifications and limitations.
2322223215
LinodeRequest:
2322323216
type: object
2322423217
description: Common properties for creating and rebuilding Linodes.
@@ -25747,17 +25740,13 @@ components:
2574725740
- keys_only
2574825741
- disabled
2574925742
description: >
25750-
The authentication methods that are allowed when connecting to
25751-
[the Linode Shell (Lish)](/docs/platform/manager/using-the-linode-shell-lish/).
25743+
The authentication methods that are allowed when connecting to [the Linode Shell (Lish)](/docs/guides/lish/).
2575225744

2575325745
* `keys_only` is the most secure if you intend to use Lish.
2575425746

25755-
* `disabled` is recommended if you do not intend to use Lish at
25756-
all.
25747+
* `disabled` is recommended if you do not intend to use Lish at all.
2575725748

25758-
* If this account's Cloud Manager authentication type is set to a Third-Party Authentication method, `password_keys` cannot
25759-
be used as your Lish authentication method. To view this account's Cloud Manager `authentication_type` field, send a request
25760-
to the [View Profile](/docs/api/profile/#profile-view) endpoint.
25749+
* If this account's Cloud Manager authentication type is set to a Third-Party Authentication method, `password_keys` cannot be used as your Lish authentication method. To view this account's Cloud Manager `authentication_type` field, send a request to the [View Profile](/docs/api/profile/#profile-view) endpoint.
2576125750
example: keys_only
2576225751
authorized_keys:
2576325752
type: array
@@ -25995,7 +25984,7 @@ components:
2599525984
images:
2599625985
type: array
2599725986
description: |
25998-
An array of Image IDs. These are the Images that can be deployed with this Stackscript.
25987+
An array of Image IDs. These are the Images that can be deployed with this StackScript.
2599925988

2600025989
`any/all` indicates that all available Images, including private Images, are accepted.
2600125990
items:
@@ -26059,9 +26048,7 @@ components:
2605926048
user_defined_fields:
2606026049
type: array
2606126050
description: >
26062-
This is a list of fields defined with a special syntax inside this StackScript
26063-
that allow for supplying customized parameters during deployment. See
26064-
<a target="_top" href="/docs/platform/stackscripts/#variables-and-udfs">Variables and UDFs</a>
26051+
This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment. See [Declare User-Defined Fields (UDFs)](/docs/products/tools/stackscripts/guides/write-a-custom-script/#declare-user-defined-fields-udfs)
2606526052
for more information.
2606626053
items:
2606726054
$ref: '#/components/schemas/UserDefinedField'
@@ -26302,7 +26289,7 @@ components:
2630226289
Hello,\nI'm sorry to hear that you are having trouble resetting the
2630326290
root password of your Linode. Just to be sure, have you tried to
2630426291
follow the instructions in our online documentation? The link is here:\n
26305-
\nhttps://linode.com/docs/quick-answers/linode-platform/reset-the-root-password-on-your-linode/
26292+
\nhttps://linode.com/docs/guides/reset-the-root-password-on-your-linode/
2630626293
\n\nIf you have, please reply with any additional steps you have also
2630726294
taken.\n\nRegards, Linode Support Team
2630826295
from_linode:

0 commit comments

Comments
 (0)