Skip to content

[Release] 4.69.0 #290

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 31 commits into from
Jul 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
544eca0
bug: Fixed improperly named "dns_zone_import" action
Jun 29, 2020
f38ce05
Add build badge for travis-ci.com
phillc Jul 6, 2020
ef34768
Merge pull request #281 from linode/master
leslitagordita Jul 7, 2020
cad0da9
Add disks field to LKENodePoolRequestBody schema
leslitagordita Jul 9, 2020
5e9f9fd
fixed node pool array bug and minor copy edits per comments
Jul 9, 2020
347c6a1
Add note about remaining disk space allocated to boot disk
leslitagordita Jul 9, 2020
7ff38ef
Add note about default NodePool disk partition behavior
leslitagordita Jul 9, 2020
edd6286
Update POST /lke/clusters/{clusterId}/pools
leslitagordita Jul 9, 2020
63a6f3a
Update GET /lke/clusters/{clusterId}/pools/{poolId}
leslitagordita Jul 9, 2020
83b4087
Fix examples for disks field in LKENodePoolRequestBody
leslitagordita Jul 9, 2020
fc67310
Update PUT /lke/clusters/{clusterId}/pools/{poolId}
leslitagordita Jul 9, 2020
7a6ec79
Merge pull request #279 from yoshizzle/fix-dns-zone-action-error
leslitagordita Jul 10, 2020
fd936bd
Update tag field in DomainRecord collection is now filterable
leslitagordita Jul 10, 2020
a481582
action field for /account/events is now filterable
leslitagordita Jul 10, 2020
436ecc3
removed the need for lkeclusterrequestbody object
Jul 10, 2020
8299e78
removed request object
Jul 10, 2020
fd9fcde
trying to fix travis ref error
Jul 10, 2020
40ff341
Merge pull request #283 from leslitagordita/lke-node-pool-disks
leslitagordita Jul 13, 2020
87651c0
Merge pull request #285 from leslitagordita/domain-record-filterable
leslitagordita Jul 13, 2020
e6ad73e
Merge pull request #286 from leslitagordita/account-events-action-fil…
leslitagordita Jul 13, 2020
76adcc3
update get lke cluster
Jul 13, 2020
ca4443a
updated lke version
Jul 13, 2020
00aa7ad
Merge pull request #280 from linode/travis-ci-com
leslitagordita Jul 13, 2020
6b5539d
region is not readOnly
leslitagordita Jul 13, 2020
bcb8291
Merge pull request #287 from hzoppetti/lke-endpoint-fix-1
leslitagordita Jul 13, 2020
e4d8cca
Bump version to 4.69.0
leslitagordita Jul 13, 2020
1bb7287
Update LKE API docs to reflect actual behavior
sibucan Jul 13, 2020
6fb97a8
Merge branch 'development' of github.com:linode/linode-api-docs into …
sibucan Jul 13, 2020
03e5f53
Remove out-of-date regex pattern.
sibucan Jul 13, 2020
e841631
minor copy edits
leslitagordita Jul 13, 2020
c14b7f4
Merge pull request #289 from sibucan/lke-labels
leslitagordita Jul 13, 2020
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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Linode OpenAPI 3

[![Build Status](https://travis-ci.com/linode/linode-api-docs.svg?branch=master)](https://travis-ci.com/linode/linode-api-docs)

This is the Linode API OpenAPI 3 Schema

## Requirements
Expand Down
215 changes: 145 additions & 70 deletions openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.1
info:
version: 4.68.0
version: 4.69.0

title: Linode API
description: |
Expand Down Expand Up @@ -6241,13 +6241,19 @@ paths:
- region
- k8s_version
- node_pools
allOf:
- $ref: '#/components/schemas/LKEClusterRequestBody'
- properties:
node_pools:
type: array
items:
$ref: '#/components/schemas/LKENodePoolRequestBody'
properties:
label:
$ref: '#/components/schemas/LKECluster/properties/label'
region:
$ref: '#/components/schemas/LKECluster/properties/region'
k8s_version:
$ref: '#/components/schemas/LKECluster/properties/k8s_version'
tags:
$ref: '#/components/schemas/LKECluster/properties/tags'
node_pools:
type: array
items:
$ref: '#/components/schemas/LKENodePoolRequestBody'
responses:
'200':
description: Kubernetes cluster creation has started.
Expand All @@ -6268,8 +6274,20 @@ paths:
"k8s_version": "1.16",
"tags": ["ecomm", "blogs"],
"node_pools": [
{ "type": "g6-standard-4", "count": 6},
{ "type": "g6-standard-8", "count": 3}
{
"type": "g6-standard-4",
"count": 6,
"disks": [
{
"size": 1028,
"type": "ext4"
}
]
},
{
"type": "g6-standard-8",
"count": 3
}
]
}' \
https://api.linode.com/v4/lke/clusters
Expand All @@ -6279,7 +6297,7 @@ paths:
--label cluster12345 \
--region us-central \
--k8s_version 1.16 \
--node_pools.type g6-standard-4 --node_pools.count 6 \
--node_pools.type g6-standard-4 --node_pools.count 6 --node_pools.disks '[{"size": 1028, "type": "ext4"}]' \
--node_pools.type g6-standard-8 --node_pools.count 3 \
--tags ecomm
/lke/clusters/{clusterId}:
Expand Down Expand Up @@ -6339,7 +6357,7 @@ paths:
schema:
properties:
label:
$ref: '#/components/schemas/LKEClusterRequestBody/properties/label'
$ref: '#/components/schemas/LKECluster/properties/label'
tags:
type: array
items:
Expand All @@ -6362,7 +6380,6 @@ paths:
label:
$ref: '#/components/schemas/LKECluster/properties/label'
tags:
x-linode-filterable: true
type: array
items:
type: string
Expand Down Expand Up @@ -6533,7 +6550,18 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/LKENodePool'
type: object
properties:
type:
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/type'
count:
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/count'
disks:
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/disks'
id:
$ref: '#/components/schemas/LKENodePool/properties/id'
nodes:
$ref: '#/components/schemas/LKENodePool/properties/nodes'
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
Expand All @@ -6543,14 +6571,21 @@ paths:
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"type": "g6-standard-4",
"count": 6
"count": 6,
"disks": [
{
"size": 1028,
"type": "ext4"
}
]
}' \
https://api.linode.com/v4/lke/clusters/12345/pools
- lang: CLI
source: >
linode-cli lke pool-create 12345 \
--type g6-standard-4 \
--count 6 \
--disks '[{"size": 1028, "type": "ext4"}]'
/lke/clusters/{clusterId}/pools/{poolId}:
parameters:
- name: clusterId
Expand Down Expand Up @@ -6584,7 +6619,18 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/LKENodePool'
type: object
properties:
type:
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/type'
count:
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/count'
disks:
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/disks'
id:
$ref: '#/components/schemas/LKENodePool/properties/id'
nodes:
$ref: '#/components/schemas/LKENodePool/properties/nodes'
x-code-samples:
- lang: Shell
source: >
Expand Down Expand Up @@ -6621,7 +6667,18 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/LKENodePool'
type: object
properties:
type:
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/type'
count:
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/count'
disks:
$ref: '#/components/schemas/LKENodePoolRequestBody/properties/disks'
id:
$ref: '#/components/schemas/LKENodePool/properties/id'
nodes:
$ref: '#/components/schemas/LKENodePool/properties/nodes'
x-code-samples:
- lang: Shell
source: >
Expand Down Expand Up @@ -14001,6 +14058,7 @@ components:
The tag portion of a CAA record. It is invalid to set this on
other record types.
example: null
x-linode-filterable: true
created:
type: string
format: date-time
Expand Down Expand Up @@ -14071,7 +14129,7 @@ components:
- dns_record_update
- dns_zone_create
- dns_zone_delete
- dnz_zone_import
- dns_zone_import
- dns_zone_update
- host_reboot
- image_delete
Expand Down Expand Up @@ -14159,6 +14217,7 @@ components:
The action that caused this Event. New actions may be added in the future.
example: ticket_create
x-linode-cli-display: 3
x-linode-filterable: true
created:
type: string
readOnly: true
Expand Down Expand Up @@ -15922,55 +15981,9 @@ components:
The number of GPUs this Linode Type offers.
example: 0
x-linode-cli-display: 11
LKEClusterRequestBody:
type: object
description: A Kubernetes cluster.
properties:
label:
type: string
description: >
This Kubernetes cluster's unique label for display purposes only.

Labels have the following constraints:

* Must start with an alpha character
* Must only consist of alphanumeric characters and dashes (`-`)
* Must not contain two dashes in a row
minLength: 3
maxLength: 32
# Kubernetes does NOT allow underscores in resource names and we are
# passing this name to Kubernetes. Thus the following pattern:
pattern: '[a-zA-Z0-9-]{3, 32}'
example: lkecluster12345
region:
type: string
description: This Kubernetes cluster's location.
example: us-central
k8s_version:
type: string
description: >
The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>,
and the latest supported patch version will be deployed.
example: "1.16"
tags:
type: array
description: >
An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only.
items:
type: string
example:
- ecomm
- blogs
required:
- label
- region
- k8s_version
LKECluster:
type: object
# Note that LKECluster inherits all properties of
# LKEClusterRequestBody and then overrides some of the sub-properties
allOf:
- $ref: '#/components/schemas/LKEClusterRequestBody'
description: A Kubernetes cluster.
properties:
id:
type: integer
Expand All @@ -15990,19 +16003,47 @@ components:
description: When this Kubernetes cluster was updated.
example: "2019-09-13T21:24:16Z"
readOnly: true
# Note that these properties override some of the sub-properties from
# LKEClusterRequestBody but otherwise inherit all of the original
# sub-properties.
label:
type: string
description: >
This Kubernetes cluster's unique label for display purposes only.

Labels have the following constraints:

* UTF-8 characters will be returned by the API using escape
sequences of their Unicode code points. For example, the
Japanese character *か* is 3 bytes in UTF-8 (`0xE382AB`). Its
Unicode code point is 2 bytes (`0x30AB`). APIv4 supports this
character and the API will return it as the escape sequence
using six 1 byte characters which represent 2 bytes of Unicode
code point (`"\u30ab"`).
* 4 byte UTF-8 characters are not supported.
* If the label is entirely composed of UTF-8 characters, the API
response will return the code points using up to 193 1 byte
characters.
minLength: 1
maxLength: 32
x-linode-cli-display: 2
example: lkecluster12345
region:
readOnly: true
type: string
description: This Kubernetes cluster's location.
x-linode-cli-display: 3
example: us-central
k8s_version:
type: string
description: >
The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>,
and the latest supported patch version will be deployed.
example: "1.16"
tags:
x-linode-filterable: true
type: array
description: >
An array of tags applied to the Kubernetes cluster.
Tags are for organizational purposes only.
items:
type: string
example:
- ecomm
- blogs
Expand All @@ -16015,19 +16056,53 @@ components:
type:
type: string
description: A Linode Type for all of the nodes in the Node Pool.
example: "g6-standard-4"
example: g6-standard-4
count:
type: integer
description: The number of nodes in the Node Pool.
minimum: 1
maximum: 100
example: 6
disks:
type: array
description: >
This Node Pool's custom disk layout. Each item in this array will create a new disk
partition for each node in this Node Pool.

* The custom disk layout is applied to each node in this Node Pool.
* The maximum number of custom disk partitions that can be configured is 7.
* Once the requested disk paritions are allocated, the remaining disk space is allocated to the node's boot disk.
* A Node Pool's custom disk layout is immutable over the lifetime of the Node Pool.

**Note**: If this field is omitted, the node will have a default disk layout consisting of a single partition.
A custom layout is only required for specific use cases.
items:
type: object
description: >
The values to assign to each partition in this Node Pool's custom disk layout.
properties:
size:
description: >
The size of this custom disk partition in MB.

* The size of this disk partition must not exceed the capacity of the node's plan type.
type: integer
example: 1024
type:
description: >
This custom disk partition's filesystem type.
type: string
enum:
- raw
- ext4
example: ext-4
LKENodePool:
# Note that LKENodePool inherits all properties of
# LKENodePoolRequestBody and then overrides some of the sub-properties
type: object
allOf:
- $ref: '#/components/schemas/LKENodePoolRequestBody'
- type: object
description: >
The set of Node Pools which are members of the Kubernetes cluster.
Node Pools consist of a Linode type, the number of Linodes to
Expand Down