Skip to content

Commit 6e1ea3b

Browse files
Rename ASPIRECOSMOS001 to ASPIRECOSMOSDB001 (#7691)
Based on API review feedback Co-authored-by: Eric Erhardt <[email protected]>
1 parent 0719438 commit 6e1ea3b

File tree

4 files changed

+9
-8
lines changed

4 files changed

+9
-8
lines changed

playground/CosmosEndToEnd/CosmosEndToEnd.AppHost/Program.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
// Licensed to the .NET Foundation under one or more agreements.
22
// The .NET Foundation licenses this file to you under the MIT license.
33

4+
#pragma warning disable ASPIRECOSMOSDB001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
5+
46
var builder = DistributedApplication.CreateBuilder(args);
57

6-
#pragma warning disable ASPIRECOSMOS001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
78
var cosmos = builder.AddAzureCosmosDB("cosmos")
89
.RunAsPreviewEmulator(e => e.WithDataExplorer());
9-
#pragma warning restore ASPIRECOSMOS001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
10+
1011
var db = cosmos.AddCosmosDatabase("db");
1112
db.AddContainer("entries", "/id");
1213

src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public static IResourceBuilder<AzureCosmosDBResource> RunAsEmulator(this IResour
6262
/// <remarks>
6363
/// This version of the package defaults to the <inheritdoc cref="CosmosDBEmulatorContainerImageTags.TagVNextPreview"/> tag of the <inheritdoc cref="CosmosDBEmulatorContainerImageTags.Registry"/>/<inheritdoc cref="CosmosDBEmulatorContainerImageTags.Image"/> container image.
6464
/// </remarks>
65-
[Experimental("ASPIRECOSMOS001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
65+
[Experimental("ASPIRECOSMOSDB001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
6666
public static IResourceBuilder<AzureCosmosDBResource> RunAsPreviewEmulator(this IResourceBuilder<AzureCosmosDBResource> builder, Action<IResourceBuilder<AzureCosmosDBEmulatorResource>>? configureContainer = null)
6767
=> builder.RunAsEmulator(configureContainer, useVNextPreview: true);
6868

@@ -275,7 +275,7 @@ public static IResourceBuilder<AzureCosmosDBContainerResource> AddContainer(this
275275
/// <remarks>
276276
/// The Data Explorer is only available with <see cref="RunAsPreviewEmulator"/>.
277277
/// </remarks>
278-
[Experimental("ASPIRECOSMOS001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
278+
[Experimental("ASPIRECOSMOSDB001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
279279
public static IResourceBuilder<AzureCosmosDBEmulatorResource> WithDataExplorer(this IResourceBuilder<AzureCosmosDBEmulatorResource> builder, int? port = null)
280280
{
281281
if (!builder.Resource.InnerResource.IsPreviewEmulator)

tests/Aspire.Hosting.Azure.Tests/AzureCosmosDBEmulatorFunctionalTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -346,9 +346,9 @@ void WithVolume(IResourceBuilder<AzureCosmosDBEmulatorResource> emulator)
346346
}
347347

348348
return usePreview
349-
#pragma warning disable ASPIRECOSMOS001 // RunAsPreviewEmulator is experimental
349+
#pragma warning disable ASPIRECOSMOSDB001 // RunAsPreviewEmulator is experimental
350350
? builder.RunAsPreviewEmulator(WithVolume)
351-
#pragma warning restore ASPIRECOSMOS001 // RunAsPreviewEmulator is experimental
351+
#pragma warning restore ASPIRECOSMOSDB001 // RunAsPreviewEmulator is experimental
352352
: builder.RunAsEmulator(WithVolume);
353353
}
354354
}

tests/Aspire.Hosting.Azure.Tests/AzureCosmosDBExtensionsTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public async Task AddAzureCosmosDBWithPartitionCountCanOverrideNumberOfPartition
7272
[Fact]
7373
public void AddAzureCosmosDBWithDataExplorer()
7474
{
75-
#pragma warning disable ASPIRECOSMOS001 // RunAsPreviewEmulator is experimental
75+
#pragma warning disable ASPIRECOSMOSDB001 // RunAsPreviewEmulator is experimental
7676
using var builder = TestDistributedApplicationBuilder.Create();
7777

7878
var cosmos = builder.AddAzureCosmosDB("cosmos");
@@ -85,7 +85,7 @@ public void AddAzureCosmosDBWithDataExplorer()
8585
// WithDataExplorer doesn't work against the non-preview emulator
8686
var cosmos2 = builder.AddAzureCosmosDB("cosmos2");
8787
Assert.Throws<NotSupportedException>(() => cosmos2.RunAsEmulator(e => e.WithDataExplorer()));
88-
#pragma warning restore ASPIRECOSMOS001 // RunAsPreviewEmulator is experimental
88+
#pragma warning restore ASPIRECOSMOSDB001 // RunAsPreviewEmulator is experimental
8989
}
9090

9191
[Fact]

0 commit comments

Comments
 (0)