Skip to content

Release 4.7.0 #147

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 9 commits into from
Oct 21, 2019
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@ Attribute | Location | Type | Supported By | Explanation
`x-linode-cli-action` | method | string | linode-cli | The action this method will be mapped to when generating commands in the `linode-cli <command> <action>` format.
`x-linode-cli-skip` | method | boolean | linode-cli | If true, the CLI will not expose this action.
`x-linode-redoc-load-ids`| operation | boolean | If true, ReDoc will load this path and print a bulleted list of IDs. This only works on public collections.
`x-linode-ref-name`| keyword | string | [Linode Developer's Site](https://github.com/linode/developers) | Provides a mechanism by which the Developer's site can generate a dropdown menu with an Object's name when using the `oneOf` keyword with a `discriminator`. **Note**: This front end functionality is currently being developed.
86 changes: 78 additions & 8 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 @@ -182,7 +182,10 @@ 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 @@ -191,17 +194,27 @@ 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.
However, if you wanted either Types with one vcpu or Types in our "standard"
class, you can add an operator:

```Shell
```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 @@ -229,7 +242,12 @@ 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 @@ -239,7 +257,35 @@ 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 @@ -4982,6 +5028,23 @@ paths:

A cross data center migration will initiate a `linode_migrate_datacenter_create` event.
example: us-east
upgrade:
type: boolean
description: >
When initiating a cross DC migration, setting this value to
true will also ensure that the Linode is upgraded to the latest
generation of hardware that corresponds to your Linode's Type, if
any free upgrades are available for it.

If no free upgrades are available, and this value is set to true,
then the endpoint will return a 400 error code and the migration
will not be performed.

If the data center set in the `region` field does not allow upgrades,
then the endpoint will return a 400 error code and the migration
will not be performed.
example: false
default: false
responses:
'200':
description: Scheduled migration started
Expand Down Expand Up @@ -16846,6 +16909,13 @@ components:
example:
- home-pc
- laptop
tfa_enabled:
type: boolean
readOnly: true
description: >
A boolean value indicating if the User has Two Factor Authentication (TFA)
enabled. See the Create Two Factor Secret ([/profile/tfa-enable](/api/v4/profile-tfa-enable/#post))
endpoint to enable TFA.
UserDefinedField:
type: object
required:
Expand Down