Skip to content

Commit 193a6a2

Browse files
nmelehannmelehan
authored
Merge pull request #148 from linode/master
Merge Master back to Development [Release 4.7.0]
2 parents 740ff1e + b4d94c7 commit 193a6a2

File tree

1 file changed

+128
-94
lines changed

1 file changed

+128
-94
lines changed

‎openapi.yaml

Lines changed: 128 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.1
22
info:
3-
version: 4.6.0
3+
version: 4.7.0
44
title: Linode API
55
description: |
66
# Introduction
@@ -507,8 +507,7 @@ paths:
507507
schema:
508508
allOf:
509509
- $ref: '#/components/schemas/CreditCard'
510-
- type: object
511-
properties:
510+
- properties:
512511
cvv:
513512
type: string
514513
description: >
@@ -964,6 +963,13 @@ paths:
964963
- label
965964
- redirect_uri
966965
allOf:
966+
- type: object
967+
properties:
968+
public:
969+
type: boolean
970+
description: Whether to create a public or private client.
971+
example: false
972+
readOnly: false
967973
- $ref: '#/components/schemas/OAuthClient'
968974
- type: object
969975
properties:
@@ -2289,17 +2295,19 @@ paths:
22892295
required:
22902296
- domain
22912297
- remote_nameserver
2292-
properties:
2293-
domain:
2294-
type: string
2295-
description: >
2296-
The domain to import.
2297-
example: example.com
2298-
remote_nameserver:
2299-
type: string
2300-
description: >
2301-
The remote nameserver that allows zone transfers (AXFR).
2302-
example: examplenameserver.com
2298+
allOf:
2299+
- type: object
2300+
properties:
2301+
domain:
2302+
type: string
2303+
description: >
2304+
The domain to import.
2305+
example: example.com
2306+
remote_nameserver:
2307+
type: string
2308+
description: >
2309+
The remote nameserver that allows zone transfers (AXFR).
2310+
example: examplenameserver.com
23032311
responses:
23042312
'200':
23052313
description: |
@@ -2702,22 +2710,25 @@ paths:
27022710
schema:
27032711
required:
27042712
- disk_id
2705-
properties:
2706-
disk_id:
2707-
type: integer
2708-
description: >
2709-
The ID of the Linode Disk that this Image will be
2710-
created from.
2711-
example: 42
2712-
label:
2713-
type: string
2714-
description: >
2715-
A short title of this Image. Defaults to the label of the
2716-
Disk it is being created from if not provided.
2717-
description:
2718-
type: string
2719-
description: >
2720-
A detailed description of this Image.
2713+
allOf:
2714+
- $ref: '#/components/schemas/ImagePrivate'
2715+
- type: object
2716+
properties:
2717+
disk_id:
2718+
type: integer
2719+
description: >
2720+
The ID of the Linode Disk that this Image will be
2721+
created from.
2722+
example: 42
2723+
label:
2724+
type: string
2725+
description: >
2726+
A short title of this Image. Defaults to the label of the
2727+
Disk it is being created from if not provided.
2728+
description:
2729+
type: string
2730+
description: >
2731+
A detailed description of this Image.
27212732
responses:
27222733
'200':
27232734
description: New private Image created successfully.
@@ -3334,7 +3345,8 @@ paths:
33343345
items:
33353346
allOf:
33363347
- $ref: '#/components/schemas/Backup'
3337-
- properties:
3348+
- type: object
3349+
properties:
33383350
type:
33393351
type: string
33403352
example: automatic
@@ -4825,6 +4837,11 @@ paths:
48254837
schema:
48264838
allOf:
48274839
- $ref: '#/components/schemas/IPAddress'
4840+
- type: object
4841+
properties:
4842+
rdns:
4843+
type: string
4844+
example: linode.com
48284845
responses:
48294846
'200':
48304847
description: The updated IP address record.
@@ -5211,7 +5228,13 @@ paths:
52115228
- image
52125229
- root_pass
52135230
allOf:
5214-
- $ref: '#/components/schemas/LinodeRequest'
5231+
- $ref: '#/components/schemas/LinodeRequest'
5232+
properties:
5233+
image:
5234+
type: string
5235+
root_pass:
5236+
type: string
5237+
format: password
52155238
responses:
52165239
'200':
52175240
description: Rebuild started.
@@ -6700,21 +6723,23 @@ paths:
67006723
schema:
67016724
required:
67026725
- password
6703-
properties:
6704-
username:
6705-
type: string
6706-
minLength: 0
6707-
maxLength: 5000
6708-
description: >
6709-
The username to use when accessing the Managed Service.
6710-
example: johndoe
6711-
password:
6712-
type: string
6713-
minLength: 0
6714-
maxLength: 5000
6715-
description: >
6716-
The password to use when accessing the Managed Service.
6717-
example: s3cur3P@ssw0rd
6726+
allOf:
6727+
- type: object
6728+
properties:
6729+
username:
6730+
type: string
6731+
minLength: 0
6732+
maxLength: 5000
6733+
description: >
6734+
The username to use when accessing the Managed Service.
6735+
example: johndoe
6736+
password:
6737+
type: string
6738+
minLength: 0
6739+
maxLength: 5000
6740+
description: >
6741+
The password to use when accessing the Managed Service.
6742+
example: s3cur3P@ssw0rd
67186743
responses:
67196744
'200':
67206745
description: Credential username and password updated.
@@ -7984,18 +8009,19 @@ paths:
79848009
The ports to configure this NodeBalancer with on creation.
79858010
Each config must have a unique port and at least one Node.
79868011
items:
7987-
allOf:
7988-
- $ref: '#/components/schemas/NodeBalancerConfig'
7989-
- type: object
7990-
properties:
7991-
nodes:
7992-
type: array
7993-
description: >
7994-
The NodeBalancer Nodes that serve this port. When
7995-
creating a NodeBalancer this way, at least one Node
7996-
is required per configured port.
7997-
items:
7998-
$ref: '#/components/schemas/NodeBalancerNode'
8012+
allOf:
8013+
- $ref: '#/components/schemas/NodeBalancerConfig'
8014+
- type: object
8015+
properties:
8016+
nodes:
8017+
type: array
8018+
description: >
8019+
The NodeBalancer Nodes that serve this port. When
8020+
creating a NodeBalancer this way, at least one Node
8021+
is required per configured port.
8022+
items:
8023+
$ref: '#/components/schemas/NodeBalancerNode'
8024+
79998025
responses:
80008026
'200':
80018027
description: NodeBalancer created successfully.
@@ -8468,24 +8494,22 @@ paths:
84688494
* Current Nodes (identified by their ID) will be updated.
84698495
* New Nodes (included without an ID) will be created.
84708496
items:
8471-
allOf:
8472-
- $ref: '#/components/schemas/NodeBalancerConfig'
8473-
- type: object
8474-
properties:
8475-
nodes:
8476-
type: array
8477-
description: >
8478-
The NodeBalancer Node(s) that serve this port.
8479-
At least one Node is required per configured port.
8480-
8481-
Some considerations for Nodes when rebuilding a config:
8482-
* Current Nodes excluded from the request body will be deleted.
8483-
* Current Nodes (identified by their ID) will be updated.
8484-
* New Nodes (included without an ID) will be created.
8485-
items:
8486-
type: object
8487-
allOf:
8488-
- $ref: '#/components/schemas/NodeBalancerNode'
8497+
allOf:
8498+
- $ref: '#/components/schemas/NodeBalancerConfig'
8499+
- type: object
8500+
properties:
8501+
nodes:
8502+
type: array
8503+
description: >
8504+
The NodeBalancer Node(s) that serve this port.
8505+
At least one Node is required per configured port.
8506+
8507+
Some considerations for Nodes when rebuilding a config:
8508+
* Current Nodes excluded from the request body will be deleted.
8509+
* Current Nodes (identified by their ID) will be updated.
8510+
* New Nodes (included without an ID) will be created.
8511+
items:
8512+
$ref: '#/components/schemas/NodeBalancerNode'
84898513
responses:
84908514
'200':
84918515
description: NodeBalancer created successfully.
@@ -8628,11 +8652,11 @@ paths:
86288652
content:
86298653
application/json:
86308654
schema:
8655+
allOf:
8656+
- $ref: '#/components/schemas/NodeBalancerNode'
86318657
required:
86328658
- label
86338659
- address
8634-
allOf:
8635-
- $ref: '#/components/schemas/NodeBalancerNode'
86368660
responses:
86378661
'200':
86388662
description: Node created successfully.
@@ -9526,11 +9550,11 @@ paths:
95269550
application/json:
95279551
schema:
95289552
allOf:
9529-
- $ref: '#/components/schemas/ObjectStorageKey'
9530-
- type: object
9531-
properties:
9532-
secret_key:
9533-
example: OiA6F5r0niLs3QA2stbyq7mY5VCV7KqOzcmitmHw
9553+
- $ref: '#/components/schemas/ObjectStorageKey'
9554+
- type: object
9555+
properties:
9556+
secret_key:
9557+
example: OiA6F5r0niLs3QA2stbyq7mY5VCV7KqOzcmitmHw
95349558
default:
95359559
$ref: '#/components/responses/ErrorResponse'
95369560
x-code-samples:
@@ -11588,14 +11612,22 @@ paths:
1158811612
content:
1158911613
application/json:
1159011614
schema:
11591-
allOf:
11592-
- $ref: '#/components/schemas/Volume'
11593-
- type: object
11594-
properties:
11595-
size:
11596-
readOnly: true
11597-
linode_id:
11598-
readOnly: true
11615+
allOf:
11616+
- $ref: '#/components/schemas/Volume'
11617+
- type: object
11618+
properties:
11619+
region:
11620+
allOf:
11621+
- $ref: '#/components/schemas/Volume/properties/region'
11622+
readOnly: true
11623+
size:
11624+
allOf:
11625+
- $ref: '#/components/schemas/Volume/properties/size'
11626+
readOnly: true
11627+
linode_id:
11628+
allOf:
11629+
- $ref: '#/components/schemas/Volume/properties/linode_id'
11630+
readOnly: true
1159911631
responses:
1160011632
'200':
1160111633
description: The updated Volume.
@@ -11689,10 +11721,12 @@ paths:
1168911721
schema:
1169011722
type: object
1169111723
required:
11692-
- linode_id
11724+
- linode
1169311725
properties:
1169411726
linode_id:
11695-
$ref: '#/components/schemas/Volume/properties/linode_id'
11727+
allOf:
11728+
- $ref: '#/components/schemas/Volume/properties/linode_id'
11729+
readOnly: false
1169611730
config_id:
1169711731
type: integer
1169811732
description: >

0 commit comments

Comments
 (0)