SAIFENV001: SAIF Environment API is Experimental

Cause

You are using a type or member from the SAIF environment configuration API that is marked as experimental.

Rule Description

The SaifEnvironmentResource in SAIF.Platform.Aspire.Hosting is currently in preview and may change in future releases. This resource provides a central configuration point for SAIF environment settings in Aspire applications.

How to Fix

If you want to use these experimental APIs, suppress the warning:

Option 1: Suppress in code

#pragma warning disable SAIFENV001
var saif = builder.AddSaifEnvironment();
#pragma warning restore SAIFENV001

Option 2: Suppress in project file

<PropertyGroup>
  <NoWarn>$(NoWarn);SAIFENV001</NoWarn>
</PropertyGroup>

Option 3: Suppress with attribute

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage(
    "Usage",
    "SAIFENV001:Type is for evaluation purposes only")]

Affected APIs

Type	Description
SaifEnvironmentResource	SAIF environment configuration resource
SaifEnvironmentResourceExtensions	Extension methods for AddSaifEnvironment()

When Will This Be Stable?

This API is being introduced as experimental in Forge 3.1. We are gathering feedback on:

• Integration with other SAIF Aspire resources
• Environment configuration patterns
• Dashboard visualization

Once we have sufficient feedback and the API design has stabilized, we will remove the experimental designation in a future release.

Please provide feedback via the Forge repository.