Skip to content

Commit 44369c6

Browse files
Harold-MorganHarold-Morgan
committed
Naming inconsistency fxd
1 parent b23e8b2 commit 44369c6

File tree

9 files changed

+51
-51
lines changed

9 files changed

+51
-51
lines changed

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ This repository contains the source code for the .NET Aspire Community Toolkit,
4848
| - **Learn More**: [`Hosting.MailPit`][mailpit-ext-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.MailPit][mailpit-ext-shields]][mailpit-ext-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.MailPit][mailpit-ext-shields-preview]][mailpit-ext-nuget-preview] | An Aspire integration leveraging the [MailPit](https://mailpit.axllent.org/) container. |
4949
| - **Learn More**: [`Hosting.k6`][k6-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.k6][k6-shields]][k6-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.k6][k6-shields-preview]][k6-nuget-preview] | An Aspire integration leveraging the [Grafana k6](https://k6.io/) container. |
5050
| - **Learn More**: [`Hosting.MySql.Extensions`][mysql-ext-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.MySql.Extensions][mysql-ext-shields]][mysql-ext-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.MySql.Extensions][mysql-ext-shields-preview]][mysql-ext-nuget-preview] | An integration that contains some additional extensions for hosting MySql container. |
51-
| - **Learn More**: [`Hosting.MiniO`][minio-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Minio][minio-hosting-shields]][minio-hosting-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Minio][minio-hosting-shields-preview]][minio-hosting-nuget-preview] | An Aspire hosting integration to setup a [MiniO S3](https://min.io/) storage. |
52-
| - **Learn More**: [`MiniO.Client`][minio-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Minio.Client][minio-client-shields]][minio-client-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Client.Minio][minio-client-shields-preview]][minio-client-nuget-preview] | An Aspire client integration for the [Minio](https://github.com/minio/minio-dotnet) package. |
51+
| - **Learn More**: [`Hosting.MinIO`][minio-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Minio][minio-hosting-shields]][minio-hosting-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Minio][minio-hosting-shields-preview]][minio-hosting-nuget-preview] | An Aspire hosting integration to setup a [MinIO S3](https://min.io/) storage. |
52+
| - **Learn More**: [`MinIO.Client`][minio-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Minio.Client][minio-client-shields]][minio-client-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Client.Minio][minio-client-shields-preview]][minio-client-nuget-preview] | An Aspire client integration for the [MinIO](https://github.com/minio/minio-dotnet) package. |
5353

5454
## 🙌 Getting Started
5555

‎src/CommunityToolkit.Aspire.Hosting.Minio/CommunityToolkit.Aspire.Hosting.Minio.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
4-
<AdditionalPackageTags>MinioS3 Hosting integration</AdditionalPackageTags>
5-
<Description>A .NET Aspire hosting integration for MiniO</Description>
4+
<AdditionalPackageTags>minio hosting cloud storage</AdditionalPackageTags>
5+
<Description>A .NET Aspire hosting integration for MinIO</Description>
66
<ImplicitUsings>enable</ImplicitUsings>
77
<Nullable>enable</Nullable>
88
</PropertyGroup>

‎src/CommunityToolkit.Aspire.Hosting.Minio/MinioBuilderExtensions.cs

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@
66
namespace Aspire.Hosting;
77

88
/// <summary>
9-
/// Provides extension methods for adding MiniO resources to an <see cref="IDistributedApplicationBuilder"/>.
9+
/// Provides extension methods for adding MinIO resources to an <see cref="IDistributedApplicationBuilder"/>.
1010
/// </summary>
1111
public static class MinioBuilderExtensions
1212
{
1313
private const string RootUserEnvVarName = "MINIO_ROOT_USER";
1414
private const string RootPasswordEnvVarName = "MINIO_ROOT_PASSWORD";
1515

1616
/// <summary>
17-
/// Adds a MiniO container to the application model. The default image is "minio/minio" and the tag is "latest".
17+
/// Adds a MinIO container to the application model. The default image is "minio/minio" and the tag is "latest".
1818
/// </summary>
1919
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
2020
/// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
21-
/// <param name="port">The host port for MiniO.</param>
22-
/// <param name="rootUser">The parameter used to provide the root user name for the MiniO resource. If <see langword="null"/> a default value will be used.</param>
23-
/// <param name="rootPassword">The parameter used to provide the administrator password for the MiniO resource. If <see langword="null"/> a random password will be generated.</param>
21+
/// <param name="port">The host port for MinIO.</param>
22+
/// <param name="rootUser">The parameter used to provide the root user name for the MinIO resource. If <see langword="null"/> a default value will be used.</param>
23+
/// <param name="rootPassword">The parameter used to provide the administrator password for the MinIO resource. If <see langword="null"/> a random password will be generated.</param>
2424
/// <returns>A reference to the <see cref="IResourceBuilder{MinioContainerResource}"/>.</returns>
2525
public static IResourceBuilder<MinioContainerResource> AddMinioContainer(
2626
this IDistributedApplicationBuilder builder,
@@ -68,10 +68,10 @@ public static IResourceBuilder<MinioContainerResource> AddMinioContainer(
6868

6969

7070
/// <summary>
71-
/// Configures the user name that the Minio resource uses.
71+
/// Configures the user name that the MinIO resource uses.
7272
/// </summary>
7373
/// <param name="builder">The resource builder.</param>
74-
/// <param name="userName">The parameter used to provide the user name for the PostgreSQL resource.</param>
74+
/// <param name="userName">The parameter used to provide the user name for the MinIO resource.</param>
7575
/// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
7676
public static IResourceBuilder<MinioContainerResource> WithUserName(this IResourceBuilder<MinioContainerResource> builder, IResourceBuilder<ParameterResource> userName)
7777
{
@@ -83,10 +83,10 @@ public static IResourceBuilder<MinioContainerResource> WithUserName(this IResour
8383
}
8484

8585
/// <summary>
86-
/// Configures the password that the MiniO resource is used.
86+
/// Configures the password that the MinIO resource is used.
8787
/// </summary>
8888
/// <param name="builder">The resource builder.</param>
89-
/// <param name="password">The parameter used to provide the password for the MiniO resource. If <see langword="null"/>, no password will be configured.</param>
89+
/// <param name="password">The parameter used to provide the password for the MinIO resource. If <see langword="null"/>, no password will be configured.</param>
9090
/// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
9191
public static IResourceBuilder<MinioContainerResource> WithPassword(this IResourceBuilder<MinioContainerResource> builder, IResourceBuilder<ParameterResource> password)
9292
{
@@ -97,11 +97,11 @@ public static IResourceBuilder<MinioContainerResource> WithPassword(this IResour
9797
}
9898

9999
/// <summary>
100-
/// Configures the host port that the PGAdmin resource is exposed on instead of using randomly assigned port.
100+
/// Configures the host port that the MinIO resource is exposed on instead of using randomly assigned port.
101101
/// </summary>
102-
/// <param name="builder">The resource builder for PGAdmin.</param>
102+
/// <param name="builder">The resource builder for MinIO.</param>
103103
/// <param name="port">The port to bind on the host. If <see langword="null"/> is used, a random port will be assigned.</param>
104-
/// <returns>The resource builder for PGAdmin.</returns>
104+
/// <returns>The resource builder for MinIO.</returns>
105105
public static IResourceBuilder<MinioContainerResource> WithHostPort(this IResourceBuilder<MinioContainerResource> builder, int? port)
106106
{
107107
ArgumentNullException.ThrowIfNull(builder);
@@ -113,14 +113,14 @@ public static IResourceBuilder<MinioContainerResource> WithHostPort(this IResour
113113
}
114114

115115
/// <summary>
116-
/// Adds a named volume for the data folder to a Minio container resource.
116+
/// Adds a named volume for the data folder to a MinIO container resource.
117117
/// </summary>
118118
/// <param name="builder">The resource builder.</param>
119119
/// <param name="name">The name of the volume. Defaults to an auto-generated name based on the application and resource names.</param>
120120
/// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
121121
/// <remarks>
122122
/// <example>
123-
/// Add an Minio container to the application model and reference it in a .NET project. Additionally, in this
123+
/// Add an MinIO container to the application model and reference it in a .NET project. Additionally, in this
124124
/// example a data volume is added to the container to allow data to be persisted across container restarts.
125125
/// <code lang="csharp">
126126
/// var builder = DistributedApplication.CreateBuilder(args);
@@ -142,14 +142,14 @@ public static IResourceBuilder<MinioContainerResource> WithDataVolume(this IReso
142142
}
143143

144144
/// <summary>
145-
/// Adds a bind mount for the data folder to a Minio container resource.
145+
/// Adds a bind mount for the data folder to a MinIO container resource.
146146
/// </summary>
147147
/// <param name="builder">The resource builder.</param>
148148
/// <param name="source">The source directory on the host to mount into the container.</param>
149149
/// <returns>The <see cref="IResourceBuilder{T}"/>.</returns>
150150
/// <remarks>
151151
/// <example>
152-
/// Add an Minio container to the application model and reference it in a .NET project. Additionally, in this
152+
/// Add an MinIO container to the application model and reference it in a .NET project. Additionally, in this
153153
/// example a bind mount is added to the container to allow data to be persisted across container restarts.
154154
/// <code lang="csharp">
155155
/// var builder = DistributedApplication.CreateBuilder(args);

‎src/CommunityToolkit.Aspire.Hosting.Minio/MinioContainerResource.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
namespace Aspire.Hosting.ApplicationModel;
22

33
/// <summary>
4-
/// A resource that represents a MiniO storage
4+
/// A resource that represents a MinIO storage
55
/// </summary>
66
public sealed class MinioContainerResource : ContainerResource, IResourceWithConnectionString
77
{
@@ -13,28 +13,28 @@ public sealed class MinioContainerResource : ContainerResource, IResourceWithCon
1313
/// Initializes a new instance of the <see cref="MinioContainerResource"/> class.
1414
/// </summary>
1515
/// <param name="name">The name of the resource.</param>
16-
/// <param name="user">A parameter that contains the Minio server root user name.</param>
17-
/// <param name="password">A parameter that contains the Minio server root password.</param>
16+
/// <param name="user">A parameter that contains the MinIO server root user name.</param>
17+
/// <param name="password">A parameter that contains the MinIO server root password.</param>
1818
public MinioContainerResource(string name, ParameterResource user, ParameterResource password) : base(name)
1919
{
2020
RootUser = user;
2121
PasswordParameter = password;
2222
}
2323

2424
/// <summary>
25-
/// The MiniO root user.
25+
/// The MinIO root user.
2626
/// </summary>
2727
public ParameterResource RootUser { get; set; }
2828

2929
/// <summary>
30-
/// The MiniO root password.
30+
/// The MinIO root password.
3131
/// </summary>
3232
public ParameterResource PasswordParameter { get; set; }
3333

3434
private EndpointReference? _primaryEndpoint;
3535

3636
/// <summary>
37-
/// Gets the primary endpoint for the Minio. This endpoint is used for all API calls over HTTP.
37+
/// Gets the primary endpoint for the MinIO. This endpoint is used for all API calls over HTTP.
3838
/// </summary>
3939
public EndpointReference PrimaryEndpoint => _primaryEndpoint ??= new(this, PrimaryEndpointName);
4040

@@ -44,10 +44,10 @@ public MinioContainerResource(string name, ParameterResource user, ParameterReso
4444
public ReferenceExpression ConnectionStringExpression => GetConnectionString();
4545

4646
/// <summary>
47-
/// Gets the connection string for the MiniO server.
47+
/// Gets the connection string for the MinIO server.
4848
/// </summary>
4949
/// <param name="cancellationToken"> A <see cref="CancellationToken"/> to observe while waiting for the task to complete.</param>
50-
/// <returns>A connection string for the PostgreSQL server in the form "Host=host;Port=port;Username=postgres;Password=password".</returns>
50+
/// <returns>A connection string for the MinIO server in the form "Host=host;Port=port;Username=postgres;Password=password".</returns>
5151
public ValueTask<string?> GetConnectionStringAsync(CancellationToken cancellationToken = default)
5252
{
5353
if (this.TryGetLastAnnotation<ConnectionStringRedirectAnnotation>(out var connectionStringAnnotation))
@@ -59,7 +59,7 @@ public MinioContainerResource(string name, ParameterResource user, ParameterReso
5959
}
6060

6161
/// <summary>
62-
/// Gets the connection string for the MiniO server.
62+
/// Gets the connection string for the MinIO server.
6363
/// </summary>
6464
private ReferenceExpression GetConnectionString()
6565
{

‎src/CommunityToolkit.Aspire.Hosting.Minio/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# CommunityToolkit.Aspire.Hosting.MinoO library
1+
# CommunityToolkit.Aspire.Hosting.MinIO library
22

3-
Provides extension methods and resource definitions for the .NET Aspire AppHost to support running [MiniO](https://min.io/) containers.
3+
Provides extension methods and resource definitions for the .NET Aspire AppHost to support running [MinIO](https://min.io/) containers.
44

55
## Getting Started
66

@@ -14,7 +14,7 @@ dotnet add package CommunityToolkit.Aspire.Hosting.Minio
1414

1515
### Example usage
1616

17-
Then, in the _Program.cs_ file of `AppHost`, add a Minio resource and consume the connection using the following methods:
17+
Then, in the _Program.cs_ file of `AppHost`, add a MinIO resource and consume the connection using the following methods:
1818

1919
```csharp
2020
var builder = DistributedApplication.CreateBuilder(args);

‎src/CommunityToolkit.Aspire.Minio.Client/CommunityToolkit.Aspire.Minio.Client.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
4-
<AdditionalPackageTags>MinioS3 Client integration</AdditionalPackageTags>
5-
<Description>A .NET Aspire client integration for MinioS#</Description>
4+
<AdditionalPackageTags>minio hosting cloud storage</AdditionalPackageTags>
5+
<Description>A .NET Aspire client integration for MinIO</Description>
66
<ImplicitUsings>enable</ImplicitUsings>
77
<Nullable>enable</Nullable>
88
</PropertyGroup>

‎src/CommunityToolkit.Aspire.Minio.Client/MinioClientBuilderExtensionMethods.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
namespace Microsoft.Extensions.Hosting;
88

99
/// <summary>
10-
/// Provides extension methods for registering MiniO-related services in an <see cref="IHostApplicationBuilder"/>.
10+
/// Provides extension methods for registering MinIO-related services in an <see cref="IHostApplicationBuilder"/>.
1111
/// </summary>
1212
public static class MinioClientBuilderExtensionMethods
1313
{
1414
private const string DefaultConfigSectionName = "Aspire:Minio:Client";
1515

1616
/// <summary>
17-
/// Adds Minio Client to ASPNet host
17+
/// Adds MinIO Client to ASPNet host
1818
/// </summary>
1919
/// <param name="builder">The <see cref="IHostApplicationBuilder"/> used to add services.</param>
2020
/// <param name="configurationSectionName">Name of the configuration settings section</param>
@@ -37,7 +37,7 @@ private static void AddMinioInternal(this IHostApplicationBuilder builder, Minio
3737
{
3838
ArgumentNullException.ThrowIfNull(settings);
3939

40-
// Add the Minio client to the service collection.
40+
// Add the MinIO client to the service collection.
4141
void ConfigureClient(IMinioClient configureClient)
4242
{
4343
var client = configureClient.WithEndpoint(settings.Endpoint)
@@ -59,7 +59,7 @@ void ConfigureClient(IMinioClient configureClient)
5959
IMinioClient GetClient()
6060
{
6161
if (settings.Endpoint is null)
62-
throw new InvalidOperationException("The MiniO endpoint must be provided either in configuration section, or as a part of connection string or settings delegate");
62+
throw new InvalidOperationException("The MinIO endpoint must be provided either in configuration section, or as a part of connection string or settings delegate");
6363

6464
return minioClientFactory.CreateClient();
6565
}

‎src/CommunityToolkit.Aspire.Minio.Client/MinioClientSettings.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
namespace CommunityToolkit.Aspire.Minio.Client;
66

77
/// <summary>
8-
/// Minio client configuration
8+
/// MinIO client configuration
99
/// </summary>
1010
public sealed class MinioClientSettings
1111
{
@@ -30,7 +30,7 @@ public sealed class MinioClientSettings
3030
public HeaderAppInformation? UserAgentHeaderInfo { get; set; }
3131

3232
/// <summary>
33-
/// Minio client service lifetime
33+
/// MinIO client service lifetime
3434
/// </summary>
3535
public ServiceLifetime ServiceLifetime = ServiceLifetime.Singleton;
3636

@@ -92,17 +92,17 @@ public class HeaderAppInformation
9292
}
9393

9494
/// <summary>
95-
/// Minio credentials (access and secret keys)
95+
/// MinIO credentials (access and secret keys)
9696
/// </summary>
9797
public class MinioCredentials
9898
{
9999
/// <summary>
100-
/// Minio Access Key
100+
/// MinIO Access Key
101101
/// </summary>
102102
public string AccessKey { get; set; } = string.Empty;
103103

104104
/// <summary>
105-
/// Minio Secret Key
105+
/// MinIO Secret Key
106106
/// </summary>
107107
public string SecretKey { get; set; } = string.Empty;
108108
}

0 commit comments

Comments
 (0)