aspera-cli 4.23.0 → 4.24.1

data/lib/aspera/transfer/spec.schema.yaml

@@ -7,52 +7,54 @@ title: Aspera Transfer Specification
 description: Information defining an Aspera transfer.
 type: object
 required:
-- destination_root
-- direction
-- paths
-- remote_host
-- remote_user
+  - destination_root
+  - direction
+  - paths
+  - remote_host
+  - remote_user
 properties:
   apply_local_docroot:
     description: Apply local docroot to source paths.
     x-agents:
-    - direct
-    - transferd
+      - direct
+      - transferd
     x-cli-switch: true
   cipher:
     description: In transit encryption algorithms.
     enum:
-    - none
-    - aes-128
-    - aes-192
-    - aes-256
-    - aes-128-cfb
-    - aes-192-cfb
-    - aes-256-cfb
-    - aes-128-gcm
-    - aes-192-gcm
-    - aes-256-gcm
+      - none
+      - aes-128
+      - aes-192
+      - aes-256
+      - aes-128-cfb
+      - aes-192-cfb
+      - aes-256-cfb
+      - aes-128-gcm
+      - aes-192-gcm
+      - aes-256-gcm
     default: none
-    x-cli-option: "-c"
+    x-cli-option: -c
     x-cli-convert: remove_hyphen
   content_protection:
-    description: Enable client-side encryption at rest. (CSEAR, content protection)
+    description: Enable client-side encryption at rest (CSEAR).
+      (content protection)
     enum:
-    - encrypt
-    - decrypt
-    x-cli-option: "--file-crypt"
+      - encrypt
+      - decrypt
+    x-cli-option: --file-crypt
   content_protection_password:
-    description: "Specifies CSEAR password. (content protection)"
+    description: Specifies CSEAR password.
+      (content protection)
     type: string
     x-cli-envvar: ASPERA_SCP_FILEPASS
   cookie:
-    description: Metadata for transfer specified by application
+    description: Metadata for transfer specified by application.
     type: string
     x-cli-envvar: ASPERA_SCP_COOKIE
   create_dir:
     description: Specifies whether to create new directories.
     type: boolean
-    x-cli-option: "-d"
+    x-cli-option: -d
     x-cli-switch: true
   delete_before_transfer:
     description: >-
@@ -63,14 +65,15 @@ properties:
       Objects on the destination that have the same name but different type or size as objects
       on the source are not deleted.
     x-cli-switch: true
-  delete_source: # duplicate of remove_after_transfer ?
-    description: Remove SRC files after transfer success
+  delete_source:
+    description: Remove transfered source files after transfer success.
+      TODO equivalent to `remove_after_transfer` + `remove_empty_directories` + `remove_empty_source_directory`
     type: boolean
     x-agents:
-    - node
-    - direct
-    - transferd
-    x-cli-option: "--remove-after-transfer"
+      - node
+      - direct
+      - transferd
+    x-cli-option: --remove-after-transfer
     x-cli-switch: true
   destination_root:
     description: Destination root directory.
@@ -82,13 +85,13 @@ properties:
       Required when using Bearer token auth for the destination node.
     type: string
     x-agents:
-    - transferd
+      - transferd
   direction:
-    description: 'Direction of transfer (on client side)'
+    description: Direction of transfer (on client side).
     enum:
-    - send
-    - receive
-    x-cli-option: "--mode"
+      - send
+      - receive
+    x-cli-option: --mode
     x-cli-convert:
       receive: recv
       send: send
@@ -97,102 +100,102 @@ properties:
       Exclude files, but not directories, from the transfer if they are newer
       than the specified number of seconds added to the source computer's epoch.
 
-      e.g. "-86400" for newer than a day back.
+      e.g. `-86400` for newer than a day back.
     type: string
   exclude_older_than:
     description: >-
       Exclude files, but not directories, from the transfer if they are older
       than the specified number of seconds added to the source computer's epoch.
 
-      e.g. "-86400" for older than a day back.
+      e.g. `-86400` for older than a day back.
     type: string
   fail_bad_filepass:
     description: Fail on bad file decryption passphrase.
     type: boolean
     x-cli-switch: true
     x-agents:
-    - direct
-    - transferd
+      - direct
+      - transferd
   fasp_port:
     description: Specifies fasp (UDP) port.
     type: integer
     default: 33001
-    x-cli-option: "-O"
+    x-cli-option: -O
   fasp_proxy:
-    description: Proxy for communications between the remote server and the (local) client. 
+    description: Proxy for communications between the remote server and the (local) client.
     type: object
     x-agents:
-    - transferd
+      - transferd
   file_checksum:
-    description: "Enable checksum reporting for transferred files by specifying the hash to use."
+    description: Enable checksum reporting for transferred files by specifying the hash to use.
     enum:
-    - sha-512
-    - sha-384
-    - sha-256
-    - sha1
-    - md5
-    - none
+      - sha-512
+      - sha-384
+      - sha-256
+      - sha1
+      - md5
+      - none
     default: none
     x-agents:
-    - node
-    - direct
+      - node
+      - direct
   http_fallback:
     description: When true(1), attempts to perform an HTTP transfer if a FASP transfer cannot be performed.
     type:
-    - boolean
-    - string
-    x-cli-option: "-y"
+      - boolean
+      - string
+    x-cli-option: -y
     x-cli-convert:
       force: F
       true: 1
       false: 0
   http_fallback_port:
-    description: Specifies http port when no cipher is used
+    description: Specifies HTTP port when no cipher is used.
     type: integer
-    x-cli-option: "-t"
+    x-cli-option: -t
   https_fallback_port:
-    description: Specifies https port when cipher is used
+    description: Specifies HTTPS port when cipher is used.
     type: integer
-    x-cli-option: "-t"
+    x-cli-option: -t
   icos:
     description: Configuration parameters for IBM Cloud Object Storage (ICOS).
     type: object
     x-agents:
-    - transferd
+      - transferd
   lock_min_rate:
     description: "TODO: remove ?"
     type: boolean
     x-agents:
-    - connect
+      - connect
   lock_min_rate_kbps:
     description: >-
-      If true, lock the minimum transfer rate to the value set for min_rate_kbps.
+      If `true`, lock the minimum transfer rate to the value set for min_rate_kbps.
 
-      If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.
+      If `false`, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.
     type: boolean
     x-agents:
-    - transferd
-    - connect
+      - transferd
+      - connect
   lock_rate_policy:
-    description: If true, lock the rate policy to the default value.
+    description: If `true`, lock the rate policy to the default value.
     type: boolean
     x-agents:
-    - transferd
-    - connect
+      - transferd
+      - connect
   lock_target_rate:
     description: "TODO: remove ?"
     type: boolean
     x-agents:
-    - connect
+      - connect
   lock_target_rate_kbps:
     description: >-
-      If true, lock the target transfer rate to the default value set for target_rate_kbps.
+      If `true`, lock the target transfer rate to the default value set for target_rate_kbps.
 
-      If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.
+      If `false`, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.
     type: boolean
     x-agents:
-    - transferd
-    - connect
+      - transferd
+      - connect
   min_rate_cap_kbps:
     description: >-
       The highest minimum rate that an incoming transfer can request, in kilobits per second.
@@ -202,26 +205,44 @@ properties:
       The default value of unlimited applies no cap to the minimum rate. (Default: 0)
     type: integer
     x-agents:
-    - connect
-    - transferd
+      - connect
+      - transferd
   move_after_transfer:
     description: >-
-      The relative path to which the files will be moved after the transfer at the source side.
+      Move source files to the specified `archive-dir` directory after they are transferred correctly.
+
       Available as of 3.8.0.
+      Details in ascp manual.
+
+      Requires write permissions on the source.
+
+      If `src_base` is specified, files are moved to `archive-dir`/`path-relative-to-srcbase`.
+
+      `archive-dir` must be in the same file system (or cloud storage account) as the source files being transferred.
+
+      `archive-dir` is subject to the same docroot restrictions as source files.
+
+      `move_after_transfer` and `remove_after_transfer` are mutually exclusive options.
+
+      After files have been moved to the archive, the original source directory structure is left in place.
+      Empty directories are not saved to `archive-dir`.
+      To remove empty source directories after a successful move operation, also set `remove_empty_directories` to `true`.
+      When using `remove_empty_directories`, empty directory removal examination starts at the `srcbase` and proceeds down any subdirectories.
+      If no `srcbase` is used and a file path (as opposed to a directory path) is specified, then only the immediate parent directory is examined and removed if it is empty following the move of the source file.
     type: string
     x-agents:
-    - direct
-    - node
-    - transferd
+      - direct
+      - node
+      - transferd
   multi_session:
     description: >-
       Use multi-session transfer. max 128.
 
       Each participant on one host needs an independent UDP (-O) port.
 
-      Large files are split between sessions only when transferring with resume_policy=none.
+      Large files are split between sessions only when transferring with `resume_policy`=`none`.
     type: integer
-    x-cli-option: "-C"
+    x-cli-option: -C
     x-cli-special: true
   multi_session_threshold:
     description: >-
@@ -231,68 +252,68 @@ properties:
       (0=no file is split)
     type: integer
     x-agents:
-    - direct
-    - node
-    - transferd
+      - direct
+      - node
+      - transferd
   overwrite:
     description: >-
       Overwrite files at the destination with source files of the same name based 
       on the policy:
-      
-      - always – Always overwrite the file.
-      
-      - never – Never overwrite the file.
+
+      - `always` : Always overwrite the file.
+
+      - `never` : Never overwrite the file.
       If the destination contains partial files that are older or the same 
       as the source files and resume is enabled, the partial files resume transfer.
       Partial files with checksums or sizes that differ from the source files 
       are not overwritten.
-      
-      - diff – Overwrite the file if it is different from the source, 
-      depending on the compare method (default is size). 
-      If the destination is object storage, diff has the same effect as always. 
+
+      - `diff` : (default) Overwrite the file if it is different from the source, 
+      depending on the compare method (default is size).
+      If the destination is object storage, `diff` has the same effect as always.
       If resume is not enabled, partial files are overwritten if they are different 
-      from the source, otherwise they are skipped. 
+      from the source, otherwise they are skipped.
       If resume is enabled, only partial files with different sizes or checksums 
-      from the source are overwritten; otherwise, files resume. 
-      
-      - diff+older – Overwrite the file if it is older and different from the source, 
-      depending on the compare method (default is size). 
+      from the source are overwritten; otherwise, files resume.
+
+      - `diff+older` : Overwrite the file if it is older and different from the source, 
+      depending on the compare method (default is size).
       If resume is not enabled, partial files are overwritten if they are older 
-      and different from the source, otherwise they are skipped. 
+      and different from the source, otherwise they are skipped.
       If resume is enabled, only partial files that are different and older than 
-      the source are overwritten, otherwise they are resumed. 
-      
-      - older – Overwrite the file if its timestamp is older than the source timestamp. 
-
-      If you set an overwrite policy of diff or diff+older, difference is determined 
-      by the value set for resume_policy:
-      
-      "none" - the source and destination files are always considered different and 
+      the source are overwritten, otherwise they are resumed.
+
+      - `older` : Overwrite the file if its timestamp is older than the source timestamp.
+
+      If you set an overwrite policy of `diff` or `diff+older`, difference is determined 
+      by the value set for `resume_policy`:
+
+      `none` : The source and destination files are always considered different and 
       the destination file is always overwritten
-      
-      "attributes" - the source and destination files are compared based on file attributes 
-      
-      "sparse_checksum" - the source and destination files are compared based on sparse checksums, (currently file size)
-      
-      "full_checksum" - the source and destination files are compared based on full checksums 
+
+      `attributes` : The source and destination files are compared based on file attributes 
+
+      `sparse_checksum` : The source and destination files are compared based on sparse checksums, (currently file size)
+
+      `full_checksum` : The source and destination files are compared based on full checksums
     default: diff
     enum:
-    - never
-    - always
-    - diff
-    - older
-    - diff+older
+      - never
+      - always
+      - diff
+      - older
+      - diff+older
   password:
     description: >-
-      Password for local Windows user when transfer user associated with node api user is not
-      the same as the one running asperanoded.
+      Password for local Windows user when transfer user associated with node API user is not
+      the same as the one running `asperanoded`.
 
       Allows impersonating the transfer user and have access to resources (e.g. network shares).
 
-      Windows only, node api only.
+      Windows only, node API only.
     type: string
     x-agents:
-    - node
+      - node
   paths:
     description: Array of path to the source (required) and a path to the destination (optional).
     type: array
@@ -309,46 +330,45 @@ properties:
       the timestamp that is preserved is the one just before to the transfer.
     x-cli-switch: true
   preserve_acls:
-    description: "Preserve access control lists."
+    description: Preserve access control lists.
     enum:
-    - none
-    - native
-    - metafile
+      - none
+      - native
+      - metafile
     default: none
     x-agents:
-    - direct
-    - transferd
+      - direct
+      - transferd
   preserve_creation_time:
     description: >-
-      (Windows only) Preserve source-file creation timestamps at the destination.
+      Preserve source-file creation timestamps at the destination.
 
       Only Windows systems retain information about creation time.
-
       If the destination is not a Windows computer, this option is ignored.
     x-cli-switch: true
   preserve_extended_attrs:
-    description: "Preserve the extended attributes."
+    description: Preserve the extended attributes.
     enum:
-    - none
-    - native
-    - metafile
+      - none
+      - native
+      - metafile
     default: none
     x-agents:
-    - transferd
-    x-cli-option: "--preserve-xattrs"
+      - transferd
+    x-cli-option: --preserve-xattrs
   preserve_file_owner_gid:
-    description: Preserve the group ID for a file owner
+    description: Preserve the group ID for a file owner.
     type: boolean
     x-agents:
-    - transferd
-    - direct
+      - transferd
+      - direct
     x-cli-switch: true
   preserve_file_owner_uid:
-    description: Preserve the user ID for a file owner
+    description: Preserve the user ID for a file owner.
     type: boolean
     x-agents:
-    - transferd
-    - direct
+      - transferd
+      - direct
     x-cli-switch: true
   preserve_modification_time:
     description: >-
@@ -358,159 +378,161 @@ properties:
       Preserve source-file modification timestamps at the destination.
     x-cli-switch: true
   preserve_remote_acls:
-    description: "Preserve remote access control lists."
+    description: Preserve remote access control lists.
     enum:
-    - none
-    - native
-    - metafile
+      - none
+      - native
+      - metafile
     default: none
     x-agents:
-    - transferd
-    - direct
-    x-cli-option: "--remote-preserve-acls"
+      - transferd
+      - direct
+    x-cli-option: --remote-preserve-acls
   preserve_remote_extended_attrs:
-    description: "Preserve remote extended attributes."
+    description: Preserve remote extended attributes.
     enum:
-    - none
-    - native
-    - metafile
+      - none
+      - native
+      - metafile
     default: none
     x-agents:
-    - transferd
-    - direct
-    x-cli-option: "--remote-preserve-xattrs"
+      - transferd
+      - direct
+    x-cli-option: --remote-preserve-xattrs
   preserve_source_access_time:
-    description: Preserve the time logged for when the source file was accessed
+    description: Preserve the time logged for when the source file was accessed.
     type: boolean
     x-agents:
-    - transferd
-    - direct
+      - transferd
+      - direct
     x-cli-switch: true
   preserve_times:
     description: Preserve file timestamps.
     type: boolean
     x-agents:
-    - transferd
-    - node
-    - direct
-    x-cli-option: "-p"
+      - transferd
+      - node
+      - direct
+    x-cli-option: -p
   rate_policy:
     description: >-
       The transfer rate policy to use when sharing bandwidth.
       Allowable values:
-      
-      - high : When sharing bandwidth, transfer at twice the rate of a transfer using a fair policy.
-      
-      - fair : (Default) Share bandwidth equally with other traffic.
-      
-      - low : Use only unused bandwidth.
-      
-      - fixed : Transfer at the target rate, regardless of the actual network capacity.
+
+      - `high` : When sharing bandwidth, transfer at twice the rate of a transfer using a fair policy.
+
+      - `fair` : (Default) Share bandwidth equally with other traffic.
+
+      - `low` : Use only unused bandwidth.
+
+      - `fixed` : Transfer at the target rate, regardless of the actual network capacity.
       Do not share bandwidth.
       Aspera recommends that you do not use this setting except under special circumstances, 
-      otherwise the destination storage can be damaged. 
+      otherwise the destination storage can be damaged.
     enum:
-    - low
-    - fair
-    - high
-    - fixed
-    x-cli-option: "--policy"
+      - low
+      - fair
+      - high
+      - fixed
+    x-cli-option: --policy
   remote_access_key:
     description: The access key ID of the access key that was used to construct the bearer token that is used to authenticate to the remote node.
     type: string
     x-agents:
-    - transferd
+      - transferd
   remote_host:
-    description: IP or fully qualified domain name of the remote server
-    x-cli-option: "--host"
+    description: IP or fully qualified domain name (FQDN) of the remote server.
+    x-cli-option: --host
   remote_password:
-    description: SSH session password
+    description: SSH session password.
     x-cli-envvar: ASPERA_SCP_PASS
   remote_user:
-    description: Remote user. Default value is "xfer" on node or connect.
-    x-cli-option: "--user"
+    description: Remote user. Default value is `xfer` on node or connect.
+    x-cli-option: --user
   remove_after_transfer:
-    description: Remove SRC files after transfer success
+    description: Remove SRC files after transfer success.
     type: boolean
     x-agents:
-    - direct
-    - node
-    - transferd
+      - direct
+      - node
+      - transferd
     x-cli-switch: true
   remove_empty_directories:
     description: Specifies whether to remove empty directories.
     type: boolean
     x-agents:
-    - direct
-    - node
-    - transferd
+      - direct
+      - node
+      - transferd
     x-cli-switch: true
   remove_empty_source_dir:
     description: Remove empty source subdirectories and remove the source directory itself, if empty.
     type: boolean
     x-agents:
-    - transferd
+      - transferd
   remove_empty_source_directory:
     description: Remove empty source subdirectories and remove the source directory itself, if empty.
     type: boolean
     x-agents:
-    - direct
+      - direct
     x-cli-switch: true
   remove_skipped:
-    description: Must also have remove_after_transfer set to true, Defaults to false, if true, skipped files will be removed as well.
+    description: Must also have `remove_after_transfer` set to `true`.
+      Defaults to `false`.
+      If `true`, skipped files will be removed as well.
     type: boolean
     x-agents:
-    - direct
-    - connect
-    - node
+      - direct
+      - connect
+      - node
     x-cli-switch: true
   proxy:
     description: >-
       Specify the address of the Aspera high-speed proxy server.
 
-      dnat(s)://[user[:password]@]server:port
+      `dnat(s)://[user[:password]@]server:port`
 
       Default ports for DNAT and DNATS protocols are 9091 and 9092.
 
-      Password, if specified here, overrides the value of environment variable ASPERA_PROXY_PASS.
+      Password, if specified here, overrides the value of environment variable `ASPERA_PROXY_PASS`.
     x-agents:
-    - direct
-    - noded
+      - direct
+      - noded
   resume_policy:
     description: >-
       If a transfer is interrupted or fails to finish,
       this policy directs the transfer to resume without retransferring the files.
       Allowable values:
-      
-      - none : Always re-transfer the entire file
-      
-      - attrs : Compare file attributes and resume if they match, and re-transfer if they do not
-      
-      - sparse_csum : Compare file attributes and the sparse file checksums; resume if they match, and re-transfer if they do not
-      
-      - full_csum : Compare file attributes and the full file checksums; resume if they match, and re-transfer if they do not. 
-
-      Note: transferd uses values: attributes, sparse_checksum, full_checksum.
+
+      - `none` : Always re-transfer the entire file.
+
+      - `attrs` : Compare file attributes and resume if they match, and re-transfer if they do not.
+
+      - `sparse_csum` : Compare file attributes and the sparse file checksums; resume if they match, and re-transfer if they do not.
+
+      - `full_csum` : Compare file attributes and the full file checksums; resume if they match, and re-transfer if they do not.
+
+      Note: transferd uses values: `attributes`, `sparse_checksum`, `full_checksum`.
     default: faspmgr:none;other:sparse_csum
     enum:
-    - none
-    - attrs
-    - sparse_csum
-    - full_csum
-    x-cli-option: "-k"
+      - none
+      - attrs
+      - sparse_csum
+      - full_csum
+    x-cli-option: -k
     x-cli-convert:
       none: 0
       attrs: 1
       sparse_csum: 2
       full_csum: 3
   retry_duration:
-    description: Specifies how long to wait before retrying transfer. (e.g. "5min")
+    description: Specifies how long to wait before retrying transfer (e.g. `5min`).
     $comment: "TODO: check this."
     type:
-    - integer
-    - string
+      - integer
+      - string
     x-agents:
-    - transferd
+      - transferd
   save_before_overwrite:
     description: >-
       If a transfer would result in an existing file <filename>.<ext> being overwritten,
@@ -522,33 +544,33 @@ properties:
       File attributes are maintained in the renamed file.
     x-cli-switch: true
     x-agents:
-    - direct
-    - node
-    - transferd
+      - direct
+      - node
+      - transferd
   skip_duplicate_check:
     description: Don't check for duplicate files at the destination.
     type: boolean
     x-agents:
-    - transferd
-    - direct
-    x-cli-option: "--skip-dir-traversal-dupes"
+      - transferd
+      - direct
+    x-cli-option: --skip-dir-traversal-dupes
     x-cli-switch: true
   skip_special_files:
     description: >-
       All assets other than files, directories and symbolic links are considered special.
       A transfer will fail if the user attempts to transfer special assets.
-      If true, ascp skips special assets and proceeds with the transfer of all other assets. 
+      If `true`, `ascp` skips special assets and proceeds with the transfer of all other assets.
     type: boolean
     x-agents:
-    - transferd
-    - direct
+      - transferd
+      - direct
     x-cli-switch: true
   source_root:
     description: >-
       Path to be prepended to each source path.
 
       This is either a conventional path or it can be a URI but only if there is no root defined.
-    x-cli-option: "--source-prefix64"
+    x-cli-option: --source-prefix64
     x-cli-convert: base64
   source_root_id:
     description: >-
@@ -556,8 +578,8 @@ properties:
       Required when using Bearer token auth for the source node.
     type: string
     x-agents:
-    - transferd
-    - node
+      - transferd
+      - node
   src_base:
     description: >-
       Specify the prefix to be stripped off from each source object.
@@ -566,23 +588,23 @@ properties:
 
       Special care must be taken when used with cloud storage.
     x-agents:
-    - direct
-    - node
-    - transferd
-    x-cli-option: "--src-base64"
+      - direct
+      - node
+      - transferd
+    x-cli-option: --src-base64
     x-cli-convert: base64
   src_base64:
     description: The folder name below which the directory structure is preserved (base64 encoded).
     type: string
     x-agents:
-    - transferd
-    - direct
-    x-cli-option: "--src-base64"
+      - transferd
+      - direct
+    x-cli-option: --src-base64
   ssh_port:
     description: Specifies SSH (TCP) port.
     default: "direct:22, other:33001"
     type: integer
-    x-cli-option: "-P"
+    x-cli-option: -P
   ssh_private_key:
     description: >-
       Private key used for SSH authentication.
@@ -591,145 +613,146 @@ properties:
 
       Note the JSON encoding: &bsol;n for newlines.
     x-agents:
-    - direct
-    - transferd
+      - direct
+      - transferd
     x-cli-envvar: ASPERA_SCP_KEY
   ssh_private_key_passphrase:
     description: The passphrase associated with the transfer user's SSH private key. Available as of 3.7.2.
     type: string
     x-agents:
-    - transferd
-    - direct
+      - transferd
+      - direct
     x-cli-envvar: ASPERA_SCP_PASS
   ssh_private_key_path:
     description: Path to private key for SSH.
     type: string
     x-agents:
-    - transferd
-    - direct
-    x-cli-option: "-i"
+      - transferd
+      - direct
+    x-cli-option: -i
   ssh_args:
     description: Array of arguments to pass to SSH. Use with caution.
     type: array
     x-agents:
-    - transferd
-    x-cli-option: "-i"
+      - transferd
+    x-cli-option: --ssh-args
   symlink_policy:
-    description: "Handle source side symbolic links"
+    description: Handle source side symbolic links.
     enum:
-    - follow
-    - copy
-    - copy+force
-    - skip
+      - follow
+      - copy
+      - copy+force
+      - skip
     default: follow
-    x-cli-option: "--symbolic-links"
+    x-cli-option: --symbolic-links
   tags:
     description: >-
       Metadata for transfer as JSON.
       Key `aspera` is reserved.
-      Key `aspera.xfer_retry` specifies a retry timeout for node api initiated transfers.
+      Key `aspera.xfer_retry` specifies a retry timeout for node API initiated transfers.
     type: object
-    x-cli-option: "--tags64"
+    x-cli-option: --tags64
     x-cli-convert: json64
   tags64:
     description: >-
       Metadata for transfer as JSON.
       Key `aspera` is reserved.
-      Key `aspera.xfer_retry` specifies a retry timeout for node api initiated transfers.
+      Key `aspera.xfer_retry` specifies a retry timeout for node API initiated transfers.
     type: string
     x-agents:
-    - transferd
-    - direct
+      - transferd
+      - direct
   target_rate_cap_kbps:
     description: >-
-      Maximum target rate for incoming transfers, in kilobits per second. 
+      Maximum target rate for incoming transfers, in kilobits per second.
       Returned by upload/download_setup node API.
     type: integer
     x-agents:
-    - connect
-    - transferd
+      - connect
+      - transferd
   target_rate_kbps:
     description: Specifies desired speed for the transfer.
     type: integer
-    x-cli-option: "-l"
+    x-cli-option: -l
   title:
     description: Title of the transfer.
     type: string
     x-agents:
-    - node
-    - connect
-    - transferd
+      - node
+      - connect
+      - transferd
   token:
-    description: 'Authorization token: Bearer, Basic or ATM (Also arg -W)'
+    description: "Authorization token. Type: Bearer, Basic or ATM. (Also arg -W)"
     x-cli-envvar: ASPERA_SCP_TOKEN
   use_ascp4:
     description: Specify version of protocol. Do not use ascp4.
     type: boolean
     default: false
     x-agents:
-    - direct
-    - node
-    - transferd
+      - direct
+      - node
+      - transferd
     x-cli-special: true
   use_system_ssh:
     description: TODO, comment...
     type: string
     x-agents:
-    - transferd
-    - direct
-    x-cli-option: "-SSH"
+      - transferd
+      - direct
+    x-cli-option: -SSH
   keepalive:
     description: The session is running in persistent session mode.
     x-agents:
-    - transferd
-    - direct
+      - transferd
+      - direct
     x-cli-switch: true
   dgram_size:
-    description: UDP datagram size in bytes
+    description: UDP datagram size in bytes.
     type: integer
-    x-cli-option: "-Z"
+    x-cli-option: -Z
   min_rate_kbps:
     description: Set the minimum transfer rate in kilobits per second.
     type: integer
     default: 0
-    x-cli-option: "-m"
+    x-cli-option: -m
   sshfp:
     description: Check it against server SSH host key fingerprint.
-    x-cli-option: "--check-sshfp"
+    x-cli-option: --check-sshfp
   target_rate_percentage:
     description: "TODO: remove ?"
     x-agents: []
   rate_policy_allowed:
-    description: "Specifies most aggressive rate policy that is allowed.\nReturned by node API."
+    description: Specifies most aggressive rate policy that is allowed.
+      Returned by node API.
     enum:
-    - low
-    - fair
-    - high
-    - fixed
+      - low
+      - fair
+      - high
+      - fixed
     x-agents:
-    - connect
+      - connect
   fasp_url:
     description: Only used in Faspex.
     x-agents: []
   authentication:
-    description: 'value=token for SSH bypass keys, else password asked if not provided.'
+    description: Set to `token` for SSH bypass keys, else password asked if not provided.
     x-agents:
-    - connect
+      - connect
   cipher_allowed:
-    description: returned by node API. Valid literals include "aes-128" and "none".
+    description: Returned by node API. Valid literals include `aes-128` and `none`.
     x-agents:
-    - connect
+      - connect
   obfuscate_file_names:
-    description: HTTP Gateway obfuscates file names when set to true.
+    description: HTTP Gateway obfuscates file names when set to `true`.
     type: boolean
     x-agents:
-    - httpgw
+      - httpgw
   wss_enabled:
-    description: Server has Web Socket service enabled
+    description: Server has Web Socket service enabled.
     type: boolean
     x-cli-special: true
   wss_port:
-    description: TCP port used for websocket service feed
+    description: TCP port used for websocket service feed.
     type: integer
     x-cli-special: true
   compression:
@@ -750,4 +773,4 @@ properties:
       Shall not exceed aspera.conf `transfer_manager_max_retries` (default 5).
     type: integer
     x-agents:
-    - node
+      - node