Skip to content

Commit 9a6a640

Browse files
Merge pull request #290 from linode/release-4.69.0
[Release] 4.69.0
2 parents 94bcdda + c14b7f4 commit 9a6a640

File tree

2 files changed

+147
-70
lines changed

2 files changed

+147
-70
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Linode OpenAPI 3
22

3+
[![Build Status](https://travis-ci.com/linode/linode-api-docs.svg?branch=master)](https://travis-ci.com/linode/linode-api-docs)
4+
35
This is the Linode API OpenAPI 3 Schema
46

57
## Requirements

openapi.yaml

Lines changed: 145 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.1
22
info:
3-
version: 4.68.0
3+
version: 4.69.0
44

55
title: Linode API
66
description: |
@@ -6241,13 +6241,19 @@ paths:
62416241
- region
62426242
- k8s_version
62436243
- node_pools
6244-
allOf:
6245-
- $ref: '#/components/schemas/LKEClusterRequestBody'
6246-
- properties:
6247-
node_pools:
6248-
type: array
6249-
items:
6250-
$ref: '#/components/schemas/LKENodePoolRequestBody'
6244+
properties:
6245+
label:
6246+
$ref: '#/components/schemas/LKECluster/properties/label'
6247+
region:
6248+
$ref: '#/components/schemas/LKECluster/properties/region'
6249+
k8s_version:
6250+
$ref: '#/components/schemas/LKECluster/properties/k8s_version'
6251+
tags:
6252+
$ref: '#/components/schemas/LKECluster/properties/tags'
6253+
node_pools:
6254+
type: array
6255+
items:
6256+
$ref: '#/components/schemas/LKENodePoolRequestBody'
62516257
responses:
62526258
'200':
62536259
description: Kubernetes cluster creation has started.
@@ -6268,8 +6274,20 @@ paths:
62686274
"k8s_version": "1.16",
62696275
"tags": ["ecomm", "blogs"],
62706276
"node_pools": [
6271-
{ "type": "g6-standard-4", "count": 6},
6272-
{ "type": "g6-standard-8", "count": 3}
6277+
{
6278+
"type": "g6-standard-4",
6279+
"count": 6,
6280+
"disks": [
6281+
{
6282+
"size": 1028,
6283+
"type": "ext4"
6284+
}
6285+
]
6286+
},
6287+
{
6288+
"type": "g6-standard-8",
6289+
"count": 3
6290+
}
62736291
]
62746292
}' \
62756293
https://api.linode.com/v4/lke/clusters
@@ -6279,7 +6297,7 @@ paths:
62796297
--label cluster12345 \
62806298
--region us-central \
62816299
--k8s_version 1.16 \
6282-
--node_pools.type g6-standard-4 --node_pools.count 6 \
6300+
--node_pools.type g6-standard-4 --node_pools.count 6 --node_pools.disks '[{"size": 1028, "type": "ext4"}]' \
62836301
--node_pools.type g6-standard-8 --node_pools.count 3 \
62846302
--tags ecomm
62856303
/lke/clusters/{clusterId}:
@@ -6339,7 +6357,7 @@ paths:
63396357
schema:
63406358
properties:
63416359
label:
6342-
$ref: '#/components/schemas/LKEClusterRequestBody/properties/label'
6360+
$ref: '#/components/schemas/LKECluster/properties/label'
63436361
tags:
63446362
type: array
63456363
items:
@@ -6362,7 +6380,6 @@ paths:
63626380
label:
63636381
$ref: '#/components/schemas/LKECluster/properties/label'
63646382
tags:
6365-
x-linode-filterable: true
63666383
type: array
63676384
items:
63686385
type: string
@@ -6533,7 +6550,18 @@ paths:
65336550
content:
65346551
application/json:
65356552
schema:
6536-
$ref: '#/components/schemas/LKENodePool'
6553+
type: object
6554+
properties:
6555+
type:
6556+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/type'
6557+
count:
6558+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/count'
6559+
disks:
6560+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/disks'
6561+
id:
6562+
$ref: '#/components/schemas/LKENodePool/properties/id'
6563+
nodes:
6564+
$ref: '#/components/schemas/LKENodePool/properties/nodes'
65376565
default:
65386566
$ref: '#/components/responses/ErrorResponse'
65396567
x-code-samples:
@@ -6543,14 +6571,21 @@ paths:
65436571
-H "Authorization: Bearer $TOKEN" \
65446572
-X POST -d '{
65456573
"type": "g6-standard-4",
6546-
"count": 6
6574+
"count": 6,
6575+
"disks": [
6576+
{
6577+
"size": 1028,
6578+
"type": "ext4"
6579+
}
6580+
]
65476581
}' \
65486582
https://api.linode.com/v4/lke/clusters/12345/pools
65496583
- lang: CLI
65506584
source: >
65516585
linode-cli lke pool-create 12345 \
65526586
--type g6-standard-4 \
65536587
--count 6 \
6588+
--disks '[{"size": 1028, "type": "ext4"}]'
65546589
/lke/clusters/{clusterId}/pools/{poolId}:
65556590
parameters:
65566591
- name: clusterId
@@ -6584,7 +6619,18 @@ paths:
65846619
content:
65856620
application/json:
65866621
schema:
6587-
$ref: '#/components/schemas/LKENodePool'
6622+
type: object
6623+
properties:
6624+
type:
6625+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/type'
6626+
count:
6627+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/count'
6628+
disks:
6629+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/disks'
6630+
id:
6631+
$ref: '#/components/schemas/LKENodePool/properties/id'
6632+
nodes:
6633+
$ref: '#/components/schemas/LKENodePool/properties/nodes'
65886634
x-code-samples:
65896635
- lang: Shell
65906636
source: >
@@ -6621,7 +6667,18 @@ paths:
66216667
content:
66226668
application/json:
66236669
schema:
6624-
$ref: '#/components/schemas/LKENodePool'
6670+
type: object
6671+
properties:
6672+
type:
6673+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/type'
6674+
count:
6675+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/count'
6676+
disks:
6677+
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/disks'
6678+
id:
6679+
$ref: '#/components/schemas/LKENodePool/properties/id'
6680+
nodes:
6681+
$ref: '#/components/schemas/LKENodePool/properties/nodes'
66256682
x-code-samples:
66266683
- lang: Shell
66276684
source: >
@@ -14001,6 +14058,7 @@ components:
1400114058
The tag portion of a CAA record. It is invalid to set this on
1400214059
other record types.
1400314060
example: null
14061+
x-linode-filterable: true
1400414062
created:
1400514063
type: string
1400614064
format: date-time
@@ -14071,7 +14129,7 @@ components:
1407114129
- dns_record_update
1407214130
- dns_zone_create
1407314131
- dns_zone_delete
14074-
- dnz_zone_import
14132+
- dns_zone_import
1407514133
- dns_zone_update
1407614134
- host_reboot
1407714135
- image_delete
@@ -14159,6 +14217,7 @@ components:
1415914217
The action that caused this Event. New actions may be added in the future.
1416014218
example: ticket_create
1416114219
x-linode-cli-display: 3
14220+
x-linode-filterable: true
1416214221
created:
1416314222
type: string
1416414223
readOnly: true
@@ -15922,55 +15981,9 @@ components:
1592215981
The number of GPUs this Linode Type offers.
1592315982
example: 0
1592415983
x-linode-cli-display: 11
15925-
LKEClusterRequestBody:
15926-
type: object
15927-
description: A Kubernetes cluster.
15928-
properties:
15929-
label:
15930-
type: string
15931-
description: >
15932-
This Kubernetes cluster's unique label for display purposes only.
15933-
15934-
Labels have the following constraints:
15935-
15936-
* Must start with an alpha character
15937-
* Must only consist of alphanumeric characters and dashes (`-`)
15938-
* Must not contain two dashes in a row
15939-
minLength: 3
15940-
maxLength: 32
15941-
# Kubernetes does NOT allow underscores in resource names and we are
15942-
# passing this name to Kubernetes. Thus the following pattern:
15943-
pattern: '[a-zA-Z0-9-]{3, 32}'
15944-
example: lkecluster12345
15945-
region:
15946-
type: string
15947-
description: This Kubernetes cluster's location.
15948-
example: us-central
15949-
k8s_version:
15950-
type: string
15951-
description: >
15952-
The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>,
15953-
and the latest supported patch version will be deployed.
15954-
example: "1.16"
15955-
tags:
15956-
type: array
15957-
description: >
15958-
An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only.
15959-
items:
15960-
type: string
15961-
example:
15962-
- ecomm
15963-
- blogs
15964-
required:
15965-
- label
15966-
- region
15967-
- k8s_version
1596815984
LKECluster:
1596915985
type: object
15970-
# Note that LKECluster inherits all properties of
15971-
# LKEClusterRequestBody and then overrides some of the sub-properties
15972-
allOf:
15973-
- $ref: '#/components/schemas/LKEClusterRequestBody'
15986+
description: A Kubernetes cluster.
1597415987
properties:
1597515988
id:
1597615989
type: integer
@@ -15990,19 +16003,47 @@ components:
1599016003
description: When this Kubernetes cluster was updated.
1599116004
example: "2019-09-13T21:24:16Z"
1599216005
readOnly: true
15993-
# Note that these properties override some of the sub-properties from
15994-
# LKEClusterRequestBody but otherwise inherit all of the original
15995-
# sub-properties.
1599616006
label:
16007+
type: string
16008+
description: >
16009+
This Kubernetes cluster's unique label for display purposes only.
16010+
16011+
Labels have the following constraints:
16012+
16013+
* UTF-8 characters will be returned by the API using escape
16014+
sequences of their Unicode code points. For example, the
16015+
Japanese character *か* is 3 bytes in UTF-8 (`0xE382AB`). Its
16016+
Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this
16017+
character and the API will return it as the escape sequence
16018+
using six 1 byte characters which represent 2 bytes of Unicode
16019+
code point (`"\u30ab"`).
16020+
* 4 byte UTF-8 characters are not supported.
16021+
* If the label is entirely composed of UTF-8 characters, the API
16022+
response will return the code points using up to 193 1 byte
16023+
characters.
16024+
minLength: 1
16025+
maxLength: 32
1599716026
x-linode-cli-display: 2
1599816027
example: lkecluster12345
1599916028
region:
16000-
readOnly: true
16029+
type: string
16030+
description: This Kubernetes cluster's location.
1600116031
x-linode-cli-display: 3
1600216032
example: us-central
1600316033
k8s_version:
16034+
type: string
16035+
description: >
16036+
The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>,
16037+
and the latest supported patch version will be deployed.
1600416038
example: "1.16"
1600516039
tags:
16040+
x-linode-filterable: true
16041+
type: array
16042+
description: >
16043+
An array of tags applied to the Kubernetes cluster.
16044+
Tags are for organizational purposes only.
16045+
items:
16046+
type: string
1600616047
example:
1600716048
- ecomm
1600816049
- blogs
@@ -16015,19 +16056,53 @@ components:
1601516056
type:
1601616057
type: string
1601716058
description: A Linode Type for all of the nodes in the Node Pool.
16018-
example: "g6-standard-4"
16059+
example: g6-standard-4
1601916060
count:
1602016061
type: integer
1602116062
description: The number of nodes in the Node Pool.
1602216063
minimum: 1
1602316064
maximum: 100
1602416065
example: 6
16066+
disks:
16067+
type: array
16068+
description: >
16069+
This Node Pool's custom disk layout. Each item in this array will create a new disk
16070+
partition for each node in this Node Pool.
16071+
16072+
* The custom disk layout is applied to each node in this Node Pool.
16073+
* The maximum number of custom disk partitions that can be configured is 7.
16074+
* Once the requested disk paritions are allocated, the remaining disk space is allocated to the node's boot disk.
16075+
* A Node Pool's custom disk layout is immutable over the lifetime of the Node Pool.
16076+
16077+
**Note**: If this field is omitted, the node will have a default disk layout consisting of a single partition.
16078+
A custom layout is only required for specific use cases.
16079+
items:
16080+
type: object
16081+
description: >
16082+
The values to assign to each partition in this Node Pool's custom disk layout.
16083+
properties:
16084+
size:
16085+
description: >
16086+
The size of this custom disk partition in MB.
16087+
16088+
* The size of this disk partition must not exceed the capacity of the node's plan type.
16089+
type: integer
16090+
example: 1024
16091+
type:
16092+
description: >
16093+
This custom disk partition's filesystem type.
16094+
type: string
16095+
enum:
16096+
- raw
16097+
- ext4
16098+
example: ext-4
1602516099
LKENodePool:
1602616100
# Note that LKENodePool inherits all properties of
1602716101
# LKENodePoolRequestBody and then overrides some of the sub-properties
1602816102
type: object
1602916103
allOf:
1603016104
- $ref: '#/components/schemas/LKENodePoolRequestBody'
16105+
- type: object
1603116106
description: >
1603216107
The set of Node Pools which are members of the Kubernetes cluster.
1603316108
Node Pools consist of a Linode type, the number of Linodes to

0 commit comments

Comments
 (0)