Skip to content

Commit 4374c82

Browse files
commonsensesoftwarecommonsensesoftware
committed
Add NuGet readme
1 parent f8538b7 commit 4374c82

File tree

8 files changed

+170
-0
lines changed
  • src
    • Microsoft.AspNet.OData.Versioning.ApiExplorer
    • Microsoft.AspNet.OData.Versioning
    • Microsoft.AspNet.WebApi.Versioning.ApiExplorer
    • Microsoft.AspNet.WebApi.Versioning
    • Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer
    • Microsoft.AspNetCore.Mvc.Versioning
    • Microsoft.AspNetCore.OData.Versioning.ApiExplorer
    • Microsoft.AspNetCore.OData.Versioning

8 files changed

+170
-0
lines changed

‎src/Microsoft.AspNet.OData.Versioning.ApiExplorer/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
| :mega: Now [Asp.Versioning.WebApi.OData.ApiExplorer](https://www.nuget.org/packages/Asp.Versioning.WebApi.OData.ApiExplorer/). See the [announcement](https://github.com/dotnet/aspnet-api-versioning/discussions/807). |
2+
|-|
3+
4+
ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new
5+
and existing REST services built with ASP.NET Web API and OData v4.0. The API versioning extensions define simple
6+
metadata attributes and conventions that you use to describe which API versions are implemented by your services.
7+
8+
This package contains the API version-aware extensions for API Explorer in ASP.NET Web API with OData v4.0, which are
9+
useful in a number of scenarios such as test automation or OpenAPI document generation.
10+
11+
## Commonly Used Types
12+
13+
- Microsoft.AspNet.OData.Builder.ODataQueryOptionsConventionBuilder
14+
- Microsoft.Web.Http.Description.ODataApiExplorer
15+
- Microsoft.Web.Http.Description.ODataApiExplorerOptions
16+
17+
## Release Notes
18+

‎src/Microsoft.AspNet.OData.Versioning/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
| :mega: Now [Asp.Versioning.WebApi.OData](https://www.nuget.org/packages/Asp.Versioning.WebApi.OData/). See the [announcement](https://github.com/dotnet/aspnet-api-versioning/discussions/807). |
2+
|-|
3+
4+
ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new
5+
and existing REST services built with ASP.NET Web API and OData v4.0. The API versioning extensions define simple
6+
metadata attributes and conventions that you use to describe which API versions are implemented by your services.
7+
8+
## Commonly Used Types
9+
10+
- Microsoft.AspNet.OData.Builder.IModelConfiguration
11+
- Microsoft.AspNet.OData.Builder.VersionedODataModelBuilder
12+
- Microsoft.AspNet.OData.Routing.VersionedAttributeRoutingConvention
13+
- Microsoft.AspNet.OData.Routing.VersionedMetadataRoutingConvention
14+
- Microsoft.AspNet.OData.Routing.VersionedODataRoutingConventions
15+
- Microsoft.AspNet.OData.VersionedMetadataController
16+
- Microsoft.OData.Edm.ApiVersionAnnotation
17+
- Microsoft.OData.Edm.IEdmModelSelector
18+
19+
## Release Notes
20+

‎src/Microsoft.AspNet.WebApi.Versioning.ApiExplorer/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
| :mega: Now [Asp.Versioning.WebApi.ApiExplorer](https://www.nuget.org/packages/Asp.Versioning.WebApi.ApiExplorer/). See the [announcement](https://github.com/dotnet/aspnet-api-versioning/discussions/807). |
2+
|-|
3+
4+
ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new
5+
and existing REST services built with ASP.NET Web API. The API versioning extensions define simple metadata attributes
6+
and conventions that you use to describe which API versions are implemented by your services.
7+
8+
This package contains the API version-aware extensions for API Explorer in ASP.NET Web API, which are useful in a
9+
number of scenarios such as test automation or OpenAPI document generation.
10+
11+
## Commonly Used Types
12+
13+
- Microsoft.Web.Http.Description.ApiExplorerOptions
14+
- Microsoft.Web.Http.Description.ApiDescriptionGroup
15+
- Microsoft.Web.Http.Description.ApiDescriptionGroupCollection
16+
- Microsoft.Web.Http.Description.VersionedApiDescription
17+
- Microsoft.Web.Http.Description.VersionedApiExplorer
18+
19+
## Release Notes
20+

‎src/Microsoft.AspNet.WebApi.Versioning/README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
| :mega: Now [Asp.Versioning.WebApi](https://www.nuget.org/packages/Asp.Versioning.WebApi/). See the [announcement](https://github.com/dotnet/aspnet-api-versioning/discussions/807). |
2+
|-|
3+
4+
ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new
5+
and existing REST services built with ASP.NET Web API. The API versioning extensions define simple metadata attributes
6+
and conventions that you use to describe which API versions are implemented by your services.
7+
8+
## Commonly Used Types
9+
10+
- Microsoft.Web.Http.ApiVersion
11+
- Microsoft.Web.Http.ApiVersionAttribute
12+
- Microsoft.Web.Http.ControllerNameAttribute
13+
- Microsoft.Web.Http.MapToApiVersionAttribute
14+
- Microsoft.Web.Http.ReportApiVersionsAttribute
15+
- Microsoft.Web.Http.Versioning.ApiVersionModel
16+
- Microsoft.Web.Http.Versioning.ApiVersioningOptions
17+
- Microsoft.Web.Http.Versioning.ApiVersionReader
18+
- Microsoft.Web.Http.Versioning.IApiVersionNeutral
19+
- Microsoft.Web.Http.Versioning.IApiVersionParameterSource
20+
- Microsoft.Web.Http.Versioning.IApiVersionProvider
21+
- Microsoft.Web.Http.Versioning.IApiVersionSelector
22+
- Microsoft.Web.Http.Versioning.IReportApiVersions
23+
- Microsoft.Web.Http.Versioning.QueryStringApiVersionReader
24+
25+
## Release Notes
26+

‎src/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer/README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
| :mega: Now [Asp.Versioning.Mvc.ApiExplorer](https://www.nuget.org/packages/Asp.Versioning.Mvc.ApiExplorer/). See the [announcement](https://github.com/dotnet/aspnet-api-versioning/discussions/807). |
2+
|-|
3+
4+
ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new
5+
and existing REST services built with ASP.NET Core. The API versioning extensions define simple metadata attributes
6+
and conventions that you use to describe which API versions are implemented by your services.
7+
8+
This package contains the API version-aware extensions for API Explorer in ASP.NET Core, which are useful in a
9+
number of scenarios such as test automation or OpenAPI document generation.
10+
11+
## Commonly Used Types
12+
13+
- Microsoft.AspNetCore.Mvc.ApiExplorer.ApiExplorerOptions
14+
- Microsoft.AspNetCore.Mvc.ApiExplorer.ApiVersionDescription
15+
- Microsoft.AspNetCore.Mvc.ApiExplorer.IApiVersionDescriptionProvider
16+
- Microsoft.AspNetCore.Mvc.ApiExplorer.VersionedApiDescriptionProvider
17+
18+
## Release Notes
19+

‎src/Microsoft.AspNetCore.Mvc.Versioning/README.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
| :mega: Now [Asp.Versioning.Mvc](https://www.nuget.org/packages/Asp.Versioning.Mvc/). See the [announcement](https://github.com/dotnet/aspnet-api-versioning/discussions/807). |
2+
|-|
3+
4+
ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new
5+
and existing REST services built with ASP.NET Core MVC. The API versioning extensions define simple metadata attributes
6+
and conventions that you use to describe which API versions are implemented by your services.
7+
8+
This package contains the primary abstractions library for API versioning that can be used to create server and
9+
client-based applications.
10+
11+
## Commonly Used Types
12+
13+
- Microsoft.AspNetCore.Mvc.ApiVersion
14+
- Microsoft.AspNetCore.Mvc.ApiVersionAttribute
15+
- Microsoft.AspNetCore.Mvc.ControllerNameAttribute
16+
- Microsoft.AspNetCore.Mvc.MapToApiVersionAttribute
17+
- Microsoft.AspNetCore.Mvc.ReportApiVersionsAttribute
18+
- Microsoft.AspNetCore.Mvc.Versioning.ApiVersionModel
19+
- Microsoft.AspNetCore.Mvc.Versioning.ApiVersioningOptions
20+
- Microsoft.AspNetCore.Mvc.Versioning.ApiVersionReader
21+
- Microsoft.AspNetCore.Mvc.Versioning.IApiVersionNeutral
22+
- Microsoft.AspNetCore.Mvc.Versioning.IApiVersionParameterSource
23+
- Microsoft.AspNetCore.Mvc.Versioning.IApiVersionProvider
24+
- Microsoft.AspNetCore.Mvc.Versioning.IApiVersionSelector
25+
- Microsoft.AspNetCore.Mvc.Versioning.IReportApiVersions
26+
- Microsoft.AspNetCore.Mvc.Versioning.QueryStringApiVersionReader
27+
28+
## Release Notes
29+

‎src/Microsoft.AspNetCore.OData.Versioning.ApiExplorer/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
| :mega: Now [Asp.Versioning.OData.ApiExplorer](https://www.nuget.org/packages/Asp.Versioning.OData.ApiExplorer/). See the [announcement](https://github.com/dotnet/aspnet-api-versioning/discussions/807). |
2+
|-|
3+
4+
ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new
5+
and existing REST services built with ASP.NET Core MVC and OData v4.0. The API versioning extensions define simple
6+
metadata attributes and conventions that you use to describe which API versions are implemented by your services.
7+
8+
This package contains the API version-aware extensions for API Explorer in ASP.NET Core MVC and OData v4.0, which
9+
are useful in a number of scenarios such as test automation or OpenAPI document generation.
10+
11+
## Commonly Used Types
12+
13+
- Microsoft.AspNet.OData.Builder.ODataQueryOptionsConventionBuilder
14+
- Microsoft.AspNetCore.Mvc.ApiExplorer.ODataApiDescriptionProvider
15+
- Microsoft.AspNetCore.Mvc.ApiExplorer.ODataApiExplorerOptions
16+
17+
## Release Notes
18+

‎src/Microsoft.AspNetCore.OData.Versioning/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
| :mega: Now [Asp.Versioning.OData](https://www.nuget.org/packages/Asp.Versioning.OData/). See the [announcement](https://github.com/dotnet/aspnet-api-versioning/discussions/807). |
2+
|-|
3+
4+
ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new
5+
and existing REST services built with ASP.NET Core MVC and OData v4.0. The API versioning extensions define simple
6+
metadata attributes and conventions that you use to describe which API versions are implemented by your services.
7+
8+
## Commonly Used Types
9+
10+
- Microsoft.AspNet.OData.Builder.IModelConfiguration
11+
- Microsoft.AspNet.OData.Builder.VersionedODataModelBuilder
12+
- Microsoft.AspNet.OData.Routing.VersionedAttributeRoutingConvention
13+
- Microsoft.AspNet.OData.Routing.VersionedMetadataRoutingConvention
14+
- Microsoft.AspNet.OData.VersionedMetadataController
15+
- Microsoft.AspNetCore.Mvc.Versioning.ODataApiVersioningOptions
16+
- Microsoft.OData.Edm.ApiVersionAnnotation
17+
- Microsoft.OData.Edm.IEdmModelSelector
18+
19+
## Release Notes
20+

0 commit comments

Comments
 (0)