Model Ingestion Version message (#427)

docker-compose-internal.yml

@@ -97,10 +97,7 @@ services:
 
       STRATEGY_LOCAL: "true"
 
-      POSTGRES_URL: "postgres"
-      POSTGRES_USER: "speckle"
-      POSTGRES_PASSWORD: "speckle"
-      POSTGRES_DB: "speckle"
+      POSTGRES_URL: 'postgres://speckle:speckle@postgres:5432/speckle'
       ENABLE_MP: "false"
 
       LOG_PRETTY: "true"

src/Speckle.Sdk/Api/GraphQL/Inputs/FileImportInputs.cs

@@ -2,8 +2,10 @@
 
 public record GenerateFileUploadUrlInput(string projectId, string fileName);
 
+[Obsolete(FileImportInputBase.FILE_IMPORT_DEPRECATION_MESSAGE)]
 public record StartFileImportInput(string projectId, string modelId, string fileId, string etag);
 
+[Obsolete(FileImportInputBase.FILE_IMPORT_DEPRECATION_MESSAGE)]
 public record FileImportResult(
   double durationSeconds,
   double downloadDurationSeconds,
@@ -14,14 +16,23 @@ public record FileImportResult(
 
 public abstract class FileImportInputBase
 {
+  internal const string FILE_IMPORT_DEPRECATION_MESSAGE =
+    "Part of the old API surface and will be removed in the future. Use the new ingestion API instead. Field will be deleted on June 1st, 2026";
+
+  [Obsolete(FileImportInputBase.FILE_IMPORT_DEPRECATION_MESSAGE)]
+  protected FileImportInputBase() { }
+
   public required string projectId { get; init; }
   public required string jobId { get; init; }
   public required IReadOnlyCollection<string> warnings { get; init; }
+
+  [Obsolete(FileImportInputBase.FILE_IMPORT_DEPRECATION_MESSAGE)]
   public required FileImportResult result { get; init; }
 }
 
 #pragma warning disable CA1822 //Mark members as static
 
+[Obsolete(FILE_IMPORT_DEPRECATION_MESSAGE)]
 public sealed class FileImportSuccessInput() : FileImportInputBase()
 {
   public const string TYPE_STATUS = "success";
@@ -29,6 +40,7 @@ public sealed class FileImportSuccessInput() : FileImportInputBase()
   public string status => TYPE_STATUS;
 }
 
+[Obsolete(FILE_IMPORT_DEPRECATION_MESSAGE)]
 public sealed class FileImportErrorInput() : FileImportInputBase()
 {
   public const string TYPE_STATUS = "error";

src/Speckle.Sdk/Api/GraphQL/Inputs/ModelIngestionInputs.cs

@@ -19,7 +19,12 @@ public record ModelIngestionCreateInput(
 
 public record ModelIngestionUpdateInput(string ingestionId, string projectId, string progressMessage, double? progress);
 
-public record ModelIngestionSuccessInput(string ingestionId, string projectId, string rootObjectId);
+public record ModelIngestionSuccessInput(
+  string ingestionId,
+  string projectId,
+  string rootObjectId,
+  string? versionMessage
+);
 
 public record ModelIngestionFailedInput(
   string ingestionId,

src/Speckle.Sdk/Api/GraphQL/Inputs/VersionInputs.cs

@@ -1,4 +1,6 @@
-namespace Speckle.Sdk.Api.GraphQL.Inputs;
+using Version = Speckle.Sdk.Api.GraphQL.Models.Version;
+
+namespace Speckle.Sdk.Api.GraphQL.Inputs;
 
 public record UpdateVersionInput(string versionId, string projectId, string? message);
 
@@ -16,6 +18,10 @@ public record CreateVersionInput(
   IReadOnlyList<string>? parents = null
 );
 
+/// <param name="versionId"></param>
+/// <param name="projectId"></param>
+/// <param name="sourceApplication">IMPORTANT: this is meant to be the slug of the application that has done the receiving, not to be confused with <see cref="Version.sourceApplication"/></param>
+/// <param name="message"></param>
 public record MarkReceivedVersionInput(
   string versionId,
   string projectId,

src/Speckle.Sdk/Api/GraphQL/Models/PendingStreamCollaborator.cs

@@ -10,7 +10,7 @@ public sealed class PendingStreamCollaborator
   public string projectName { get; init; }
   public string title { get; init; }
   public string role { get; init; }
-  public LimitedUser invitedBy { get; init; }
+  public LimitedUser? invitedBy { get; init; }
   public LimitedUser? user { get; init; }
   public string? token { get; init; }
 }

src/Speckle.Sdk/Api/GraphQL/Resources/FileImportResource.cs

@@ -29,8 +29,10 @@ public sealed class FileImportResource : IDisposable
   /// <remarks>
   /// Only use this if you are writing a file importer, that is responsible for
   /// processing file import jobs.
-  /// Only works on servers version >=2.25.8
+  /// Only works on servers version >=2.25.8 but from 3.0.7 onwards has been deprecated and replaced by model ingestion api
+  /// see <see cref="ModelIngestionResource.Complete"/>
   /// </remarks>
+  [Obsolete(FileImportInputBase.FILE_IMPORT_DEPRECATION_MESSAGE)]
   public async Task<bool> FinishFileImportJob(FileImportInputBase input, CancellationToken cancellationToken)
   {
     //language=graphql
@@ -57,7 +59,11 @@ public sealed class FileImportResource : IDisposable
   /// <param name="cancellationToken"></param>
   /// <returns></returns>
   /// <inheritdoc cref="ISpeckleGraphQLClient.ExecuteGraphQLRequest{T}"/>
-  /// <remarks>Only works on servers version >=2.25.8</remarks>
+  /// <remarks>
+  /// Only works on servers version >=2.25.8 but from 3.0.7 onwards has been deprecated and replaced by model ingestion api
+  /// see <see cref="ModelIngestionResource.StartProcessing"/>
+  /// </remarks>
+  [Obsolete(FileImportInputBase.FILE_IMPORT_DEPRECATION_MESSAGE)]
   public async Task<FileImport> StartFileImportJob(
     StartFileImportInput input,
     CancellationToken cancellationToken = default

tests/Speckle.Sdk.Tests.Integration/Api/GraphQL/Resources/ModelIngestionResourceTests.cs

@@ -130,7 +130,7 @@ public sealed class ModelIngestionResourceTests : IAsyncLifetime
       new(true, true)
     );
 
-    ModelIngestionSuccessInput finish = new(ingest.id, _project.id, sendResult.RootId);
+    ModelIngestionSuccessInput finish = new(ingest.id, _project.id, sendResult.RootId, "yay!");
     string versionId = await Sut.Complete(finish);
     Version version = await _testUser.Version.Get(versionId, _project.id);
     Assert.Equal(version.id, versionId);