-
Notifications
You must be signed in to change notification settings - Fork 10.2k
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.
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
Clarify meaning of the group name specified in WithGroupName #59784
base: main
Are you sure you want to change the base?
Conversation
@@ -115,7 +115,8 @@ public static TBuilder WithName<TBuilder>(this TBuilder builder, string endpoint | |||
/// Sets the <see cref="EndpointGroupNameAttribute"/> for all endpoints produced |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This also seems confusing -- what does it mean to "set an attribute"?
Maybe this should say "Sets the IEndpointGroupNameMetadata" ? or ???
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think this doc comment is attempting to apply a literal description of what this method is doing. It instantiates the EndpointGroupNameAttribute
class and adds it to the metadata collection.
However, that's a means to an end for the real valuable thing which is the fact that EndpointGroupNameAttribute
implements the IEndpointGroupNameMetadata
interface. That's what's actually relevant here so I think your recommendation of referencing the interface instead of the class is a good one.
794c900
to
2854b64
Compare
2854b64
to
b0c117e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Maybe we can put the detail about group name mapping to the OpenAPI document in the docs for IEndpointGroupNameMetadata
itself?
Looks like this PR hasn't been active for some time and the codebase could have been changed in the meantime. |
This PR makes a small change to the description of the value passed to
WithGroupName
to explain how it is used in OpenAPI document generation. The prior text was inaccurate because there is no "GroupName" in the OpenAPI specification.