Skip to content

Release 4.6.0 #140

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 23 commits into from
Oct 7, 2019
Merged
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
85a5932
Added GET /managed/stats endpoint
Sep 26, 2019
53ea758
Fix copy and paste-ability of filtering examples
andystevensname Sep 27, 2019
22e0035
Fix formatting
leslitagordita Sep 27, 2019
3ab0166
spelling fix on schema object
Sep 30, 2019
13ab2b5
changed to oneOf
Sep 30, 2019
3940488
Merge pull request #132 from linode/master
andystevensname Oct 1, 2019
d65f961
Merge pull request #135 from leslitagordita/import-domain-formatting
andystevensname Oct 1, 2019
9e14048
Add `linode_reboot` to list of secondary event actions
leslitagordita Oct 1, 2019
1fa6b5c
stats_data to data and added note about graph points
Oct 2, 2019
149a414
Update Object Storage Endpoints
andystevensname Oct 2, 2019
dd2a396
updated description, swapped x and y, and fixed indent error
Oct 2, 2019
30a1cd4
Updated warning note of self-service migration workflow
andystevensname Oct 3, 2019
50fed94
Update error message in /116 pool migration note
andystevensname Oct 3, 2019
aaabdff
Merge pull request #138 from andystevensname/add-note-about-116-pool-…
andystevensname Oct 4, 2019
a07cc81
Remove errant comma from create bucket example
andystevensname Oct 4, 2019
98ef3a1
Merge pull request #136 from leslitagordita/secondary-entity-reboot
andystevensname Oct 4, 2019
5731fd6
Merge pull request #137 from andystevensname/remove-fields-from-objec…
andystevensname Oct 4, 2019
c5c8d15
Merge pull request #134 from andystevensname/fix-filtering-examples
andystevensname Oct 4, 2019
11087cb
Merge pull request #133 from hzoppetti/get-managed-stats
andystevensname Oct 4, 2019
4d77fed
Bump version to 4.6.0
andystevensname Oct 4, 2019
adb46a7
Improve /116 migration note
andystevensname Oct 4, 2019
9a5a3ea
data center to datacenter
andystevensname Oct 4, 2019
e2f04d5
datacenter back to data center
andystevensname Oct 7, 2019
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
196 changes: 121 additions & 75 deletions openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
openapi: 3.0.1
info:
version: 4.5.0
version: 4.6.0
title: Linode API
description: |
# Introduction
Expand Down Expand Up @@ -182,9 +182,7 @@ info:

```Shell
curl "https://api.linode.com/v4/linode/types" \
-H 'X-Filter: { \
"class": "standard"
}'
-H 'X-Filter: { "class": "standard" }'
```

The filter object's keys are the keys of the object you're filtering,
Expand All @@ -193,11 +191,8 @@ info:
Types that offer one vcpu:

```Shell
curl "https://api.linode.com/v4/linode/types" \
-H 'X-Filter: { \
"class": "standard",
"vcpus": 1
}'
curl "https://api.linode.com/v4/linode/types" \
-H 'X-Filter: { "class": "standard", "vcpus": 1 }'
```

In the above example, both filters are combined with an "and" operation.
Expand All @@ -206,12 +201,7 @@ info:

```Shell
curl "https://api.linode.com/v4/linode/types" \
-H 'X-Filter: {
"+or": [
{ "vcpus": 1 },
{ "class": "standard" }
]
}'
-H 'X-Filter: { "+or": [ { "vcpus": 1 }, { "class": "standard" } ] }'
```

Each filter in the `+or` array is its own filter object, and all conditions
Expand Down Expand Up @@ -239,11 +229,7 @@ info:

```Shell
curl "https://api.linode.com/v4/linode/types" \
-H 'X-Filter: {
"memory": {
"+gte": 61440
}
}'
-H 'X-Filter: { "memory": { "+gte": 61440 } }'
```

You can combine and nest operators to construct arbitrarily-complex queries.
Expand All @@ -253,34 +239,7 @@ info:

```Shell
curl "https://api.linode.com/v4/linode/types" \
-H 'X-Filter: {
"+or": [
{
"+or": [
{
"class": "standard"
},
{
"class": "highmem"
}
]
},
{
"+and": [
{
"vcpus": {
"+gte": 12
}
},
{
"vcpus": {
"+lte": 20
}
}
]
}
]
}'
-H 'X-Filter: { "+or": [ { "+or": [ { "class": "standard" }, { "class": "highmem" } ] }, { "+and": [ { "vcpus": { "+gte": 12 } }, { "vcpus": { "+lte": 20 } } ] } ] }'
```

# CLI (Command Line Interface)
Expand Down Expand Up @@ -2271,6 +2230,7 @@ paths:
Imports a domain zone from a remote nameserver.

Your nameserver must allow zone transfers (AXFR) from the following IPs:

- 96.126.114.97
- 96.126.114.98
- 2600:3c00::5e
Expand Down Expand Up @@ -4996,7 +4956,8 @@ paths:

**Note:** Next Generation Network (NGN) data centers do not support IPv6 `/116` pools or IP Failover.
If you have these features enabled on your Linode and attempt to migrate to an NGN data center,
the migration will not initiate. NGN data centers include Toronto and Mumbai.
the migration will not initiate. If a Linode cannot be migrated because of an incompatibility,
you will be prompted to select a different data center or contact support.
tags:
- Linode Instances
operationId: migrateLinodeInstance
Expand Down Expand Up @@ -7374,6 +7335,60 @@ paths:
- lang: CLI
source: >
linode-cli managed service-enable 9994
/managed/stats:
description: |
A collection of managed stats.
x-linode-cli-command: managed
get:
x-linode-grant: unrestricted only
tags:
- Managed
summary: List Managed Stats
description: |
Returns a list of Managed Stats on your Account in the form of x and y data points.
You can use these data points to plot your own graph visualizations. These stats
reflect the last 24 hours of combined usage across all managed Linodes on your account
giving you a high-level snapshot of data for the following:


* cpu
* disk
* swap
* network in
* network out
operationId: getManagedStats
x-linode-cli-action: stats-list
security:
- personalAccessToken: []
- oauth:
- account:read_only
responses:
'200':
description: A list of Managed Stats from the last 24 hours.
content:
application/json:
schema:
type: object
properties:
data:
type: object
oneOf:
- x-linode-ref-name: "Stats Available"
$ref: '#/components/schemas/StatsDataAvailable'
- x-linode-ref-name: "Stats Unavailable"
$ref: '#/components/schemas/StatsDataUnavailable'
discriminator:
propertyName: x-linode-ref-name
default:
$ref: '#/components/responses/ErrorResponse'
x-code-samples:
- lang: Shell
source: >
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/managed/stats
- lang: CLI
source: >
linode-cli managed stats-list
/networking/ips:
description: >
A collection of IP Addresses on your Account. Excludes private addresses.
Expand Down Expand Up @@ -8916,7 +8931,7 @@ paths:
"label": "example-bucket",
"cluster": "us-east-1",
"cors_enabled": true,
"acl": "private",
"acl": "private"
}' \
https://api.linode.com/v4beta/object-storage/buckets/
/object-storage/buckets/{clusterId}/{bucket}:
Expand Down Expand Up @@ -8999,18 +9014,6 @@ paths:
- personalAccessToken: []
- oauth:
- object_storage:read_write
parameters:
- name: force
in: query
required: false
description: >
If false, this operation will fail if the bucket is not empty. If true, this operation
will attempt to remove the bucket and its contents; very large buckets
may still return an error and require object deletion manually or through
object lifecycle management. See [the S3 API docs](https://docs.ceph.com/docs/mimic/radosgw/s3/bucketops/#delete-bucket) for details.
schema:
type: integer
default: false
responses:
'200':
description: Bucket deleted successfully.
Expand Down Expand Up @@ -13069,7 +13072,7 @@ components:
readOnly: true
description: |
Detailed information about the Event's secondary entity, which provides additional information
for events such as, but not limited to, `linode_boot`, `linode_create`, and `linode_clone` Event actions.
for events such as, but not limited to, `linode_boot`, `linode_reboot`, `linode_create`, and `linode_clone` Event actions.
x-linode-cli-display: 5
properties:
id:
Expand Down Expand Up @@ -15878,18 +15881,6 @@ components:
The hostname where this bucket can be accessed. This hostname
can be accessed through a browser if the bucket is made public.
example: example-bucket.us-east-1.linodeobjects.com
region:
type: string
description: The ID of the Region this bucket exists in.
example: us-east
size:
type: integer
description: The size of this bucket, in bytes.
example: 123
objects:
type: integer
description: The number of objects in this bucket.
example: 4
ObjectStorageObject:
type: object
description: >
Expand Down Expand Up @@ -16465,6 +16456,61 @@ components:
label: Enter the DB password
name: DB_PASSWORD
example: hunter2
StatsDataAvailable:
type: object
description: >
A collection of graph data returned for managed stats.
properties:
cpu:
type: array
description: CPU usage stats from the last 24 hours.
items:
$ref: '#/components/schemas/StatsData'
disk:
type: array
description: Disk usage stats from the last 24 hours.
items:
$ref: '#/components/schemas/StatsData'
swap:
type: array
description: Swap usage stats from the last 24 hours.
items:
$ref: '#/components/schemas/StatsData'
net_in:
type: array
description: Inbound network traffic stats from the last 24 hours.
items:
$ref: '#/components/schemas/StatsData'
net_out:
type: array
description: Outbound network traffic stats from the last 24 hours.
items:
$ref: '#/components/schemas/StatsData'
StatsDataUnavailable:
type: array
readOnly: true
description: >
An array of error messages if managed stats are unavaliable.
items:
type: string
example: Graphs are not yet available.
StatsData:
type: object
description: >
A stat data point.
properties:
x:
type: integer
readOnly: true
description: >
A stats graph data point.
example: 11513761600000
y:
type: integer
readOnly: true
description: >
A stats graph data point.
example: 29.94
SupportTicket:
type: object
description: >
Expand Down