From d12b0793007916eec211bf3454dabca929af236d Mon Sep 17 00:00:00 2001 From: James Newton-King Date: Tue, 23 Jan 2024 13:50:06 +0800 Subject: [PATCH] Consistent resource type summaries --- src/Aspire.Hosting.Azure/AzureAppConfigurationResource.cs | 2 +- src/Aspire.Hosting.Azure/AzureBlobStorageResource.cs | 4 ++-- src/Aspire.Hosting.Azure/AzureCosmosDBResource.cs | 2 +- src/Aspire.Hosting.Azure/AzureKeyVaultResource.cs | 2 +- src/Aspire.Hosting/ApplicationModel/ContainerResource.cs | 5 +++-- src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs | 2 +- src/Aspire.Hosting/ApplicationModel/ProjectResource.cs | 4 ++-- src/Aspire.Hosting/Kafka/KafkaContainerResource.cs | 2 +- src/Aspire.Hosting/Node/NodeAppResource.cs | 2 +- src/Aspire.Hosting/OpenAI/OpenAIResource.cs | 2 +- src/Aspire.Hosting/Oracle/OracleDatabaseResource.cs | 2 +- src/Aspire.Hosting/Oracle/OracleDatabaseServerResource.cs | 2 +- src/Aspire.Hosting/Redis/RedisResource.cs | 2 +- src/Aspire.Hosting/SqlServer/SqlServerDatabaseResource.cs | 2 +- 14 files changed, 18 insertions(+), 17 deletions(-) diff --git a/src/Aspire.Hosting.Azure/AzureAppConfigurationResource.cs b/src/Aspire.Hosting.Azure/AzureAppConfigurationResource.cs index 83891440709..579ec0724bc 100644 --- a/src/Aspire.Hosting.Azure/AzureAppConfigurationResource.cs +++ b/src/Aspire.Hosting.Azure/AzureAppConfigurationResource.cs @@ -4,7 +4,7 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// Represents an Azure App Configuration resource. +/// A resource that represents Azure App Configuration. /// /// The name of the resource. public class AzureAppConfigurationResource(string name) : Resource(name), IAzureResource, IResourceWithConnectionString diff --git a/src/Aspire.Hosting.Azure/AzureBlobStorageResource.cs b/src/Aspire.Hosting.Azure/AzureBlobStorageResource.cs index 3fec2552a5f..264c66603d7 100644 --- a/src/Aspire.Hosting.Azure/AzureBlobStorageResource.cs +++ b/src/Aspire.Hosting.Azure/AzureBlobStorageResource.cs @@ -1,10 +1,10 @@ -// Licensed to the .NET Foundation under one or more agreements. +// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. namespace Aspire.Hosting.ApplicationModel; /// -/// Represents a resource that is stored in Azure Blob Storage. +/// A resource that represents an Azure Blob Storage account. /// /// The name of the resource. /// The that the resource is stored in. diff --git a/src/Aspire.Hosting.Azure/AzureCosmosDBResource.cs b/src/Aspire.Hosting.Azure/AzureCosmosDBResource.cs index 5a1159ba1ba..e2a11f6672d 100644 --- a/src/Aspire.Hosting.Azure/AzureCosmosDBResource.cs +++ b/src/Aspire.Hosting.Azure/AzureCosmosDBResource.cs @@ -8,7 +8,7 @@ namespace Aspire.Hosting.Azure.Data.Cosmos; /// -/// Represents a connection to an Azure Cosmos DB account. +/// A resource that represents an Azure Cosmos DB. /// /// The resource name. /// The connection string to use to connect. diff --git a/src/Aspire.Hosting.Azure/AzureKeyVaultResource.cs b/src/Aspire.Hosting.Azure/AzureKeyVaultResource.cs index 0891caf2ddf..d554da2451b 100644 --- a/src/Aspire.Hosting.Azure/AzureKeyVaultResource.cs +++ b/src/Aspire.Hosting.Azure/AzureKeyVaultResource.cs @@ -4,7 +4,7 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// Represents an Azure Key Vault resource that can be deployed to an Azure resource group. +/// A resource that represents an Azure Key Vault. /// /// The name of the resource. public class AzureKeyVaultResource(string name) : Resource(name), IAzureResource, IResourceWithConnectionString diff --git a/src/Aspire.Hosting/ApplicationModel/ContainerResource.cs b/src/Aspire.Hosting/ApplicationModel/ContainerResource.cs index 7ecf82718cb..79ff2569530 100644 --- a/src/Aspire.Hosting/ApplicationModel/ContainerResource.cs +++ b/src/Aspire.Hosting/ApplicationModel/ContainerResource.cs @@ -4,9 +4,10 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// Represents a container resource that implements -/// and . +/// A resource that represents a specified container. /// +/// The name of the resource. +/// An optional container entrypoint. public class ContainerResource(string name, string? entrypoint = null) : Resource(name), IResourceWithEnvironment, IResourceWithEndpoints { /// diff --git a/src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs b/src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs index 69a51f77ce6..3e3170c28c1 100644 --- a/src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs +++ b/src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs @@ -4,7 +4,7 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// Represents a resource that can be executed as a standalone process. +/// A resource that represents a specified executable process. /// /// The name of the resource. /// The command to execute. diff --git a/src/Aspire.Hosting/ApplicationModel/ProjectResource.cs b/src/Aspire.Hosting/ApplicationModel/ProjectResource.cs index c0a2db8e8a6..4ef808895f9 100644 --- a/src/Aspire.Hosting/ApplicationModel/ProjectResource.cs +++ b/src/Aspire.Hosting/ApplicationModel/ProjectResource.cs @@ -4,9 +4,9 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// Represents a project resource that implements and -/// . +/// A resource that represents a specified .NET project. /// +/// The name of the resource. public class ProjectResource(string name) : Resource(name), IResourceWithEnvironment, IResourceWithServiceDiscovery { } diff --git a/src/Aspire.Hosting/Kafka/KafkaContainerResource.cs b/src/Aspire.Hosting/Kafka/KafkaContainerResource.cs index f1b0fc0fb18..fc29371823f 100644 --- a/src/Aspire.Hosting/Kafka/KafkaContainerResource.cs +++ b/src/Aspire.Hosting/Kafka/KafkaContainerResource.cs @@ -8,7 +8,7 @@ namespace Aspire.Hosting; /// /// A resource that represents a Kafka broker container. /// -/// +/// The name of the resource. public class KafkaContainerResource(string name) : ContainerResource(name), IResourceWithConnectionString, IResourceWithEnvironment { /// diff --git a/src/Aspire.Hosting/Node/NodeAppResource.cs b/src/Aspire.Hosting/Node/NodeAppResource.cs index 45a25f8369c..438f41da122 100644 --- a/src/Aspire.Hosting/Node/NodeAppResource.cs +++ b/src/Aspire.Hosting/Node/NodeAppResource.cs @@ -7,7 +7,7 @@ namespace Aspire.Hosting; /// /// A resource that represents a node application. /// -/// The name of the resource +/// The name of the resource. /// The command to execute. /// The working directory to use for the command. If null, the working directory of the current process is used. /// The arguments to pass to the command. diff --git a/src/Aspire.Hosting/OpenAI/OpenAIResource.cs b/src/Aspire.Hosting/OpenAI/OpenAIResource.cs index 317424dbda4..bf21373c7c5 100644 --- a/src/Aspire.Hosting/OpenAI/OpenAIResource.cs +++ b/src/Aspire.Hosting/OpenAI/OpenAIResource.cs @@ -4,7 +4,7 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// Represents an OpenAI resource independent of hosting model. +/// A resource that represents an OpenAI resource independent of the hosting model. /// /// The name of the resource. public class OpenAIResource(string name) : Resource(name), IResourceWithConnectionString diff --git a/src/Aspire.Hosting/Oracle/OracleDatabaseResource.cs b/src/Aspire.Hosting/Oracle/OracleDatabaseResource.cs index 0f9e1dfa271..a80ddae9ac3 100644 --- a/src/Aspire.Hosting/Oracle/OracleDatabaseResource.cs +++ b/src/Aspire.Hosting/Oracle/OracleDatabaseResource.cs @@ -4,7 +4,7 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// A resource that represents a Oracle Database database. This is a child resource of a . +/// A resource that represents an Oracle Database database. This is a child resource of a . /// /// The name of the resource. /// The Oracle Database parent resource associated with this database. diff --git a/src/Aspire.Hosting/Oracle/OracleDatabaseServerResource.cs b/src/Aspire.Hosting/Oracle/OracleDatabaseServerResource.cs index ecc9ca40d29..0b624a4b9ed 100644 --- a/src/Aspire.Hosting/Oracle/OracleDatabaseServerResource.cs +++ b/src/Aspire.Hosting/Oracle/OracleDatabaseServerResource.cs @@ -6,7 +6,7 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// A resource that represents a Oracle Database container. +/// A resource that represents an Oracle Database container. /// /// The name of the resource. /// The Oracle Database server password. diff --git a/src/Aspire.Hosting/Redis/RedisResource.cs b/src/Aspire.Hosting/Redis/RedisResource.cs index 29ab2a42c5e..76ae9eb4bb0 100644 --- a/src/Aspire.Hosting/Redis/RedisResource.cs +++ b/src/Aspire.Hosting/Redis/RedisResource.cs @@ -6,7 +6,7 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// Represents a Redis resource independent of hosting model. +/// A resource that represents a Redis resource independent of the hosting model. /// /// The name of the resource. public class RedisResource(string name) : Resource(name), IResourceWithConnectionString, IRedisResource diff --git a/src/Aspire.Hosting/SqlServer/SqlServerDatabaseResource.cs b/src/Aspire.Hosting/SqlServer/SqlServerDatabaseResource.cs index 34cb4fdf0d3..7f5b6b2c464 100644 --- a/src/Aspire.Hosting/SqlServer/SqlServerDatabaseResource.cs +++ b/src/Aspire.Hosting/SqlServer/SqlServerDatabaseResource.cs @@ -4,7 +4,7 @@ namespace Aspire.Hosting.ApplicationModel; /// -/// Represents a SQL Server database resource that is a child of a SQL Server container resource. +/// A resource that represents a SQL Server database that is a child of a SQL Server container resource. /// /// The name of the resource. /// The parent SQL Server container resource.