Skip to content

Release 4.111.0 #572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Nov 30, 2021
84 changes: 56 additions & 28 deletions openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.1
info:
version: 4.109.1
version: 4.111.0

title: Linode API
description: |
Expand Down Expand Up @@ -156,6 +156,7 @@ info:
| 200 OK | The request was successful. |
| 202 Accepted | The request was successful, but processing has not been completed. The response body includes a "warnings" array containing the details of incomplete processes. |
| 204 No Content | The server successfully fulfilled the request and there is no additional content to send. |
| 299 Deprecated | The request was successful, but involved a deprecated endpoint. The response body includes a "warnings" array containing warning messages. |
| 400 Bad Request | You submitted an invalid request (missing parameters, etc.). |
| 401 Unauthorized | You failed to authenticate for this resource. |
| 403 Forbidden | You are authenticated, but don't have permission to do this. |
Expand Down Expand Up @@ -504,8 +505,7 @@ paths:
survey_link:
type: string
description: A link to Linode's exit survey.
example: {'survey_link':
'https://alinktothesurvey.com'}
example: {'survey_link': https://alinktothesurvey.com'}
'409':
description: Could not charge the credit card on file
content:
Expand Down Expand Up @@ -1957,7 +1957,7 @@ paths:
schema:
$ref: '#/components/schemas/Payment'
'202':
$ref: '#/components/responses/WarningResponse'
$ref: '#/components/responses/AcceptedResponse'
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
Expand Down Expand Up @@ -2020,15 +2020,21 @@ paths:
x-linode-cli-command: account
post:
x-linode-grant: read_only
deprecated: true
x-linode-cli-skip: true
tags:
- Account
summary: PayPal Payment Stage
description: >
description: |
This begins the process of submitting a Payment via PayPal. After calling
this endpoint, you must take the resulting `payment_id` along with
the `payer_id` from your PayPal account and
[POST /account/payments/paypal-execute](/docs/api/account/#stagedapproved-paypal-payment-execute)
to complete the Payment.

**Note**: This endpoint is deprecated and may be removed in a future release. PayPal can now be
designated as a Payment Method for automated payments using
[Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/#adding-a-new-payment-method).
operationId: createPayPalPayment
x-linode-cli-action: paypal-start
security:
Expand Down Expand Up @@ -2063,6 +2069,8 @@ paths:
The checkout token generated for this Payment.
example: EC-1A2B3C4D5E6F7G8H9
readOnly: true
'299':
$ref: '#/components/responses/DeprecatedResponse'
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
Expand All @@ -2086,13 +2094,19 @@ paths:
x-linode-cli-command: account
post:
x-linode-grant: read_write
deprecated: true
x-linode-cli-skip: true
tags:
- Account
summary: Staged/Approved PayPal Payment Execute
description: >
description: |
Given a PaymentID and PayerID - as generated by PayPal during the
transaction authorization process - this endpoint executes the Payment
to capture the funds and credit your Linode Account.

**Note**: This endpoint is deprecated and may be removed in a future release. PayPal can now be
designated as a Payment Method for automated or manual payments using
[Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/#adding-a-new-payment-method).
operationId: executePayPalPayment
x-linode-cli-action: paypal-execute
security:
Expand All @@ -2115,7 +2129,9 @@ paths:
schema:
type: object
'202':
$ref: '#/components/responses/WarningResponse'
$ref: '#/components/responses/AcceptedResponse'
'299':
$ref: '#/components/responses/DeprecatedResponse'
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
Expand Down Expand Up @@ -4938,6 +4954,8 @@ paths:
example: 124
label:
type: string
minLength: 3
maxLength: 64
description: >
The label to assign this Linode when cloning to a new Linode.

Expand Down Expand Up @@ -12561,14 +12579,15 @@ paths:
servers:
- url: https://api.linode.com/v4
summary: Object Storage Bucket Remove
description: >
Removes a single bucket. While buckets containing objects _may_ be
deleted by including the `force` option in the request, such operations
will fail if the bucket contains too many objects. The recommended
description: |
Removes a single bucket.

Bucket objects must be removed prior to removing the bucket. While buckets containing objects _may_ be
deleted using the [s3cmd command-line tool](/docs/products/storage/object-storage/guides/s3cmd/#delete-a-bucket), such operations
can fail if the bucket contains too many objects. The recommended
way to empty large buckets is to use the [S3 API to configure lifecycle policies](https://docs.ceph.com/en/latest/radosgw/bucketpolicy/#) that
remove all objects, then delete the bucket.


This endpoint is available for convenience. It is recommended that instead you
use the more [fully-featured S3 API](https://docs.ceph.com/en/latest/radosgw/s3/bucketops/#delete-bucket) directly.
tags:
Expand Down Expand Up @@ -13443,14 +13462,9 @@ paths:
- url: https://api.linode.com/v4
summary: Object Storage Cancel
description: |
Cancel Object Storage on an Account. All buckets on the Account must be empty
before Object Storage can be cancelled:
Cancel Object Storage on an Account.

- To delete a smaller number of objects, review the instructions in our
[How to Use Object Storage](/docs/platform/object-storage/how-to-use-object-storage/)
guide.
- To delete large amounts of objects, consult our guide on
[Lifecycle Policies](/docs/platform/object-storage/lifecycle-policies/).
**Warning**: Removes all buckets and their contents from your Account. This data is irretrievable once removed.
security:
- personalAccessToken: []
- oauth:
Expand Down Expand Up @@ -16017,22 +16031,25 @@ components:
'volumes:read_only': Allows access to GET your Volumes.
'volumes:read_write': Allows access to all endpoints related to your Volumes.
responses:
ErrorResponse:
description: Error
AcceptedResponse:
description: |
Accepted with warning.

A warnings array is included with the standard 200 response body.
content:
application/json:
schema:
type: object
properties:
errors:
warnings:
type: array
items:
$ref: '#/components/schemas/ErrorObject'
WarningResponse:
$ref: '#/components/schemas/WarningObject'
DeprecatedResponse:
description: |
Accepted with warning.
Request successful. This endpoint is deprecated and may be removed in a future release.

A warning object is included with the standard 200 response.
A warnings array is included with the standard 200 response body.
content:
application/json:
schema:
Expand All @@ -16042,6 +16059,17 @@ components:
type: array
items:
$ref: '#/components/schemas/WarningObject'
ErrorResponse:
description: Error
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/ErrorObject'
parameters:
pageOffset:
name: page
Expand Down Expand Up @@ -18517,7 +18545,7 @@ components:
* Cannot have two dashes (`--`), underscores (`__`) or periods (`..`) in a row.
example: linode123
minLength: 3
maxLength: 32
maxLength: 64
pattern: '^[a-zA-Z]((?!--|__|..)[a-zA-Z0-9-_.])+$'
region:
type: string
Expand Down Expand Up @@ -22635,7 +22663,7 @@ components:
WarningObject:
type: object
description: >
An object for describing a single warning for incomplete processing associated with an accepted request.
An object for describing a single warning associated with a response.
properties:
title:
type: string
Expand Down