api/spec/packages/legacy/src/info/progress.tsp

namespace OpenMeter;

using TypeSpec.Http;
using TypeSpec.OpenAPI;

@route("/api/v1/info/progress")
@tag("Lookup Information")
@friendlyName("Progress")
interface ProgressEndpoints {
  /**
   * Get progress
   */
  @get
  @route("/{id}")
  @operationId("getProgress")
  @summary("Get progress")
  getProgress(id: string): Progress | NotFoundError | CommonErrors;
}

/**
 * Progress describes a progress of a task.
 */
@friendlyName("Progress")
model Progress {
  /**
   * Success is the number of items that succeeded
   */
  success: uint64;

  /**
   * Failed is the number of items that failed
   */
  failed: uint64;

  /**
   * The total number of items to process
   */
  total: uint64;

  /**
   * The time the progress was last updated
   */
  updatedAt: DateTime;
}