Skip to content

Commit 173a2a8

Browse files
Chris Martinezcommonsensesoftware
authored andcommitted
Updated API version parameter description to be consistently set for query string and URL path methods in samples
1 parent 1192e51 commit 173a2a8

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

samples/aspnetcore/SwaggerSample/ImplicitApiVersionParameter.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ public void Apply( Operation operation, OperationFilterContext context )
5454
Name = "api-version",
5555
Required = true,
5656
Default = apiVersion.ToString(),
57-
Description = "The requested API version",
5857
In = "query",
5958
Type = "string"
6059
};
@@ -67,6 +66,8 @@ public void Apply( Operation operation, OperationFilterContext context )
6766
// the route can be invoked in the "Try It!" feature
6867
pathParameter.Default = apiVersion.ToString();
6968
}
69+
70+
parameter.Description = "The requested API version";
7071
}
7172
}
7273
}

samples/webapi/SwaggerWebApiSample/ImplicitApiVersionParameter.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ public void Apply( Operation operation, SchemaRegistry schemaRegistry, ApiDescri
5454
{
5555
name = "api-version",
5656
required = true,
57-
description = "The requested API version",
5857
@in = "query",
5958
type = "string"
6059
};
@@ -65,6 +64,7 @@ public void Apply( Operation operation, SchemaRegistry schemaRegistry, ApiDescri
6564
// update the default value with the current API version so that
6665
// the route can be invoked in the "Try It!" feature
6766
parameter.@default = description.ApiVersion.ToString();
67+
parameter.description = "The requested API version";
6868
}
6969
}
7070
}

0 commit comments

Comments
 (0)