Skip to content

Rename Version endpoint rate limit parameter#671

Merged
ziagham merged 1 commit intoflowsynx:masterfrom
mohin-io:fix/607-rename-version-ratelimit-parameter
Nov 7, 2025
Merged

Rename Version endpoint rate limit parameter#671
ziagham merged 1 commit intoflowsynx:masterfrom
mohin-io:fix/607-rename-version-ratelimit-parameter

Conversation

@mohin-io
Copy link
Copy Markdown
Contributor

@mohin-io mohin-io commented Nov 7, 2025

Summary

Aligning the Map override signature with EndpointGroupBase is a solid improvement for consistency across the endpoint registration surface.

In particular, renaming rateLimitPolicy to rateLimitPolicyName makes the parameter’s intent much clearer and avoids the ambiguity around whether we’re passing a policy instance vs. a string key. This matches how the rest of the endpoint group extensions refer to rate-limiting configuration and helps reinforce the pattern for contributors working in this area.

The added XML documentation is also appreciated. It clarifies how the rate-limiting policy name flows from endpoint mapping through to the middleware pipeline, which was previously implicit and required reading internal code to understand. Having this documented in the public surface area reduces onboarding friction for future contributors and keeps the API self-describing.

As noted, there are no behavioral changes — just naming and documentation alignment — which keeps this low risk and improves consistency and maintainability.

I was unable to run dotnet build locally due to the repository currently targeting .NET 9.0 and my environment having only .NET SDK 8.0.415, but the changes here are isolated and do not appear to affect the underlying logic or runtime behavior.

Overall, this cleanup is a meaningful quality-of-life improvement for contributors working in the endpoint grouping layer.

Closes #607 👍

@mohin-io mohin-io requested review from a team as code owners November 7, 2025 22:46
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Nov 7, 2025

@ziagham ziagham merged commit d1d399d into flowsynx:master Nov 7, 2025
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename parameter rateLimitPolicy to rateLimitPolicyName in Version endpoint

2 participants