Skip to content

Commit 239a8c1

Browse files
committed
update comments
1 parent 59753f3 commit 239a8c1

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

Libraries/src/Amazon.Lambda.Annotations/APIGateway/HttpApiAttribute.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ public class HttpApiAttribute : Attribute
2323
public LambdaHttpMethod Method { get; set; }
2424

2525
/// <summary>
26-
/// Name of the HTTP API Lambda authorizer to protect this endpoint.
27-
/// Must match the Name property of an <see cref="HttpApiAuthorizerAttribute"/> in this project.
26+
/// The .NET method name of the HTTP API Lambda authorizer to protect this endpoint.
27+
/// Must match the method name that has the <see cref="HttpApiAuthorizerAttribute"/> applied to it.
28+
/// Use the <c>nameof</c> operator for compile-time safety (e.g. <c>Authorizer = nameof(MyAuthorizerMethod)</c>).
2829
/// Leave null/empty for public (unauthenticated) endpoints.
2930
/// </summary>
3031
public string Authorizer { get; set; }

Libraries/src/Amazon.Lambda.Annotations/APIGateway/RestApiAttribute.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@ public class RestApiAttribute : Attribute
2020
public LambdaHttpMethod Method { get; set; }
2121

2222
/// <summary>
23-
/// Name of the REST API Lambda authorizer to protect this endpoint.
24-
/// Must match the Name property of a <see cref="RestApiAuthorizerAttribute"/> in this project.
23+
/// The .NET method name of the REST API Lambda authorizer to protect this endpoint.
24+
/// Must match the method name that has the <see cref="RestApiAuthorizerAttribute"/> applied to it.
25+
/// Use the <c>nameof</c> operator for compile-time safety (e.g. <c>Authorizer = nameof(MyAuthorizerMethod)</c>).
2526
/// Leave null/empty for public (unauthenticated) endpoints.
2627
/// </summary>
2728
public string Authorizer { get; set; }

0 commit comments

Comments
 (0)