Skip to content

Commit e45f7b7

Browse files
commonsensesoftwarecommonsensesoftware
committed
Rename to "WithApiVersionSet"
1 parent b9fd3b4 commit e45f7b7

File tree

6 files changed

+44
-44
lines changed

6 files changed

+44
-44
lines changed

‎examples/AspNetCore/WebApi/MinimalApiExample/Program.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
summaries[Random.Shared.Next( summaries.Length )]
3131
) );
3232
} )
33-
.UseApiVersioning( versionSet )
33+
.WithApiVersionSet( versionSet )
3434
.MapToApiVersion( 1.0 );
3535

3636
// GET /weatherforecast?api-version=2.0
@@ -44,17 +44,17 @@
4444
summaries[Random.Shared.Next( summaries.Length )]
4545
) );
4646
} )
47-
.UseApiVersioning( versionSet )
47+
.WithApiVersionSet( versionSet )
4848
.MapToApiVersion( 2.0 );
4949

5050
// POST /weatherforecast?api-version=2.0
5151
app.MapPost( "/weatherforecast", ( WeatherForecast forecast ) => { } )
52-
.UseApiVersioning( versionSet )
52+
.WithApiVersionSet( versionSet )
5353
.MapToApiVersion( 2.0 );
5454

5555
// DELETE /weatherforecast
5656
app.MapDelete( "/weatherforecast", () => { } )
57-
.UseApiVersioning( versionSet )
57+
.WithApiVersionSet( versionSet )
5858
.IsApiVersionNeutral();
5959

6060
app.Run();

‎examples/AspNetCore/WebApi/MinimalOpenApiExample/Program.cs‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
app.MapGet( "/api/orders/{id:int}", ( int id ) => new OrderV1() { Id = id, Customer = "John Doe" } )
5252
.Produces<OrderV1>()
5353
.Produces( 404 )
54-
.UseApiVersioning( orders )
54+
.WithApiVersionSet( orders )
5555
.HasDeprecatedApiVersion( 0.9 )
5656
.HasApiVersion( 1.0 );
5757

@@ -66,15 +66,15 @@
6666
.Accepts<OrderV1>( "application/json" )
6767
.Produces<OrderV1>( 201 )
6868
.Produces( 400 )
69-
.UseApiVersioning( orders )
69+
.WithApiVersionSet( orders )
7070
.HasApiVersion( 1.0 );
7171

7272
app.MapMethods( "/api/orders/{id:int}", new[] { HttpMethod.Patch.Method }, ( int id, OrderV1 order ) => Results.NoContent() )
7373
.Accepts<OrderV1>( "application/json" )
7474
.Produces( 204 )
7575
.Produces( 400 )
7676
.Produces( 404 )
77-
.UseApiVersioning( orders )
77+
.WithApiVersionSet( orders )
7878
.HasApiVersion( 1.0 );
7979

8080
// 2.0
@@ -87,13 +87,13 @@
8787
} )
8888
.Produces<IEnumerable<OrderV2>>()
8989
.Produces( 404 )
90-
.UseApiVersioning( orders )
90+
.WithApiVersionSet( orders )
9191
.HasApiVersion( 2.0 );
9292

9393
app.MapGet( "/api/orders/{id:int}", ( int id ) => new OrderV2() { Id = id, Customer = "John Doe" } )
9494
.Produces<OrderV2>()
9595
.Produces( 404 )
96-
.UseApiVersioning( orders )
96+
.WithApiVersionSet( orders )
9797
.HasApiVersion( 2.0 );
9898

9999
app.MapPost( "/api/orders", ( HttpRequest request, OrderV2 order ) =>
@@ -107,15 +107,15 @@
107107
.Accepts<OrderV2>( "application/json" )
108108
.Produces<OrderV2>( 201 )
109109
.Produces( 400 )
110-
.UseApiVersioning( orders )
110+
.WithApiVersionSet( orders )
111111
.HasApiVersion( 2.0 );
112112

113113
app.MapMethods( "/api/orders/{id:int}", new[] { HttpMethod.Patch.Method }, ( int id, OrderV2 order ) => Results.NoContent() )
114114
.Accepts<OrderV2>( "application/json" )
115115
.Produces( 204 )
116116
.Produces( 400 )
117117
.Produces( 404 )
118-
.UseApiVersioning( orders )
118+
.WithApiVersionSet( orders )
119119
.HasApiVersion( 2.0 );
120120

121121
// 3.0
@@ -127,13 +127,13 @@
127127
new(){ Id = 3, Customer = "Jane Doe", EffectiveDate = DateTimeOffset.UtcNow.AddDays( 7d ) },
128128
} )
129129
.Produces<IEnumerable<OrderV3>>()
130-
.UseApiVersioning( orders )
130+
.WithApiVersionSet( orders )
131131
.HasApiVersion( 3.0 );
132132

133133
app.MapGet( "/api/orders/{id:int}", ( int id ) => new OrderV3() { Id = id, Customer = "John Doe" } )
134134
.Produces<OrderV3>()
135135
.Produces( 404 )
136-
.UseApiVersioning( orders )
136+
.WithApiVersionSet( orders )
137137
.HasApiVersion( 3.0 );
138138

139139
app.MapPost( "/api/orders", ( HttpRequest request, OrderV3 order ) =>
@@ -147,12 +147,12 @@
147147
.Accepts<OrderV3>( "application/json" )
148148
.Produces<OrderV3>( 201 )
149149
.Produces( 400 )
150-
.UseApiVersioning( orders )
150+
.WithApiVersionSet( orders )
151151
.HasApiVersion( 3.0 );
152152

153153
app.MapDelete( "/api/orders/{id:int}", ( int id ) => Results.NoContent() )
154154
.Produces( 204 )
155-
.UseApiVersioning( orders )
155+
.WithApiVersionSet( orders )
156156
.HasApiVersion( 3.0 );
157157

158158
// 1.0
@@ -165,7 +165,7 @@
165165
} )
166166
.Produces<PersonV1>()
167167
.Produces( 404 )
168-
.UseApiVersioning( people )
168+
.WithApiVersionSet( people )
169169
.HasDeprecatedApiVersion( 0.9 )
170170
.HasApiVersion( 1.0 );
171171

@@ -196,7 +196,7 @@
196196
},
197197
} )
198198
.Produces<IEnumerable<PersonV2>>()
199-
.UseApiVersioning( people )
199+
.WithApiVersionSet( people )
200200
.HasApiVersion( 2.0 );
201201

202202
app.MapGet( "/api/v{version:apiVersion}/people/{id:int}", ( int id ) =>
@@ -209,7 +209,7 @@
209209
} )
210210
.Produces<PersonV2>()
211211
.Produces( 404 )
212-
.UseApiVersioning( people )
212+
.WithApiVersionSet( people )
213213
.HasApiVersion( 2.0 );
214214

215215
// 3.0
@@ -242,7 +242,7 @@
242242
},
243243
} )
244244
.Produces<IEnumerable<PersonV3>>()
245-
.UseApiVersioning( people )
245+
.WithApiVersionSet( people )
246246
.HasApiVersion( 3.0 );
247247

248248
app.MapGet( "/api/v{version:apiVersion}/people/{id:int}", ( int id ) =>
@@ -256,7 +256,7 @@
256256
} )
257257
.Produces<PersonV3>()
258258
.Produces( 404 )
259-
.UseApiVersioning( people )
259+
.WithApiVersionSet( people )
260260
.HasApiVersion( 3.0 );
261261

262262
app.MapPost( "/api/v{version:apiVersion}/people", ( HttpRequest request, PersonV3 person ) =>
@@ -271,7 +271,7 @@
271271
.Accepts<PersonV3>( "application/json" )
272272
.Produces<PersonV3>( 201 )
273273
.Produces( 400 )
274-
.UseApiVersioning( people )
274+
.WithApiVersionSet( people )
275275
.HasApiVersion( 3.0 );
276276

277277
app.UseSwagger();

‎src/AspNetCore/Acceptance/Asp.Versioning.Mvc.Acceptance.Tests/Http/MinimalApiFixture.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,54 +26,54 @@ protected override void OnConfigureEndpoints( IEndpointRouteBuilder endpoints )
2626
var orders = endpoints.NewApiVersionSet( "Orders" ).Build();
2727

2828
endpoints.MapGet( "api/ping", () => Results.NoContent() )
29-
.UseApiVersioning( endpoints.NewApiVersionSet().Build() )
29+
.WithApiVersionSet( endpoints.NewApiVersionSet().Build() )
3030
.IsApiVersionNeutral();
3131

3232
endpoints.MapGet( "api/values", () => "Value 1" )
33-
.UseApiVersioning( values )
33+
.WithApiVersionSet( values )
3434
.MapToApiVersion( 1.0 );
3535

3636
endpoints.MapGet( "api/values", () => "Value 2" )
37-
.UseApiVersioning( values )
37+
.WithApiVersionSet( values )
3838
.MapToApiVersion( 2.0 );
3939

4040
endpoints.MapGet( "api/v{version:apiVersion}/hello", () => "Hello world!" )
41-
.UseApiVersioning( helloWorld )
41+
.WithApiVersionSet( helloWorld )
4242
.MapToApiVersion( 1.0 );
4343

4444
endpoints.MapGet( "api/v{version:apiVersion}/hello/{text}", ( string text ) => text )
45-
.UseApiVersioning( helloWorld )
45+
.WithApiVersionSet( helloWorld )
4646
.MapToApiVersion( 1.0 );
4747

4848
endpoints.MapGet( "api/v{version:apiVersion}/hello", () => "Hello world! (v2)" )
49-
.UseApiVersioning( helloWorld )
49+
.WithApiVersionSet( helloWorld )
5050
.MapToApiVersion( 2.0 );
5151

5252
endpoints.MapGet( "api/v{version:apiVersion}/hello/{text}", ( string text ) => text + " (v2)" )
53-
.UseApiVersioning( helloWorld )
53+
.WithApiVersionSet( helloWorld )
5454
.MapToApiVersion( 2.0 );
5555

5656
endpoints.MapPost( "api/v{version:apiVersion}/hello", () => { } )
57-
.UseApiVersioning( helloWorld );
57+
.WithApiVersionSet( helloWorld );
5858

5959
endpoints.MapGet( "api/order", () => { } )
60-
.UseApiVersioning( orders )
60+
.WithApiVersionSet( orders )
6161
.HasApiVersion( 1.0 )
6262
.HasApiVersion( 2.0 );
6363

6464
endpoints.MapGet( "api/order/{id}", ( int id ) => { } )
65-
.UseApiVersioning( orders )
65+
.WithApiVersionSet( orders )
6666
.HasDeprecatedApiVersion( 0.9 )
6767
.HasApiVersion( 1.0 )
6868
.HasApiVersion( 2.0 );
6969

7070
endpoints.MapPost( "api/order", () => { } )
71-
.UseApiVersioning( orders )
71+
.WithApiVersionSet( orders )
7272
.HasApiVersion( 1.0 )
7373
.HasApiVersion( 2.0 );
7474

7575
endpoints.MapDelete( "api/order/{id}", ( int id ) => { } )
76-
.UseApiVersioning( orders )
76+
.WithApiVersionSet( orders )
7777
.IsApiVersionNeutral();
7878
}
7979
}

‎src/AspNetCore/WebApi/src/Asp.Versioning.Http/net6.0/Builder/IEndpointConventionBuilderExtensions.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ namespace Microsoft.AspNetCore.Builder;
1919
public static class IEndpointConventionBuilderExtensions
2020
{
2121
/// <summary>
22-
/// Indicates that the endpoint will use API versioning.
22+
/// Applies the specified API version set to the endpoint.
2323
/// </summary>
2424
/// <param name="builder">The extended <see cref="IEndpointConventionBuilder">builder</see>.</param>
2525
/// <param name="apiVersionSet">The <see cref="ApiVersionSet">API version set</see> the endpoint will use.</param>
2626
/// <returns>A new <see cref="IVersionedEndpointConventionBuilder"/> instance.</returns>
2727
/// <remarks>If the specified <paramref name="builder"/> already implements <see cref="IVersionedEndpointConventionBuilder"/>,
2828
/// then that instance will be returned instead.</remarks>
29-
public static IVersionedEndpointConventionBuilder UseApiVersioning(
29+
public static IVersionedEndpointConventionBuilder WithApiVersionSet(
3030
this IEndpointConventionBuilder builder,
3131
ApiVersionSet apiVersionSet )
3232
{

‎src/AspNetCore/WebApi/test/Asp.Versioning.Http.Tests/Builder/IEndpointConventionBuilderExtensionsTest.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ public void use_api_versioning_should_return_same_instance()
1212
// arrange
1313
var endpoints = Mock.Of<IEndpointConventionBuilder>();
1414
var versionSet = new ApiVersionSetBuilder( default ).Build();
15-
var builder1 = endpoints.UseApiVersioning( versionSet );
15+
var builder1 = endpoints.WithApiVersionSet( versionSet );
1616

1717
// act
18-
var builder2 = builder1.UseApiVersioning( versionSet );
18+
var builder2 = builder1.WithApiVersionSet( versionSet );
1919

2020
// assert
2121
builder1.Should().BeSameAs( builder2 );

‎src/AspNetCore/WebApi/test/Asp.Versioning.Http.Tests/Builder/VersionedEndpointConventionBuilderTest.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public void build_should_return_version_neutral_api_version_model()
1313
// arrange
1414
var endpoints = Mock.Of<IEndpointConventionBuilder>();
1515
var versionSet = new ApiVersionSetBuilder( default ).Build();
16-
var builder = endpoints.UseApiVersioning( versionSet );
16+
var builder = endpoints.WithApiVersionSet( versionSet );
1717

1818
builder.IsApiVersionNeutral();
1919

@@ -30,7 +30,7 @@ public void build_should_return_version_neutral_api_version_model_for_entire_api
3030
// arrange
3131
var endpoints = Mock.Of<IEndpointConventionBuilder>();
3232
var versionSet = new ApiVersionSetBuilder( default ).IsApiVersionNeutral().Build();
33-
var builder = endpoints.UseApiVersioning( versionSet );
33+
var builder = endpoints.WithApiVersionSet( versionSet );
3434

3535
// act
3636
var metadata = builder.Build( new() );
@@ -45,7 +45,7 @@ public void build_should_return_version_neutral_api_version_model_for_entire_api
4545
// arrange
4646
var endpoints = Mock.Of<IEndpointConventionBuilder>();
4747
var versionSet = new ApiVersionSetBuilder( "Test" ).IsApiVersionNeutral().Build();
48-
var builder = endpoints.UseApiVersioning( versionSet );
48+
var builder = endpoints.WithApiVersionSet( versionSet );
4949
var expected = new ApiVersionMetadata( ApiVersionModel.Neutral, ApiVersionModel.Neutral, "Test" );
5050

5151
// act
@@ -61,7 +61,7 @@ public void build_should_return_empty_api_version_model()
6161
// arrange
6262
var endpoints = Mock.Of<IEndpointConventionBuilder>();
6363
var versionSet = new ApiVersionSetBuilder( "Test" ).Build();
64-
var builder = endpoints.UseApiVersioning( versionSet );
64+
var builder = endpoints.WithApiVersionSet( versionSet );
6565
var expected = new ApiVersionMetadata( ApiVersionModel.Empty, ApiVersionModel.Empty, "Test" );
6666

6767
// act
@@ -77,7 +77,7 @@ public void build_should_return_inherited_api_version_model()
7777
// arrange
7878
var endpoints = Mock.Of<IEndpointConventionBuilder>();
7979
var versionSet = new ApiVersionSetBuilder( "Test" ).HasApiVersion( 2.0 ).Build();
80-
var builder = endpoints.UseApiVersioning( versionSet );
80+
var builder = endpoints.WithApiVersionSet( versionSet );
8181
var apiModel = new ApiVersionModel( new ApiVersion( 2.0 ) );
8282
var expected = new ApiVersionMetadata( apiModel, apiModel, "Test" );
8383

@@ -94,7 +94,7 @@ public void build_should_return_explicit_api_version_model()
9494
// arrange
9595
var endpoints = Mock.Of<IEndpointConventionBuilder>();
9696
var versionSet = new ApiVersionSetBuilder( "Test" ).Build();
97-
var builder = endpoints.UseApiVersioning( versionSet );
97+
var builder = endpoints.WithApiVersionSet( versionSet );
9898
var expected = new ApiVersionMetadata(
9999
ApiVersionModel.Empty,
100100
new ApiVersionModel(
@@ -126,7 +126,7 @@ public void build_should_return_mapped_api_version_model()
126126
.HasApiVersion( 1.0 )
127127
.HasApiVersion( 2.0 )
128128
.Build();
129-
var builder = endpoints.UseApiVersioning( versionSet );
129+
var builder = endpoints.WithApiVersionSet( versionSet );
130130
var apiModel = new ApiVersionModel(
131131
declaredVersions: new ApiVersion[] { new( 1.0 ), new( 2.0 ) },
132132
supportedVersions: new ApiVersion[] { new( 1.0 ), new( 2.0 ) },

0 commit comments

Comments
 (0)