Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 15 additions & 7 deletions src/frontend/src/content/docs/diagnostics/aspireprobes001.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Compiler Warning ASPIREPROBES001
seoTitle: "ASPIREPROBES001: Probe-related types and members are for"
description: Learn what causes the Aspire compiler warning ASPIREPROBES001 and how to fix it so your AppHost builds cleanly.
seoTitle: 'ASPIREPROBES001 before Aspire 17.0'
description: Learn why Aspire 17.0 graduated the HTTP probe APIs to stable, removing the need to suppress ASPIREPROBES001.
---

import { Badge } from '@astrojs/starlight/components';
Expand All @@ -13,9 +13,15 @@ import { Badge } from '@astrojs/starlight/components';
class:list={'mb-1'}
/>

> Probe-related types and members are for evaluation purposes only and are subject to change or removal in future updates. Suppress this diagnostic to proceed.
:::note[Graduated in Aspire 17.0]
The HTTP probe APIs have graduated from experimental and no longer require suppressing this diagnostic. `WithHttpProbe`, `ProbeType`, `ProbeAnnotation`, `EndpointProbeAnnotation`, and `IResourceWithProbes` are now stable. Signatures, defaults, overloads, runtime semantics, health-check behavior, and deployment output are unchanged.

This diagnostic warning is reported when using experimental health probe APIs in Aspire, including:
After upgrading to Aspire 17.0 or later, remove `ASPIREPROBES001` suppressions from _.editorconfig_ files, project `NoWarn` properties, and `#pragma warning` directives.
:::

> Before Aspire 17.0, probe-related types and members were for evaluation purposes only and subject to change or removal in future updates. Suppressing this diagnostic was required to use them.

Before Aspire 17.0, this diagnostic warning was reported when using the following experimental health probe APIs in Aspire:

- `IResourceWithProbes` interface
- `ProbeAnnotation` class and derived types
Expand All @@ -27,7 +33,7 @@ These APIs enable configuring HTTP health probes for resources to monitor startu

## Example

The following code generates `ASPIREPROBES001`:
Before Aspire 17.0, the following code generated `ASPIREPROBES001` unless the diagnostic was suppressed:

```csharp title="Using HTTP probes"
var builder = DistributedApplication.CreateBuilder(args);
Expand Down Expand Up @@ -148,9 +154,11 @@ Probes are automatically configured when deploying to supported compute environm
- **Kubernetes** — Probes are mapped to Kubernetes liveness, readiness, and startup probes
- **Docker Compose** — Health checks are configured based on probe settings

## To suppress this warning
## To correct this warning

Upgrade to Aspire 17.0 or later. After upgrading, remove `ASPIREPROBES001` suppressions from _.editorconfig_ files, project `NoWarn` properties, and `#pragma warning` directives.

Suppress the warning with either of the following methods:
For earlier versions, suppress the warning with one of the following methods:

- Set the severity of the rule in the _.editorconfig_ file.

Expand Down
2 changes: 1 addition & 1 deletion src/frontend/src/content/docs/diagnostics/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The following table lists the possible MSBuild and analyzer warnings and errors
| [ASPIREPIPELINES003](/diagnostics/aspirepipelines003/) | (Experimental) Error | Container image build APIs are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREPIPELINES004](/diagnostics/aspirepipelines004/) | (Experimental) Warning | Type is for evaluation purposes only and is subject to change or removal in future updates. |
| [ASPIREPOSTGRES001](/diagnostics/aspirepostgres001/) | (Experimental) Warning | PostgreSQL MCP integration is for evaluation purposes only and is subject to change or removal in future updates. |
| [ASPIREPROBES001](/diagnostics/aspireprobes001/) | (Experimental) Warning | Probe-related types and members are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREPROBES001](/diagnostics/aspireprobes001/) | Warning | Graduated from experimental in Aspire 17.0. HTTP probe APIs are now stable and no longer require suppressing this diagnostic. |
| [ASPIREPROCESSCOMMAND001](/diagnostics/aspireprocesscommand001/) | (Experimental) Warning | Process command types and members are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREPROJECTS001](/diagnostics/aspireprojects001/) | (Experimental) Warning | Project launch defaults types and members are for evaluation purposes only and are subject to change or removal in future updates. |
| [ASPIREPROXYENDPOINTS001](/diagnostics/aspireproxyendpoints001/) | (Experimental) Error | ProxyEndpoint members are for evaluation purposes only and are subject to change or removal in future updates. |
Expand Down
Loading