Skip to content

Commit

Permalink
Standardize terminology and improve documentation clarity
Browse files Browse the repository at this point in the history
Updated documentation comments to standardize "OpenAPI" terminology and clarify "OAuth2 custom authentication support." Corrected minor grammatical errors for improved readability. No functional code changes.

#128
  • Loading branch information
marcominerva committed Jan 8, 2025
1 parent 3fd85e6 commit f4d0771
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions src/SimpleAuthentication.Swashbuckle/SwaggerExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ static void AddSecurityDefinition(SwaggerGenOptions options, string name, Securi
}

/// <summary>
/// Adds OAuth2 authentication support in Swagger, for example for example to integrate with Microsoft.Identity.Web.
/// Adds OAuth2 custom authentication support in Swagger, for example for example to integrate with Microsoft.Identity.Web.
/// </summary>
/// <param name="options">The <see cref="SwaggerGenOptions"/> to add configuration to.</param>
/// <param name="name">The name of the OAuth2 authentication scheme to add.</param>
Expand All @@ -178,7 +178,7 @@ public static void AddOAuth2Authentication(this SwaggerGenOptions options, strin
}

/// <summary>
/// Adds OAuth2 authentication support in Open API, for example for example to integrate with Microsoft.Identity.Web.
/// Adds OAuth2 custom authentication support in Swagger, for example for example to integrate with Microsoft.Identity.Web.
/// </summary>
/// <param name="options">The <see cref="SwaggerGenOptions"/> to add configuration to.</param>
/// <param name="name">The name of the OAuth2 authentication scheme to add.</param>
Expand Down
16 changes: 8 additions & 8 deletions src/SimpleAuthentication/OpenApiExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
namespace SimpleAuthentication;

/// <summary>
/// Provides extension methods for adding authentication support in Open API.
/// Provides extension methods for adding authentication support in OpenAPI.
/// </summary>
public static class OpenApiExtensions
{
/// <summary>
/// Adds authentication support in Open API, reading configuration from the specified <see cref="IConfiguration"/> source.
/// Adds authentication support in OpenAPI, reading configuration from the specified <see cref="IConfiguration"/> source.
/// </summary>
/// <param name="options">The <see cref="OpenApiOptions"/> to add configuration to.</param>
/// <param name="configuration">The <see cref="IConfiguration"/> being bound.</param>
Expand All @@ -24,7 +24,7 @@ public static void AddSimpleAuthentication(this OpenApiOptions options, IConfigu
=> options.AddSimpleAuthentication(configuration, sectionName, Array.Empty<OpenApiSecurityRequirement>());

/// <summary>
/// Adds authentication support in Open API, reading configuration from a section named <strong>Authentication</strong> in <see cref="IConfiguration"/> source.
/// Adds authentication support in OpenAPI, reading configuration from a section named <strong>Authentication</strong> in <see cref="IConfiguration"/> source.
/// </summary>
/// <param name="options">The <see cref="OpenApiOptions"/> to add configuration to.</param>
/// <param name="configuration">The <see cref="IConfiguration"/> being bound.</param>
Expand All @@ -35,7 +35,7 @@ public static void AddSimpleAuthentication(this OpenApiOptions options, IConfigu
=> options.AddSimpleAuthentication(configuration, "Authentication", additionalSecurityDefinitionNames);

/// <summary>
/// Adds authentication support in Open API, reading configuration from the specified <see cref="IConfiguration"/> source.
/// Adds authentication support in OpenAPI, reading configuration from the specified <see cref="IConfiguration"/> source.
/// </summary>
/// <param name="options">The <see cref="OpenApiOptions"/> to add configuration to.</param>
/// <param name="configuration">The <see cref="IConfiguration"/> being bound.</param>
Expand All @@ -50,7 +50,7 @@ public static void AddSimpleAuthentication(this OpenApiOptions options, IConfigu
}

/// <summary>
/// Adds authentication support in Open API, reading configuration from the specified <see cref="IConfiguration"/> source.
/// Adds authentication support in OpenAPI, reading configuration from the specified <see cref="IConfiguration"/> source.
/// </summary>
/// <param name="options">The <see cref="OpenApiOptions"/> to add configuration to.</param>
/// <param name="configuration">The <see cref="IConfiguration"/> being bound.</param>
Expand All @@ -61,7 +61,7 @@ public static void AddSimpleAuthentication(this OpenApiOptions options, IConfigu
=> options.AddSimpleAuthentication(configuration, "Authentication", securityRequirements);

/// <summary>
/// Adds authentication support in Open API, reading configuration from the specified <see cref="IConfiguration"/> source.
/// Adds authentication support in OpenAPI, reading configuration from the specified <see cref="IConfiguration"/> source.
/// </summary>
/// <param name="options">The <see cref="OpenApiOptions"/> to add configuration to.</param>
/// <param name="configuration">The <see cref="IConfiguration"/> being bound.</param>
Expand All @@ -80,7 +80,7 @@ public static void AddSimpleAuthentication(this OpenApiOptions options, IConfigu
}

/// <summary>
/// Adds OAuth2 custom authentication support in Open API, for example to integrate with Microsoft.Identity.Web.
/// Adds OAuth2 authentication support in OpenAPI, for example to integrate with Microsoft.Identity.Web.
/// </summary>
/// <param name="options">The <see cref="OpenApiOptions"/> to add configuration to.</param>
/// <param name="name">The name of the OAuth2 authentication scheme to add.</param>
Expand All @@ -105,7 +105,7 @@ public static void AddOAuth2Authentication(this OpenApiOptions options, string n
}

/// <summary>
/// Adds OAuth2 custom authentication support in Open API, for example to integrate with Microsoft.Identity.Web.
/// Adds OAuth2 authentication support in OpenAPI, for example to integrate with Microsoft.Identity.Web.
/// </summary>
/// <param name="options">The <see cref="OpenApiOptions"/> to add configuration to.</param>
/// <param name="name">The name of the OAuth2 authentication scheme to add.</param>
Expand Down

0 comments on commit f4d0771

Please sign in to comment.