Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Correct XML docs for DataModel Attributes #3547

Merged
merged 2 commits into from
Nov 12, 2024
Merged

Correct XML docs for DataModel Attributes #3547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8863a7
Chore: Correct Attribute XML docs
JacobMikkelsen Nov 10, 2024
3c8c624
chore: Add developer configuration file
dscpinheiro Nov 12, 2024
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
11 changes: 11 additions & 0 deletions generator/.DevConfigs/41e192e0-a1cd-4de1-a0c1-e4740980a921.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"services": [
{
"serviceName": "DynamoDBv2",
"type": "patch",
"changeLogMessages": [
"Pull Request [#3547](https://github.com/aws/aws-sdk-net/pull/3547): Correct XML docs for DataModel attributes"
]
}
]
}
22 changes: 11 additions & 11 deletions sdk/src/Services/DynamoDBv2/Custom/DataModel/Attributes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ public DynamoDBPropertyAttribute(string attributeName, bool storeAsEpoch)
/// DynamoDB property that marks up current member as a hash key element.
/// Exactly one member in a class must be marked with this attribute.
///
/// Members that are marked as hash key must be convertible to
/// Members that are marked as a hash key must be convertible to
/// a Primitive object.
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = true, AllowMultiple = false)]
Expand Down Expand Up @@ -358,14 +358,14 @@ public DynamoDBRangeKeyAttribute(string attributeName, Type converter)
public class DynamoDBGlobalSecondaryIndexHashKeyAttribute : DynamoDBHashKeyAttribute
{
/// <summary>
/// Index associated with this range key
/// Indexes associated with this hash key.
/// </summary>
public string[] IndexNames { get; set; }

/// <summary>
/// Constructor that accepts a single inde name.
/// Constructor that accepts a single index name.
/// </summary>
/// <param name="indexName">Name of the Local Secondary Index this range key belongs to.</param>
/// <param name="indexName">Name of the Global Secondary Index this hash key belongs to.</param>
public DynamoDBGlobalSecondaryIndexHashKeyAttribute(string indexName)
: base()
{
Expand All @@ -375,7 +375,7 @@ public DynamoDBGlobalSecondaryIndexHashKeyAttribute(string indexName)
/// <summary>
/// Constructor that accepts multiple index names.
/// </summary>
/// <param name="indexNames">Names of the Local Secondary Indexes this range key belongs to.</param>
/// <param name="indexNames">Names of the Global Secondary Indexes this hash key belongs to.</param>
public DynamoDBGlobalSecondaryIndexHashKeyAttribute(params string[] indexNames)
: base()
{
Expand All @@ -390,14 +390,14 @@ public DynamoDBGlobalSecondaryIndexHashKeyAttribute(params string[] indexNames)
public class DynamoDBGlobalSecondaryIndexRangeKeyAttribute : DynamoDBRangeKeyAttribute
{
/// <summary>
/// Index associated with this range key
/// Indexes associated with this range key.
/// </summary>
public string[] IndexNames { get; set; }

/// <summary>
/// Constructor that accepts a single inde name.
/// Constructor that accepts a single index name.
/// </summary>
/// <param name="indexName">Name of the Local Secondary Index this range key belongs to.</param>
/// <param name="indexName">Name of the Global Secondary Index this range key belongs to.</param>
public DynamoDBGlobalSecondaryIndexRangeKeyAttribute(string indexName)
: base()
{
Expand All @@ -407,7 +407,7 @@ public DynamoDBGlobalSecondaryIndexRangeKeyAttribute(string indexName)
/// <summary>
/// Constructor that accepts multiple index names.
/// </summary>
/// <param name="indexNames">Names of the Local Secondary Indexes this range key belongs to.</param>
/// <param name="indexNames">Names of the Global Secondary Indexes this range key belongs to.</param>
public DynamoDBGlobalSecondaryIndexRangeKeyAttribute(params string[] indexNames)
: base()
{
Expand All @@ -425,12 +425,12 @@ public DynamoDBGlobalSecondaryIndexRangeKeyAttribute(params string[] indexNames)
public sealed class DynamoDBLocalSecondaryIndexRangeKeyAttribute : DynamoDBPropertyAttribute
{
/// <summary>
/// Index associated with this range key
/// Indexes associated with this range key.
/// </summary>
public string[] IndexNames { get; set; }

/// <summary>
/// Constructor that accepts a single inde name.
/// Constructor that accepts a single index name.
/// </summary>
/// <param name="indexName">Name of the Local Secondary Index this range key belongs to.</param>
public DynamoDBLocalSecondaryIndexRangeKeyAttribute(string indexName)
Expand Down