Skip to content

Release/0.16.16 #87

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 30 commits into from
Apr 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
d7ebf96
brk:/linode/instances/$id/rebuild returns a Linode
jamesottinger Mar 19, 2018
368ab3d
Merge pull request #80 from jamesottinger/rebuldreturn
yoshizzle Mar 19, 2018
b6f888f
brk: renamed reset_secret to reset-secret
Mar 20, 2018
89ec1f4
Merge pull request #81 from yoshizzle/reset-secret
jamesottinger Mar 20, 2018
0f42eee
Removed managed_issue_type from POST /support/tickets endpoint
Mar 21, 2018
41c177f
Merge pull request #82 from yoshizzle/supportTicketManagedIssueType
jamesottinger Mar 21, 2018
bbd34aa
Moved public v6 addresses to /networking/ips/$address
Dorthu Mar 23, 2018
2ed1ede
Merge pull request #83 from Dorthu/ipv6-in-ips
jamesottinger Mar 23, 2018
7823991
The field name for TTL of a DNS record is ttl_sec
mendsley Mar 26, 2018
97b8bd3
Added changelog for 2018-04-02 release
Dorthu Mar 28, 2018
31782b5
Merge pull request #84 from mendsley/dns_post_ttl
Dorthu Mar 28, 2018
086bc19
brk: param changes to POST /networking/ips and /linode/instances/:id/ips
jamesottinger Mar 28, 2018
592ac6f
Merge pull request #86 from jamesottinger/networkingtype
yoshizzle Mar 28, 2018
2c57871
Addressed PR feedback
Dorthu Mar 28, 2018
e76feea
Merge pull request #85 from Dorthu/changelog-4-2-2018
Dorthu Mar 28, 2018
75da55c
fix documentation for /managed/linode-settings
jamesottinger Mar 29, 2018
116f946
add changelog fixes
jamesottinger Mar 29, 2018
bd1127a
add new fields to Notification object
jamesottinger Mar 29, 2018
da738fe
remove password from POST /account/users
jamesottinger Mar 29, 2018
37bfdb8
add changes for /networking/ipv4/assign | share
jamesottinger Mar 29, 2018
7dae727
PUT /account/users/:username no longer accepts "email"
jamesottinger Mar 29, 2018
795d196
switch to POST /linode/instances/:id/disks/:id/clone
jamesottinger Mar 29, 2018
2033324
Merge pull request #88 from jamesottinger/releasechanges1616
Dorthu Mar 29, 2018
a3d2b7f
Renamed "us-south" to "us-central"
Dorthu Mar 29, 2018
7871c8f
Added region name changes to changelog
Dorthu Mar 29, 2018
9b7566d
Merge pull request #89 from Dorthu/rename-us-south-to-us-central
yoshizzle Mar 30, 2018
6082bc7
Removed "Early Access" and "Beta" notices.
Dorthu Apr 2, 2018
523ca6f
Removed "V4" from API description
Dorthu Apr 2, 2018
e0fb84b
Addressed PR feedback
Dorthu Apr 2, 2018
d8054d7
Merge pull request #90 from Dorthu/remove-early-access-beta
yoshizzle Apr 2, 2018
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: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</h1>

This is the new Linode developers site. It provides documentation to complement the APIv4.
Currently this software is *early-access* and is available at [developers.linode.com](https://developers.linode.com).
This documentation can be viewed at [developers.linode.com](https://developers.linode.com).

## Setup

Expand Down
2 changes: 1 addition & 1 deletion src/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ browserHistory.listen(function (location) {

window.setTitle = function (newTitle) {
const title = document.querySelector('title');
title.textContent = 'API v4 Documentation | Linode Developers';
title.textContent = 'API Documentation | Linode Developers';

if (newTitle) {
title.textContent = `${newTitle} | ${title.textContent}`;
Expand Down
13 changes: 4 additions & 9 deletions src/data/endpoints/account.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ endpoints:
python: |
my_client = linode.OAuthClient(client, 123)
my_client.delete()
/account/oauth-clients/$id/reset_secret:
/account/oauth-clients/$id/reset-secret:
group: OAuth Clients
type: Action
authenticated: true
Expand All @@ -200,7 +200,7 @@ endpoints:
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST \
https://$api_root/$version/account/oauth-clients/$client_id/reset_secret
https://$api_root/$version/account/oauth-clients/$client_id/reset-secret
python: |
my_client = linode.OAuthClient(client, 123)
new_secret = my_client.reset_secret()
Expand Down Expand Up @@ -269,10 +269,6 @@ endpoints:
type: String
description: The user's email.
value: [email protected]
password:
type: String
description: The user's password.
value: hunter2
restricted:
optional: true
type: Boolean
Expand All @@ -284,7 +280,6 @@ endpoints:
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"username": "testguy",
"password": "hunter7",
"email": "[email protected]"
}' \
https://$api_root/$version/account/users
Expand All @@ -311,13 +306,13 @@ endpoints:
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X PUT -d '{
"email": "[email protected]"
"username": "newusername"
}
}' \
https://$api_root/$version/account/users/testguy
python: |
my_user = linode.User(client, 'username')
my_user.email = '[email protected]'
my_user.username = 'newusername'
my_user.save()
DELETE:
description: >
Expand Down
2 changes: 1 addition & 1 deletion src/data/endpoints/domains.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ endpoints:
The tag attribute for a CAA record. One of "issue", "issuewild",
or "iodef". Ignored on other record types.
type: Enum
ttl:
ttl_sec:
optional: true
description: >
Time interval that the resource record may be cached before
Expand Down
58 changes: 34 additions & 24 deletions src/data/endpoints/linodes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -281,18 +281,6 @@ endpoints:
python: |
disk.label = 'New Disk Label'
disk.save()
POST:
oauth: linodes:create
description: >
Duplicates this disk.
examples:
curl: |
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST \
https://$api_root/$version/linode/instances/$linode_id/disks/$disk_id
python: |
new_disk = disk.duplicate()
DELETE:
oauth: linodes:delete
dangerous: true
Expand All @@ -305,6 +293,25 @@ endpoints:
https://$api_root/$version/linode/instances/$linode_id/disks/$disk_id
python: |
disk.delete()
/linode/instances/$id/disks/$id/clone:
group: Disks
type: resource
authenticated: true
description: >
Duplicates a disk.
methods:
POST:
oauth: linodes:create
description: >
Duplicates this disk.
examples:
curl: |
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST \
https://$api_root/$version/linode/instances/$linode_id/disks/$disk_id/clone
python: |
new_disk = disk.duplicate()
/linode/instances/$id/disks/$id/resize:
group: Disks
type: Strange
Expand Down Expand Up @@ -869,23 +876,27 @@ endpoints:
money: true
oauth: linodes:modify
description: >
Allocates a new IP Address for this Linode.
Allocates a new IPv4 Address for this Linode.
params:
type:
description: >
The type of IP Address this is, can be one of "public" or "private".
Public IP Addresses, over and above the one included with each Linode,
incur an additional monthly charge. If you need an additional Public IP Address
you must request one - please open a ticket.
type: String
value: private
description: >
The type of IP to allocate. Currently only "ipv4" is supported.
value: ipv4
public:
type: Boolean
description: >
Whether this is a public or private IP address.
Public IP Addresses, over and above the one included with each
Linode, incur an additional monthly charge. If you need an
additional Public IP Address you must request one - please
open a ticket.
value: true
examples:
curl: |
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"type": "private"
}' \
-X POST -d '{"type": "ipv4", "public":true}' \
https://$api_root/$version/linode/instances/$linode_id/ips
/linode/instances/$id/ips/$ip_address:
group: IPs
Expand Down Expand Up @@ -929,8 +940,7 @@ endpoints:
authenticated: true
description: >
Deletes all Disks and Configs on this Linode, then deploys a new
Distribution or Image to this Linode with the given attributes. Returns
a JSON object representation of the Linode's disks and configs.
Distribution or Image to this Linode with the given attributes.
methods:
POST:
oauth: linodes:modify
Expand Down
10 changes: 5 additions & 5 deletions src/data/endpoints/managed.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ endpoints:
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
https://$api_root/$version/managed/credentials/$credential_id/revoke
/managed/linode_settings:
/managed/linode-settings:
group: Linode Settings
type: resource
authenticated: true
Expand All @@ -408,8 +408,8 @@ endpoints:
examples:
curl: |
curl -H "Authorization: Bearer $TOKEN" \
https://$api_root/$version/managed/linode_settings
/managed/linode_settings/$id:
https://$api_root/$version/managed/linode-settings
/managed/linode-settings/$id:
group: Linode Settings
type: resource
authenticated: true
Expand All @@ -423,7 +423,7 @@ endpoints:
examples:
curl: |
curl -H "Authorization: Bearer $TOKEN" \
https://$api_root/$version/managed/linode_settings/$linode_settings_id
https://$api_root/$version/managed/linode-settings/$linode_settings_id
PUT:
response: ManagedLinodeSetting
description: >
Expand All @@ -440,7 +440,7 @@ endpoints:
"access": true
}
}' \
https://$api_root/$version/managed/linode_settings/$linode_settings_id
https://$api_root/$version/managed/linode-settings/$linode_settings_id
/managed/stats:
group: Stats
type: Action
Expand Down
63 changes: 22 additions & 41 deletions src/data/endpoints/networking.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,30 +15,43 @@ endpoints:
paginationKey: data
oauth: ips:view
description: >
Returns a list of IP Addresses, including v4 and slaac addresses.
Returns a list of IP Addresses, including v4, slaac, and public v6
addresses.
examples:
curl: |
curl -H "Authorization: Bearer $TOKEN" \
https://$api_root/$version/networking/ips
POST:
response: ipaddress
money: true
oauth: ips:create
description: >
Create a new Public IPv4 Address.
Create a new IPv4 Address.
params:
type:
type: String
description: >
The type of IP to allocate. Currently only "ipv4" is supported.
The type of IP to allocate. Currently only "ipv4" is supported.
value: ipv4
public:
type: Boolean
description: >
Whether this is a public or private IP address.
Public IP Addresses, over and above the one included with each
Linode, incur an additional monthly charge. If you need an
additional Public IP Address you must request one - please
open a ticket.
value: true
linode_id:
type: Integer
description: >
The Linode ID to assign this IP to.
type: Integer
value: 123
examples:
curl: |
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{"type":"ipv4","linode":123}' \
-X POST -d '{"type":"ipv4", "public":true, "linode":123}' \
https://$api_root/$version/networking/ips
/networking/ips/$address:
group: IPs
Expand Down Expand Up @@ -116,39 +129,7 @@ endpoints:
https://$api_root/$version/networking/ipv6/ranges
python: |
my_ipv6s = client.networking.get_ipv6_ranges()
/networking/ipv6/$address:
group: IPv6
type: resource
authenticated: true
description: >
Manage a single IPv6 Address. Address in URL
can be as compressed as you want.
methods:
GET:
response: ipv6-address
oauth: ips:view
description: >
Return a single IPv6 Address.
examples:
curl: |
curl -H "Authorization: Bearer $TOKEN" \
https://$api_root/$version/networking/ipv6/2600:3c01::2:5001
python: |
my_ipv6 = linode.IPv6Address(client, '2600:3c01::2:5001')
PUT:
oauth: ips:modify
description: >
Set RDNS on a single IPv6 Address.
examples:
curl: |
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X PUT -d '{"rdns":"example.org"}' \
https://$api_root/$version/networking/ipv6/2600:3c01::2:5001
python: |
my_ipv6.rdns = 'example.org'
my_ipv6.save()
/networking/ip-assign:
/networking/ipv4/assign:
group: IPv4
type: Strange
authenticated: true
Expand Down Expand Up @@ -183,7 +164,7 @@ endpoints:
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '$SUB_SPEC_EXAMPLE' \
https://$api_root/$version/networking/ip-assign
https://$api_root/$version/networking/ipv4/assign
python: |
linode_1 = linode.Linode(client, 134504)
ip1 = linode_1.ips.ipv4.public[0]
Expand All @@ -192,7 +173,7 @@ endpoints:
ip2 = linode_2.ips.ipv4.public[0]

client.networking.assign_ips(linode_1.region, ip1.to(linode_2), ip2.to(linode_1))
/networking/ip-sharing:
/networking/ipv4/share:
group: IPv4
type: Strange
authenticated: true
Expand Down Expand Up @@ -220,5 +201,5 @@ endpoints:
"linode_id": 12345,
"ips": [ "97.107.143.29", "97.107.143.112" ]
}' \
https://$api_root/$version/networking/ip-sharing
https://$api_root/$version/networking/ipv4/share

16 changes: 0 additions & 16 deletions src/data/endpoints/support.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,22 +62,6 @@ endpoints:
The Block Storage Volume this ticket is regarding, if relevant.
type: Integer
optional: true
managed_issue_type:
description: >
The Managed issue type of this ticket. Do not pass this
unless your account has Managed Services activated.
type: Enum
value: issue
maintenance:
type: String
description: Maintenance
issue:
type: String
description: An issue
request:
type: String
description: Other request
optional: true
curl: |
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
Expand Down
15 changes: 9 additions & 6 deletions src/data/objects/ipaddress.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: IP Address
description: >
An IP Address
An IPv4 Address
schema:
address:
type: String
Expand All @@ -26,16 +26,19 @@ schema:
region:
type: String
value: us-east
description: The region this IP is in.
description: The Region this IP is in.
subnet_mask:
type: String
value: 255.255.255.0
description: The subnet mask.
public:
type: Boolean
value: true
description: Whether this is a public or private IP address.
type:
type: Enum
subtype: IPAddressType
value: public
description: The type of IP Address, either public or private.
type: String
description: The type of IP Address.
value: ipv4
enums:
IPAddressType:
public: Public IP Address.
Expand Down
Loading