Skip to content

Marked ProxyRequestContext.Error property as Obsolete for APIGatewayProxyRequest. #2217

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

Open
ashishdhingra wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Marked ProxyRequestContext.Error property as Obsolete for APIGatewayProxyRequest. #2217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 .autover/changes/cfe4a449-209e-41ec-9a35-929b0d0d3afb.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"Projects": [
{
"Name": "Amazon.Lambda.APIGatewayEvents",
"Type": "Patch",
"ChangelogMessages": [
"Marked ProxyRequestContext.Error property as Obsolete for APIGatewayProxyRequest."
]
}
]
}
5 changes: 3 additions & 2 deletions Libraries/src/Amazon.Lambda.APIGatewayEvents/APIGatewayProxyRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace Amazon.Lambda.APIGatewayEvents
namespace Amazon.Lambda.APIGatewayEvents
{
using System;
using System.Collections.Generic;
Expand Down Expand Up @@ -234,10 +234,11 @@ public class ProxyRequestContext
/// Gets and sets the operation name.
/// </summary>
public string OperationName { get; set; }

/// <summary>
/// Gets and sets the error.
/// </summary>
[Obsolete("This property is obsolete since it is not processed by the Velocity Template Language engine and is not available as a field to integration request.")]
Copy link
Contributor

@GarrettBeatty GarrettBeatty Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a non obsolete field to recommend instead and if so can you mention that

Copy link
Contributor Author

@ashishdhingra ashishdhingra Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, there is no non-obsolete field. This property should not be used at all for integration. Please refer ticket (ID in description).

Copy link
Member

@normj normj Dec 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect most users wouldn't know the context of "Velocity Template", I had to look it up myself. I suggest keeping the error message a bit more generic that it just isn't used by the service.

This property is obsolete since it is not used by AWS API Gateway and will never have value set by the service.

public string Error { get; set; }

/// <summary>
Expand Down