Update VideoStatusIngest enum descriptions

apivideo · Feb 16, 2024 · e3a3456 · e3a3456
1 parent 19d5309
commit e3a3456
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 15 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -12055,14 +12055,17 @@ components:
         video for use immediately or in the future.
       properties:
         status:
-          description: There are three possible ingest statuses. missing - you are
-            missing information required to ingest the video. uploading - the video
-            is in the process of being uploaded. uploaded - the video is ready for
-            use.
+          description: |
+            There are four possible statuses depending on how you provide a video file:
+            - `uploading` - the API is gathering the video source file from an upload.
+            - `uploaded` - the video file is fully uploaded.
+            - `ingesting` - the API is gathering the video source file from either a URL, or from cloning.
+            - `ingested` - the video file is fully stored.
           enum:
-          - missing
           - uploading
           - uploaded
+          - ingesting
+          - ingested
           example: uploaded
           type: string
         filesize:

diff --git a/docs/VideoStatusIngest.md b/docs/VideoStatusIngest.md
@@ -7,7 +7,7 @@ Details about the capturing, transferring, and storing of your video for use imm
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**status** | [**StatusEnum**](#StatusEnum) | There are three possible ingest statuses. missing - you are missing information required to ingest the video. uploading - the video is in the process of being uploaded. uploaded - the video is ready for use. |  [optional]
+**status** | [**StatusEnum**](#StatusEnum) | There are four possible statuses depending on how you provide a video file: - &#x60;uploading&#x60; - the API is gathering the video source file from an upload. - &#x60;uploaded&#x60; - the video file is fully uploaded. - &#x60;ingesting&#x60; - the API is gathering the video source file from either a URL, or from cloning. - &#x60;ingested&#x60; - the video file is fully stored.  |  [optional]
 **filesize** | **Integer** | The size of your file in bytes. |  [optional]
 **receivedBytes** | [**List&lt;BytesRange&gt;**](BytesRange.md) | The total number of bytes received, listed for each chunk of the upload. |  [optional]
 **receivedParts** | [**VideoStatusIngestReceivedParts**](VideoStatusIngestReceivedParts.md) |  |  [optional]
@@ -18,9 +18,10 @@ Name | Type | Description | Notes
 
 Name | Value
 ---- | -----
-MISSING | &quot;missing&quot;
 UPLOADING | &quot;uploading&quot;
 UPLOADED | &quot;uploaded&quot;
+INGESTING | &quot;ingesting&quot;
+INGESTED | &quot;ingested&quot;
 
 
 ## Implemented Interfaces

diff --git a/src/main/java/video/api/client/api/models/VideoStatusIngest.java b/src/main/java/video/api/client/api/models/VideoStatusIngest.java
@@ -36,16 +36,20 @@ public class VideoStatusIngest implements Serializable {
     private static final long serialVersionUID = 1L;
 
     /**
-     * There are three possible ingest statuses. missing - you are missing information required to ingest the video.
-     * uploading - the video is in the process of being uploaded. uploaded - the video is ready for use.
+     * There are four possible statuses depending on how you provide a video file: - &#x60;uploading&#x60; - the API is
+     * gathering the video source file from an upload. - &#x60;uploaded&#x60; - the video file is fully uploaded. -
+     * &#x60;ingesting&#x60; - the API is gathering the video source file from either a URL, or from cloning. -
+     * &#x60;ingested&#x60; - the video file is fully stored.
      */
     @JsonAdapter(StatusEnum.Adapter.class)
     public enum StatusEnum {
-        MISSING("missing"),
-
         UPLOADING("uploading"),
 
-        UPLOADED("uploaded");
+        UPLOADED("uploaded"),
+
+        INGESTING("ingesting"),
+
+        INGESTED("ingested");
 
         private String value;
 
@@ -107,13 +111,15 @@ public VideoStatusIngest status(StatusEnum status) {
     }
 
     /**
-     * There are three possible ingest statuses. missing - you are missing information required to ingest the video.
-     * uploading - the video is in the process of being uploaded. uploaded - the video is ready for use.
+     * There are four possible statuses depending on how you provide a video file: - &#x60;uploading&#x60; - the API is
+     * gathering the video source file from an upload. - &#x60;uploaded&#x60; - the video file is fully uploaded. -
+     * &#x60;ingesting&#x60; - the API is gathering the video source file from either a URL, or from cloning. -
+     * &#x60;ingested&#x60; - the video file is fully stored.
      * 
      * @return status
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(example = "uploaded", value = "There are three possible ingest statuses. missing - you are missing information required to ingest the video. uploading - the video is in the process of being uploaded. uploaded - the video is ready for use.")
+    @ApiModelProperty(example = "uploaded", value = "There are four possible statuses depending on how you provide a video file: - `uploading` - the API is gathering the video source file from an upload. - `uploaded` - the video file is fully uploaded. - `ingesting` - the API is gathering the video source file from either a URL, or from cloning. - `ingested` - the video file is fully stored. ")
 
     public StatusEnum getStatus() {
         return status;