Skip to content

Merge Master back to Development [Release 4.7.0] #148

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 3 commits into from
Oct 22, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
222 changes: 128 additions & 94 deletions openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.1
info:
version: 4.6.0
version: 4.7.0
title: Linode API
description: |
# Introduction
Expand Down Expand Up @@ -507,8 +507,7 @@ paths:
schema:
allOf:
- $ref: '#/components/schemas/CreditCard'
- type: object
properties:
- properties:
cvv:
type: string
description: >
Expand Down Expand Up @@ -964,6 +963,13 @@ paths:
- label
- redirect_uri
allOf:
- type: object
properties:
public:
type: boolean
description: Whether to create a public or private client.
example: false
readOnly: false
- $ref: '#/components/schemas/OAuthClient'
- type: object
properties:
Expand Down Expand Up @@ -2289,17 +2295,19 @@ paths:
required:
- domain
- remote_nameserver
properties:
domain:
type: string
description: >
The domain to import.
example: example.com
remote_nameserver:
type: string
description: >
The remote nameserver that allows zone transfers (AXFR).
example: examplenameserver.com
allOf:
- type: object
properties:
domain:
type: string
description: >
The domain to import.
example: example.com
remote_nameserver:
type: string
description: >
The remote nameserver that allows zone transfers (AXFR).
example: examplenameserver.com
responses:
'200':
description: |
Expand Down Expand Up @@ -2702,22 +2710,25 @@ paths:
schema:
required:
- disk_id
properties:
disk_id:
type: integer
description: >
The ID of the Linode Disk that this Image will be
created from.
example: 42
label:
type: string
description: >
A short title of this Image. Defaults to the label of the
Disk it is being created from if not provided.
description:
type: string
description: >
A detailed description of this Image.
allOf:
- $ref: '#/components/schemas/ImagePrivate'
- type: object
properties:
disk_id:
type: integer
description: >
The ID of the Linode Disk that this Image will be
created from.
example: 42
label:
type: string
description: >
A short title of this Image. Defaults to the label of the
Disk it is being created from if not provided.
description:
type: string
description: >
A detailed description of this Image.
responses:
'200':
description: New private Image created successfully.
Expand Down Expand Up @@ -3334,7 +3345,8 @@ paths:
items:
allOf:
- $ref: '#/components/schemas/Backup'
- properties:
- type: object
properties:
type:
type: string
example: automatic
Expand Down Expand Up @@ -4825,6 +4837,11 @@ paths:
schema:
allOf:
- $ref: '#/components/schemas/IPAddress'
- type: object
properties:
rdns:
type: string
example: linode.com
responses:
'200':
description: The updated IP address record.
Expand Down Expand Up @@ -5211,7 +5228,13 @@ paths:
- image
- root_pass
allOf:
- $ref: '#/components/schemas/LinodeRequest'
- $ref: '#/components/schemas/LinodeRequest'
properties:
image:
type: string
root_pass:
type: string
format: password
responses:
'200':
description: Rebuild started.
Expand Down Expand Up @@ -6700,21 +6723,23 @@ paths:
schema:
required:
- password
properties:
username:
type: string
minLength: 0
maxLength: 5000
description: >
The username to use when accessing the Managed Service.
example: johndoe
password:
type: string
minLength: 0
maxLength: 5000
description: >
The password to use when accessing the Managed Service.
example: s3cur3P@ssw0rd
allOf:
- type: object
properties:
username:
type: string
minLength: 0
maxLength: 5000
description: >
The username to use when accessing the Managed Service.
example: johndoe
password:
type: string
minLength: 0
maxLength: 5000
description: >
The password to use when accessing the Managed Service.
example: s3cur3P@ssw0rd
responses:
'200':
description: Credential username and password updated.
Expand Down Expand Up @@ -7984,18 +8009,19 @@ paths:
The ports to configure this NodeBalancer with on creation.
Each config must have a unique port and at least one Node.
items:
allOf:
- $ref: '#/components/schemas/NodeBalancerConfig'
- type: object
properties:
nodes:
type: array
description: >
The NodeBalancer Nodes that serve this port. When
creating a NodeBalancer this way, at least one Node
is required per configured port.
items:
$ref: '#/components/schemas/NodeBalancerNode'
allOf:
- $ref: '#/components/schemas/NodeBalancerConfig'
- type: object
properties:
nodes:
type: array
description: >
The NodeBalancer Nodes that serve this port. When
creating a NodeBalancer this way, at least one Node
is required per configured port.
items:
$ref: '#/components/schemas/NodeBalancerNode'

responses:
'200':
description: NodeBalancer created successfully.
Expand Down Expand Up @@ -8468,24 +8494,22 @@ paths:
* Current Nodes (identified by their ID) will be updated.
* New Nodes (included without an ID) will be created.
items:
allOf:
- $ref: '#/components/schemas/NodeBalancerConfig'
- type: object
properties:
nodes:
type: array
description: >
The NodeBalancer Node(s) that serve this port.
At least one Node is required per configured port.

Some considerations for Nodes when rebuilding a config:
* Current Nodes excluded from the request body will be deleted.
* Current Nodes (identified by their ID) will be updated.
* New Nodes (included without an ID) will be created.
items:
type: object
allOf:
- $ref: '#/components/schemas/NodeBalancerNode'
allOf:
- $ref: '#/components/schemas/NodeBalancerConfig'
- type: object
properties:
nodes:
type: array
description: >
The NodeBalancer Node(s) that serve this port.
At least one Node is required per configured port.

Some considerations for Nodes when rebuilding a config:
* Current Nodes excluded from the request body will be deleted.
* Current Nodes (identified by their ID) will be updated.
* New Nodes (included without an ID) will be created.
items:
$ref: '#/components/schemas/NodeBalancerNode'
responses:
'200':
description: NodeBalancer created successfully.
Expand Down Expand Up @@ -8628,11 +8652,11 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NodeBalancerNode'
required:
- label
- address
allOf:
- $ref: '#/components/schemas/NodeBalancerNode'
responses:
'200':
description: Node created successfully.
Expand Down Expand Up @@ -9526,11 +9550,11 @@ paths:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ObjectStorageKey'
- type: object
properties:
secret_key:
example: OiA6F5r0niLs3QA2stbyq7mY5VCV7KqOzcmitmHw
- $ref: '#/components/schemas/ObjectStorageKey'
- type: object
properties:
secret_key:
example: OiA6F5r0niLs3QA2stbyq7mY5VCV7KqOzcmitmHw
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
Expand Down Expand Up @@ -11588,14 +11612,22 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Volume'
- type: object
properties:
size:
readOnly: true
linode_id:
readOnly: true
allOf:
- $ref: '#/components/schemas/Volume'
- type: object
properties:
region:
allOf:
- $ref: '#/components/schemas/Volume/properties/region'
readOnly: true
size:
allOf:
- $ref: '#/components/schemas/Volume/properties/size'
readOnly: true
linode_id:
allOf:
- $ref: '#/components/schemas/Volume/properties/linode_id'
readOnly: true
responses:
'200':
description: The updated Volume.
Expand Down Expand Up @@ -11689,10 +11721,12 @@ paths:
schema:
type: object
required:
- linode_id
- linode
properties:
linode_id:
$ref: '#/components/schemas/Volume/properties/linode_id'
allOf:
- $ref: '#/components/schemas/Volume/properties/linode_id'
readOnly: false
config_id:
type: integer
description: >
Expand Down