@@ -12,17 +12,17 @@ namespace Microsoft.AspNetCore.Http
1212 /// Extension methods for adding <see cref="Endpoint.Metadata"/> that is
1313 /// meant to be consumed by OpenAPI libraries.
1414 /// </summary>
15- public static class OpenApiRouteHandlerConventionBuilderExtensions
15+ public static class OpenApiRouteHandlerBuilderExtensions
1616 {
1717 private static readonly ExcludeFromDescriptionAttribute _excludeFromDescriptionMetadataAttribute = new ( ) ;
1818
1919 /// <summary>
2020 /// Adds the <see cref="IExcludeFromDescriptionMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
2121 /// produced by <paramref name="builder"/>.
2222 /// </summary>
23- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
24- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
25- public static RouteHandlerConventionBuilder ExcludeFromDescription ( this RouteHandlerConventionBuilder builder )
23+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
24+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
25+ public static RouteHandlerBuilder ExcludeFromDescription ( this RouteHandlerBuilder builder )
2626 {
2727 builder . WithMetadata ( _excludeFromDescriptionMetadataAttribute ) ;
2828
@@ -34,13 +34,13 @@ public static RouteHandlerConventionBuilder ExcludeFromDescription(this RouteHan
3434 /// produced by <paramref name="builder"/>.
3535 /// </summary>
3636 /// <typeparam name="TResponse">The type of the response.</typeparam>
37- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
37+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
3838 /// <param name="statusCode">The response status code. Defaults to <see cref="StatusCodes.Status200OK"/>.</param>
3939 /// <param name="contentType">The response content type. Defaults to "application/json".</param>
4040 /// <param name="additionalContentTypes">Additional response content types the endpoint produces for the supplied status code.</param>
41- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
41+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
4242#pragma warning disable RS0026
43- public static RouteHandlerConventionBuilder Produces < TResponse > ( this RouteHandlerConventionBuilder builder ,
43+ public static RouteHandlerBuilder Produces < TResponse > ( this RouteHandlerBuilder builder ,
4444#pragma warning restore RS0026
4545 int statusCode = StatusCodes . Status200OK ,
4646 string ? contentType = null ,
@@ -53,14 +53,14 @@ public static RouteHandlerConventionBuilder Produces<TResponse>(this RouteHandle
5353 /// Adds an <see cref="IProducesResponseTypeMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
5454 /// produced by <paramref name="builder"/>.
5555 /// </summary>
56- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
56+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
5757 /// <param name="statusCode">The response status code.</param>
5858 /// <param name="responseType">The type of the response. Defaults to null.</param>
5959 /// <param name="contentType">The response content type. Defaults to "application/json" if responseType is not null, otherwise defaults to null.</param>
6060 /// <param name="additionalContentTypes">Additional response content types the endpoint produces for the supplied status code.</param>
61- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
61+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
6262#pragma warning disable RS0026
63- public static RouteHandlerConventionBuilder Produces ( this RouteHandlerConventionBuilder builder ,
63+ public static RouteHandlerBuilder Produces ( this RouteHandlerBuilder builder ,
6464#pragma warning restore RS0026
6565 int statusCode ,
6666 Type ? responseType = null ,
@@ -87,11 +87,11 @@ public static RouteHandlerConventionBuilder Produces(this RouteHandlerConvention
8787 /// Adds an <see cref="IProducesResponseTypeMetadata"/> with a <see cref="ProblemDetails"/> type
8888 /// to <see cref="EndpointBuilder.Metadata"/> for all builders produced by <paramref name="builder"/>.
8989 /// </summary>
90- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
90+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
9191 /// <param name="statusCode">The response status code.</param>
9292 /// <param name="contentType">The response content type. Defaults to "application/problem+json".</param>
93- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
94- public static RouteHandlerConventionBuilder ProducesProblem ( this RouteHandlerConventionBuilder builder ,
93+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
94+ public static RouteHandlerBuilder ProducesProblem ( this RouteHandlerBuilder builder ,
9595 int statusCode ,
9696 string ? contentType = null )
9797 {
@@ -107,11 +107,11 @@ public static RouteHandlerConventionBuilder ProducesProblem(this RouteHandlerCon
107107 /// Adds an <see cref="IProducesResponseTypeMetadata"/> with a <see cref="HttpValidationProblemDetails"/> type
108108 /// to <see cref="EndpointBuilder.Metadata"/> for all builders produced by <paramref name="builder"/>.
109109 /// </summary>
110- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
110+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
111111 /// <param name="statusCode">The response status code. Defaults to <see cref="StatusCodes.Status400BadRequest"/>.</param>
112112 /// <param name="contentType">The response content type. Defaults to "application/validationproblem+json".</param>
113- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
114- public static RouteHandlerConventionBuilder ProducesValidationProblem ( this RouteHandlerConventionBuilder builder ,
113+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
114+ public static RouteHandlerBuilder ProducesValidationProblem ( this RouteHandlerBuilder builder ,
115115 int statusCode = StatusCodes . Status400BadRequest ,
116116 string ? contentType = null )
117117 {
@@ -132,10 +132,10 @@ public static RouteHandlerConventionBuilder ProducesValidationProblem(this Route
132132 /// into related groups. These tags are typically included in the generated specification
133133 /// and are typically used to group operations by tags in the UI.
134134 /// </remarks>
135- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
135+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
136136 /// <param name="tags">A collection of tags to be associated with the endpoint.</param>
137- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
138- public static RouteHandlerConventionBuilder WithTags ( this RouteHandlerConventionBuilder builder , params string [ ] tags )
137+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
138+ public static RouteHandlerBuilder WithTags ( this RouteHandlerBuilder builder , params string [ ] tags )
139139 {
140140 builder . WithMetadata ( new TagsAttribute ( tags ) ) ;
141141 return builder ;
@@ -146,11 +146,11 @@ public static RouteHandlerConventionBuilder WithTags(this RouteHandlerConvention
146146 /// produced by <paramref name="builder"/>.
147147 /// </summary>
148148 /// <typeparam name="TRequest">The type of the request body.</typeparam>
149- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
149+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
150150 /// <param name="contentType">The request content type that the endpoint accepts.</param>
151151 /// <param name="additionalContentTypes">The list of additional request content types that the endpoint accepts.</param>
152- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
153- public static RouteHandlerConventionBuilder Accepts < TRequest > ( this RouteHandlerConventionBuilder builder ,
152+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
153+ public static RouteHandlerBuilder Accepts < TRequest > ( this RouteHandlerBuilder builder ,
154154 string contentType , params string [ ] additionalContentTypes ) where TRequest : notnull
155155 {
156156 Accepts ( builder , typeof ( TRequest ) , contentType , additionalContentTypes ) ;
@@ -163,12 +163,12 @@ public static RouteHandlerConventionBuilder Accepts<TRequest>(this RouteHandlerC
163163 /// produced by <paramref name="builder"/>.
164164 /// </summary>
165165 /// <typeparam name="TRequest">The type of the request body.</typeparam>
166- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
166+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
167167 /// <param name="isOptional">Sets a value that determines if the request body is optional.</param>
168168 /// <param name="contentType">The request content type that the endpoint accepts.</param>
169169 /// <param name="additionalContentTypes">The list of additional request content types that the endpoint accepts.</param>
170- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
171- public static RouteHandlerConventionBuilder Accepts < TRequest > ( this RouteHandlerConventionBuilder builder ,
170+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
171+ public static RouteHandlerBuilder Accepts < TRequest > ( this RouteHandlerBuilder builder ,
172172 bool isOptional , string contentType , params string [ ] additionalContentTypes ) where TRequest : notnull
173173 {
174174 Accepts ( builder , typeof ( TRequest ) , isOptional , contentType , additionalContentTypes ) ;
@@ -180,12 +180,12 @@ public static RouteHandlerConventionBuilder Accepts<TRequest>(this RouteHandlerC
180180 /// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
181181 /// produced by <paramref name="builder"/>.
182182 /// </summary>
183- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
183+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
184184 /// <param name="requestType">The type of the request body.</param>
185185 /// <param name="contentType">The request content type that the endpoint accepts.</param>
186186 /// <param name="additionalContentTypes">The list of additional request content types that the endpoint accepts.</param>
187- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
188- public static RouteHandlerConventionBuilder Accepts ( this RouteHandlerConventionBuilder builder ,
187+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
188+ public static RouteHandlerBuilder Accepts ( this RouteHandlerBuilder builder ,
189189 Type requestType , string contentType , params string [ ] additionalContentTypes )
190190 {
191191 builder . WithMetadata ( new AcceptsMetadata ( requestType , false , GetAllContentTypes ( contentType , additionalContentTypes ) ) ) ;
@@ -197,13 +197,13 @@ public static RouteHandlerConventionBuilder Accepts(this RouteHandlerConventionB
197197 /// Adds <see cref="IAcceptsMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
198198 /// produced by <paramref name="builder"/>.
199199 /// </summary>
200- /// <param name="builder">The <see cref="RouteHandlerConventionBuilder "/>.</param>
200+ /// <param name="builder">The <see cref="RouteHandlerBuilder "/>.</param>
201201 /// <param name="requestType">The type of the request body.</param>
202202 /// <param name="isOptional">Sets a value that determines if the request body is optional.</param>
203203 /// <param name="contentType">The request content type that the endpoint accepts.</param>
204204 /// <param name="additionalContentTypes">The list of additional request content types that the endpoint accepts.</param>
205- /// <returns>A <see cref="RouteHandlerConventionBuilder "/> that can be used to further customize the endpoint.</returns>
206- public static RouteHandlerConventionBuilder Accepts ( this RouteHandlerConventionBuilder builder ,
205+ /// <returns>A <see cref="RouteHandlerBuilder "/> that can be used to further customize the endpoint.</returns>
206+ public static RouteHandlerBuilder Accepts ( this RouteHandlerBuilder builder ,
207207 Type requestType , bool isOptional , string contentType , params string [ ] additionalContentTypes )
208208 {
209209 builder . WithMetadata ( new AcceptsMetadata ( requestType , isOptional , GetAllContentTypes ( contentType , additionalContentTypes ) ) ) ;
0 commit comments