[Proposal] Rename verb-first fields in SDK action structs to noun-first naming #1307
renuka-fernando
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Summary
UpstreamRequestModifications,UpstreamResponseModifications, andImmediateResponseto use noun-first naming (e.g.,SetHeaders->HeadersToSet)AppendHeaders(will not be supported)sdk/gateway/policy/v1alpha/action.goMotivation
SetHeaders,RemoveHeaders,AppendHeaders) and noun-first (Body,Path,Method,AnalyticsMetadata), creating inconsistency within the same structmods.SetHeadersread like function calls rather than data access, which is confusing when used alongside genuinely noun-based fieldshttp.Request.Header,http.Request.Body,http.Request.Method)Headers*fields cluster, allQueryParameters*fields cluster)Proposal
Body,Path,Method,StatusCode,Headers,AnalyticsMetadata,DynamicMetadata) unchangedProposed Changes
SetHeadersHeadersToSetRemoveHeadersHeadersToRemoveAppendHeadersAddQueryParametersQueryParametersToAddRemoveQueryParametersQueryParametersToRemoveDropHeadersFromAnalyticsBody,Path,Method,StatusCode,Headers,AnalyticsMetadata,DynamicMetadataOptions for
DropHeadersFromAnalyticsAnalyticsHeaderExclusionsmods.AnalyticsHeaderExclusions = ...HeadersToExcludeFromAnalyticsmods.HeadersToExcludeFromAnalytics = ...HeadersToDropFromAnalyticsmods.HeadersToDropFromAnalytics = ...ExcludedAnalyticsHeadersmods.ExcludedAnalyticsHeaders = ...References
sdk/gateway/policy/v1alpha/action.go- source file with current definitionsBeta Was this translation helpful? Give feedback.
All reactions