docs(internal): add warning about implementing interface

Author: stainless-app[bot]

src/ArcadeDotnet/Core/FreezableDictionary.cs

@@ -7,8 +7,7 @@
 namespace ArcadeDotnet.Core;
 
 /// <summary>
-/// A dictionary that can be mutated and then frozen once no more mutations are expected.<br
-/// /><br />
+/// A dictionary that can be mutated and then frozen once no more mutations are expected.
 ///
 /// <para>This is useful for allowing a dictionary to be modified by a class's `init`
 /// properties, but then preventing it from being modified afterwards.</para>

src/ArcadeDotnet/Core/IVariant.cs

@@ -187,6 +187,11 @@ public IReadOnlyDictionary<string, JsonElement> Properties
     public abstract void Validate();
 }
 
+/// <summary>
+/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
+/// changes in non-major versions. We may add new methods in the future that cause
+/// existing derived classes to break.
+/// </summary>
 interface IFromRaw<T>
 {
     static abstract T FromRawUnchecked(IReadOnlyDictionary<string, JsonElement> properties);

src/ArcadeDotnet/Core/ModelBase.cs

@@ -7,6 +7,11 @@
 
 namespace ArcadeDotnet;
 
+/// <summary>
+/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
+/// changes in non-major versions. We may add new methods in the future that cause
+/// existing derived classes to break.
+/// </summary>
 public interface IArcadeClient
 {
     HttpClient HttpClient { get; init; }

src/ArcadeDotnet/IArcadeClient.cs

@@ -6,6 +6,11 @@
 
 namespace ArcadeDotnet.Services.Admin;
 
+/// <summary>
+/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
+/// changes in non-major versions. We may add new methods in the future that cause
+/// existing derived classes to break.
+/// </summary>
 public interface IAuthProviderService
 {
     IAuthProviderService WithOptions(Func<ClientOptions, ClientOptions> modifier);

src/ArcadeDotnet/Services/Admin/IAuthProviderService.cs

@@ -6,6 +6,11 @@
 
 namespace ArcadeDotnet.Services.Admin;
 
+/// <summary>
+/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
+/// changes in non-major versions. We may add new methods in the future that cause
+/// existing derived classes to break.
+/// </summary>
 public interface ISecretService
 {
     ISecretService WithOptions(Func<ClientOptions, ClientOptions> modifier);

src/ArcadeDotnet/Services/Admin/ISecretService.cs

@@ -6,6 +6,11 @@
 
 namespace ArcadeDotnet.Services.Admin;
 
+/// <summary>
+/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
+/// changes in non-major versions. We may add new methods in the future that cause
+/// existing derived classes to break.
+/// </summary>
 public interface IUserConnectionService
 {
     IUserConnectionService WithOptions(Func<ClientOptions, ClientOptions> modifier);

src/ArcadeDotnet/Services/Admin/IUserConnectionService.cs

@@ -7,6 +7,11 @@
 
 namespace ArcadeDotnet.Services.Chat;
 
+/// <summary>
+/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
+/// changes in non-major versions. We may add new methods in the future that cause
+/// existing derived classes to break.
+/// </summary>
 public interface ICompletionService
 {
     ICompletionService WithOptions(Func<ClientOptions, ClientOptions> modifier);

src/ArcadeDotnet/Services/Chat/ICompletionService.cs

@@ -4,6 +4,11 @@
 
 namespace ArcadeDotnet.Services;
 
+/// <summary>
+/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
+/// changes in non-major versions. We may add new methods in the future that cause
+/// existing derived classes to break.
+/// </summary>
 public interface IAdminService
 {
     IAdminService WithOptions(Func<ClientOptions, ClientOptions> modifier);

src/ArcadeDotnet/Services/IAdminService.cs

@@ -7,6 +7,11 @@
 
 namespace ArcadeDotnet.Services;
 
+/// <summary>
+/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
+/// changes in non-major versions. We may add new methods in the future that cause
+/// existing derived classes to break.
+/// </summary>
 public interface IAuthService
 {
     IAuthService WithOptions(Func<ClientOptions, ClientOptions> modifier);