Skip to content

Commit 42909a9

Browse files
remove option property
Signed-off-by: Laurent Martin <laurent.martin.l@gmail.com>
1 parent cd30cbb commit 42909a9

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Released: [Place date of release here]
1515
### Breaking Changes
1616

1717
* `config`: Deprecated and removed action `ascp connect`.
18+
* **global**: Deprecated and removed option `property` made redundant with `@:` and dotted values. Instead of `--property=foo bar`, use `@: foo=bar`.
1819

1920
## 4.25.2
2021

docs/README.erb.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6772,7 +6772,7 @@ One can conveniently use the JSON format with prefix `@json:`.
67726772
67736773
### Faspex 5: Inbox selection
67746774
6775-
By default, package operations (`send`, `receive`, `list`) are performed on the user's inbox.
6775+
By default, package operations: `receive` and `list` are performed on the user's inbox.
67766776
67776777
To select another inbox, use option `box` with one of the following values:
67786778
@@ -6805,6 +6805,10 @@ The `Hash` creation **Command Parameter** provided to command corresponds to the
68056805
68066806
Required fields are `title` and `recipients`.
68076807
6808+
> [!NOTE]
6809+
> Option `box` does not select recipient shared inbox.
6810+
> Use parameter `recipients` for that.
6811+
68086812
Example (assuming a default preset is created for the connection information):
68096813
68106814
```shell
@@ -6838,6 +6842,12 @@ Else an exception is sent.
68386842
{"title":"some title","recipients":["user@example.com"]}
68396843
```
68406844
6845+
To send to a shared inbox, specify `recipient_type=shared_inbox`:
6846+
6847+
```json
6848+
{"title":"some title","recipients":[{"recipient_type":"shared_inbox","name":"box name"}]}
6849+
```
6850+
68416851
If the lookup needs to be only on certain types, you can specify the field: `recipient_types` with either a single value or an `Array` of values (from the list above). e.g. :
68426852
68436853
```json

lib/aspera/cli/plugins/base.rb

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ class Base
2222
class << self
2323
def declare_options(options)
2424
options.declare(:query, 'Additional filter for for some commands (list/delete)', allowed: [Hash, Array, NilClass])
25-
options.declare(:property, 'Name of property to set (modify operation)')
2625
options.declare(:bulk, 'Bulk operation (only some)', allowed: Allowed::TYPES_BOOLEAN, default: false)
2726
options.declare(:bfail, 'Bulk operation error handling', allowed: Allowed::TYPES_BOOLEAN, default: true)
2827
end
@@ -213,8 +212,6 @@ def entity_execute(
213212
end
214213
when :modify
215214
parameters = value_create_modify(command: command)
216-
property = options.get_option(:property)
217-
parameters = {property => parameters} unless property.nil?
218215
api.update(one_res_path, parameters)
219216
return Main.result_status('modified')
220217
else
@@ -267,7 +264,7 @@ def value_create_modify(command:, description: nil, type: Hash, bulk: false, def
267264
# @param entity [String,Symbol] API endpoint of entity to list
268265
# @param items_key [String] Key in the result to get the list of items (Default: same as `entity`)
269266
# @param query [Hash,nil] Additional query parameters
270-
# @return [Array] items, total_count
267+
# @return [Array<(Array<Hash>, Integer)>] items, total_count
271268
def list_entities_limit_offset_total_count(
272269
api:,
273270
entity:,

0 commit comments

Comments
 (0)