Skip to content

Commit 52028eb

Browse files
authored
[Update] Fix entity-transfer cli commands (#394)
* Fix entity-transfer CLI commands * Update EntityTransfer schema to fix CLI display * Add warnings to Entity Transfer Create description
1 parent 789fc60 commit 52028eb

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

openapi.yaml

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@ paths:
655655
https://api.linode.com/v4/account/entity-transfers
656656
- lang: CLI
657657
source: >
658-
linode-cli account entity-transfers \
658+
linode-cli entity-transfers \
659659
list
660660
post:
661661
x-linode-grant: unrestricted only
@@ -672,7 +672,18 @@ paths:
672672

673673

674674
When a transfer is [accepted](/docs/api/account/#entity-transfer-accept), the requested entities are moved to
675-
the receiving account. A transfer can take up to three hours to complete once accepted. When a transfer is
675+
the receiving account. Linode services will not experience interruptions due to the transfer process, but
676+
please take note of the following:
677+
678+
679+
- If any of the Linodes included in the request have Backups enabled, that data and associated costs will be
680+
removed/cancelled.
681+
682+
- DNS records will not be transferred or updated. Please ensure that DNS records have been updated or
683+
communicated to the recipient prior to the transfer.
684+
685+
686+
A transfer can take up to three hours to complete once accepted. When a transfer is
676687
completed, billing for transferred entities ends for the sending account and begins for the receiving account.
677688

678689

@@ -740,8 +751,10 @@ paths:
740751
https://api.linode.com/v4/account/entity-transfers
741752
- lang: CLI
742753
source: >
743-
linode-cli account entity-transfers \
744-
create --linodes 111,222
754+
linode-cli entity-transfers \
755+
create \
756+
--entities.linodes 111 \
757+
--entities.linodes 222
745758
/account/entity-transfers/{token}:
746759
x-linode-cli-command: entity-transfers
747760
parameters:
@@ -786,7 +799,7 @@ paths:
786799
https://api.linode.com/v4/account/entity-transfers/123E4567-E89B-12D3-A456-426614174000
787800
- lang: CLI
788801
source: >
789-
linode-cli account entity-transfers \
802+
linode-cli entity-transfers \
790803
view 123E4567-E89B-12D3-A456-426614174000
791804
delete:
792805
x-linode-grant: unrestricted only
@@ -805,7 +818,7 @@ paths:
805818

806819
This command can only be accessed by the unrestricted users of the account that created this transfer.
807820
operationId: deleteEntityTransfer
808-
x-linode-cli-action: delete
821+
x-linode-cli-action: cancel
809822
security:
810823
- personalAccessToken: []
811824
- oauth:
@@ -828,8 +841,8 @@ paths:
828841
https://api.linode.com/v4/account/entity-transfers/123E4567-E89B-12D3-A456-426614174000
829842
- lang: CLI
830843
source: >
831-
linode-cli account entity-transfers \
832-
delete 123E4567-E89B-12D3-A456-426614174000
844+
linode-cli entity-transfers \
845+
cancel 123E4567-E89B-12D3-A456-426614174000
833846
/account/entity-transfers/{token}/accept:
834847
x-linode-cli-command: entity-transfers
835848
parameters:
@@ -907,7 +920,7 @@ paths:
907920
https://api.linode.com/v4/account/entity-transfers/123E4567-E89B-12D3-A456-426614174000/accept
908921
- lang: CLI
909922
source: >
910-
linode-cli account entity-transfers \
923+
linode-cli entity-transfers \
911924
accept 123E4567-E89B-12D3-A456-426614174000
912925
/account/events:
913926
x-linode-cli-command: events
@@ -16059,7 +16072,15 @@ components:
1605916072
The token used to identify and accept or cancel this transfer.
1606016073
example: "123E4567-E89B-12D3-A456-426614174000"
1606116074
status:
16075+
x-linode-cli-display: 2
1606216076
x-linode-filterable: true
16077+
x-linode-cli-color:
16078+
accepted: yellow
16079+
cancelled: red
16080+
completed: green
16081+
failed: red
16082+
pending: yellow
16083+
stale: red
1606316084
type: string
1606416085
enum:
1606516086
- accepted
@@ -16073,7 +16094,7 @@ components:
1607316094

1607416095

1607516096
`accepted`: The transfer has been accepted by another user and is currently in progress.
16076-
Transfers can take several hours to complete.
16097+
Transfers can take up to 3 hours to complete.
1607716098

1607816099

1607916100
`cancelled`: The transfer has been cancelled by the sender.
@@ -16104,12 +16125,14 @@ components:
1610416125
When this transfer was last updated.
1610516126
example: '2021-02-11T16:37:03'
1610616127
is_sender:
16128+
x-linode-cli-display: 4
1610716129
x-linode-filterable: true
1610816130
type: boolean
1610916131
description: >
1611016132
If the requesting account created this transfer.
1611116133
example: true
1611216134
expiry:
16135+
x-linode-cli-display: 3
1611316136
type: string
1611416137
format: date-time
1611516138
description: >
@@ -16121,6 +16144,7 @@ components:
1612116144
A collection of the entities to include in this transfer request, separated by type.
1612216145
properties:
1612316146
linodes:
16147+
x-linode-cli-display: 5
1612416148
type: array
1612516149
items:
1612616150
type: integer

0 commit comments

Comments
 (0)