Skip to content

Commit b1c10f2

Browse files
authored
Improve simple attributes documentation (#3154)
1 parent 60bd46c commit b1c10f2

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

gems/aws-sdk-dynamodb/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Unreleased Changes
22
------------------
33

4+
* Issue - Improve `SimpleAttributes` documentation.
5+
46
1.131.0 (2024-12-03)
57
------------------
68

gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/plugins/simple_attributes.rb

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,30 @@ module Plugins
1313
#
1414
# ddb = Aws::DynamoDB::Client.new(simple_attributes: false)
1515
#
16+
# Members are marshalled using the following objects:
17+
#
18+
# * `Hash` or `#to_h` => `:m`
19+
# * `Array` => `:l`
20+
# * `String` or `Symbol` or `#to_str` => `:s`
21+
# * `Numeric` => `:n`
22+
# * `StringIO` or `IO` => `:b`
23+
# * `Set<Object>` => `:ss` or `:ns` or `:bs`
24+
# * `true` or `false` => `:bool`
25+
# * `nil` => `:null`
26+
#
27+
# Members are unmarshalled into the following objects:
28+
#
29+
# * `:m` => `Hash`
30+
# * `:l` => `Array`
31+
# * `:s` => `String`
32+
# * `:n` => `BigDecimal`
33+
# * `:b` => `StringIO`
34+
# * `:null` => `nil`
35+
# * `:bool` => `true` or `false`
36+
# * `:ss` => `Set<String>`
37+
# * `:ns` => `Set<BigDecimal>`
38+
# * `:bs` => `Set<StringIO>`
39+
#
1640
# ## Input Examples
1741
#
1842
# With this plugin **enabled**, `simple_attributes: true`:
@@ -101,6 +125,8 @@ class SimpleAttributes < Seahorse::Client::Plugin
101125
Disabling this option requires that all attribute values have
102126
their types specified, e.g. `{ s: 'abc' }` instead of simply
103127
`'abc'`.
128+
129+
See {Aws::DynamoDB::Plugins::SimpleAttributes} for more information.
104130
DOCS
105131
) do |config|
106132
!config.simple_json

0 commit comments

Comments
 (0)