Skip to content

📝 Add docstrings to v10.0.0/launch #19

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

📝 Add docstrings to v10.0.0/launch #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions src/Codebelt.Extensions.Asp.Versioning/ServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using System;
using System;
using Asp.Versioning;
using Cuemon;
using Microsoft.Extensions.DependencyInjection;
Expand All @@ -17,7 +17,11 @@ public static class ServiceCollectionExtensions
/// <param name="services">The <see cref="IServiceCollection"/> to extend.</param>
/// <param name="setup">The <see cref="RestfulApiVersioningOptions"/> that may be configured.</param>
/// <returns>A reference to <paramref name="services" /> so that additional calls can be chained.</returns>
/// <remarks>This is a convenient method to add API versioning to your ASP.NET Core WebApi. Call <c>AddApiVersioning</c>, <c>AddMvc</c> and <c>AddApiExplorer</c>. Configuration, which is optimized for RESTful APIs, are done through <paramref name="setup"/>.</remarks>
/// <summary>
/// Adds and configures RESTful API versioning, related MVC conventions, API Explorer grouping, and Problem Details handling to the service collection.
/// </summary>
/// <param name="setup">Optional configurator for RestfulApiVersioningOptions that controls default API version, valid Accept headers, parameter name, conventions, API version selector type, and Problem Details behavior.</param>
/// <returns>The original IServiceCollection instance for chaining.</returns>
public static IServiceCollection AddRestfulApiVersioning(this IServiceCollection services, Action<RestfulApiVersioningOptions> setup = null)
{
Validator.ThrowIfNull(services);
Expand Down Expand Up @@ -61,4 +65,4 @@ public static IServiceCollection AddRestfulApiVersioning(this IServiceCollection
return services;
}
}
}
}