Skip to content

Commit f5b6010

Browse files
committed
Deprecate PayPal endpoints
1 parent d726b1e commit f5b6010

File tree

1 file changed

+43
-13
lines changed

1 file changed

+43
-13
lines changed

openapi.yaml

Lines changed: 43 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ info:
156156
| 200 OK | The request was successful. |
157157
| 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. |
158158
| 204 No Content | The server successfully fulfilled the request and there is no additional content to send. |
159-
| 299 Warning | The request was successful, but includes a warning such as usage of a deprecated endpoint. The response body includes a "warnings" array containing the details of any warnings. |
159+
| 299 Deprecated | The request was successful, but involved a deprecated endpoint. The response body includes a "warnings" array containing warning messages. |
160160
| 400 Bad Request | You submitted an invalid request (missing parameters, etc.). |
161161
| 401 Unauthorized | You failed to authenticate for this resource. |
162162
| 403 Forbidden | You are authenticated, but don't have permission to do this. |
@@ -1958,7 +1958,7 @@ paths:
19581958
schema:
19591959
$ref: '#/components/schemas/Payment'
19601960
'202':
1961-
$ref: '#/components/responses/WarningResponse'
1961+
$ref: '#/components/responses/AcceptedResponse'
19621962
default:
19631963
$ref: '#/components/responses/ErrorResponse'
19641964
x-code-samples:
@@ -2021,15 +2021,21 @@ paths:
20212021
x-linode-cli-command: account
20222022
post:
20232023
x-linode-grant: read_only
2024+
deprecated: true
2025+
x-linode-cli-skip: true
20242026
tags:
20252027
- Account
20262028
summary: PayPal Payment Stage
2027-
description: >
2029+
description: |
20282030
This begins the process of submitting a Payment via PayPal. After calling
20292031
this endpoint, you must take the resulting `payment_id` along with
20302032
the `payer_id` from your PayPal account and
20312033
[POST /account/payments/paypal-execute](/docs/api/account/#stagedapproved-paypal-payment-execute)
20322034
to complete the Payment.
2035+
2036+
**Note**: This endpoint is deprecated and may be removed in a future release. PayPal can now be
2037+
designated as a Payment Method for automated payments using
2038+
[Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/#adding-a-new-payment-method).
20332039
operationId: createPayPalPayment
20342040
x-linode-cli-action: paypal-start
20352041
security:
@@ -2064,6 +2070,8 @@ paths:
20642070
The checkout token generated for this Payment.
20652071
example: EC-1A2B3C4D5E6F7G8H9
20662072
readOnly: true
2073+
'299':
2074+
$ref: '#/components/responses/DeprecatedResponse'
20672075
default:
20682076
$ref: '#/components/responses/ErrorResponse'
20692077
x-code-samples:
@@ -2087,13 +2095,19 @@ paths:
20872095
x-linode-cli-command: account
20882096
post:
20892097
x-linode-grant: read_write
2098+
deprecated: true
2099+
x-linode-cli-skip: true
20902100
tags:
20912101
- Account
20922102
summary: Staged/Approved PayPal Payment Execute
2093-
description: >
2103+
description: |
20942104
Given a PaymentID and PayerID - as generated by PayPal during the
20952105
transaction authorization process - this endpoint executes the Payment
20962106
to capture the funds and credit your Linode Account.
2107+
2108+
**Note**: This endpoint is deprecated and may be removed in a future release. PayPal can now be
2109+
designated as a Payment Method for automated or manual payments using
2110+
[Cloud Manager](/docs/guides/manage-billing-in-cloud-manager/#adding-a-new-payment-method).
20972111
operationId: executePayPalPayment
20982112
x-linode-cli-action: paypal-execute
20992113
security:
@@ -2116,7 +2130,9 @@ paths:
21162130
schema:
21172131
type: object
21182132
'202':
2119-
$ref: '#/components/responses/WarningResponse'
2133+
$ref: '#/components/responses/AcceptedResponse'
2134+
'299':
2135+
$ref: '#/components/responses/DeprecatedResponse'
21202136
default:
21212137
$ref: '#/components/responses/ErrorResponse'
21222138
x-code-samples:
@@ -16018,22 +16034,25 @@ components:
1601816034
'volumes:read_only': Allows access to GET your Volumes.
1601916035
'volumes:read_write': Allows access to all endpoints related to your Volumes.
1602016036
responses:
16021-
ErrorResponse:
16022-
description: Error
16037+
AcceptedResponse:
16038+
description: |
16039+
Accepted with warning.
16040+
16041+
A warnings array is included with the standard 200 response body.
1602316042
content:
1602416043
application/json:
1602516044
schema:
1602616045
type: object
1602716046
properties:
16028-
errors:
16047+
warnings:
1602916048
type: array
1603016049
items:
16031-
$ref: '#/components/schemas/ErrorObject'
16032-
WarningResponse:
16050+
$ref: '#/components/schemas/WarningObject'
16051+
DeprecatedResponse:
1603316052
description: |
16034-
Accepted with warning.
16053+
Request successful. This endpoint is deprecated and may be removed in a future release.
1603516054

16036-
A warning object is included with the standard 200 response.
16055+
A warnings array is included with the standard 200 response body.
1603716056
content:
1603816057
application/json:
1603916058
schema:
@@ -16043,6 +16062,17 @@ components:
1604316062
type: array
1604416063
items:
1604516064
$ref: '#/components/schemas/WarningObject'
16065+
ErrorResponse:
16066+
description: Error
16067+
content:
16068+
application/json:
16069+
schema:
16070+
type: object
16071+
properties:
16072+
errors:
16073+
type: array
16074+
items:
16075+
$ref: '#/components/schemas/ErrorObject'
1604616076
parameters:
1604716077
pageOffset:
1604816078
name: page
@@ -22636,7 +22666,7 @@ components:
2263622666
WarningObject:
2263722667
type: object
2263822668
description: >
22639-
An object for describing a single warning for incomplete processing associated with an accepted request.
22669+
An object for describing a single warning associated with a response.
2264022670
properties:
2264122671
title:
2264222672
type: string

0 commit comments

Comments
 (0)