Merge pull request #104 from apivideo/update-video-status-endpoint-de…

…scription

Update VideoStatusIngest enum descriptions

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.5.5] - 2024-02-19
+- Update VideoStatusIngest enum
+
 ## [1.5.4] - 2024-01-08
 - Upgrade dependencies, gradle and Kotlin
 

README.md

@@ -70,7 +70,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>video.api</groupId>
   <artifactId>android-api-client</artifactId>
-  <version>1.5.4</version>
+  <version>1.5.5</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -80,7 +80,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-implementation "video.api:android-api-client:1.5.4"
+implementation "video.api:android-api-client:1.5.5"
 ```
 
 #### Others
@@ -93,7 +93,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/android-api-client-1.5.4.jar`
+* `target/android-api-client-1.5.5.jar`
 * `target/lib/*.jar`
 
 ### Code sample

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:

build.gradle

@@ -5,7 +5,7 @@ apply plugin: 'maven-publish'
 apply plugin: 'kotlin-android'
 
 group = 'video.api'
-version = '1.5.4'
+version = '1.5.5'
 
 buildscript {
     repositories {

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: - `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.  |  [optional]
 **filesize** | **Integer** | The size of your file in bytes. |  [optional]
 **receivedBytes** | [**List<BytesRange>**](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 | "missing"
 UPLOADING | "uploading"
 UPLOADED | "uploaded"
+INGESTING | "ingesting"
+INGESTED | "ingested"
 
 
 ## Implemented Interfaces

maven-push.gradle

@@ -18,7 +18,7 @@ apply plugin: 'maven-publish'
 apply plugin: 'signing'
 
 def isReleaseBuild() {
-    return !"1.5.4".contains("SNAPSHOT")
+    return !"1.5.5".contains("SNAPSHOT")
 }
 
 def getReleaseRepositoryUrl() {
@@ -57,7 +57,7 @@ afterEvaluate {
 
                 groupId = "video.api"
                 artifactId = "android-api-client"
-                version = "1.5.4"
+                version = "1.5.5"
 
                 pom {
                     name = "video.api:android-api-client"

pom.xml

@@ -5,7 +5,7 @@
     <artifactId>android-api-client</artifactId>
     <packaging>jar</packaging>
     <name>${project.groupId}:${project.artifactId}</name>
-    <version>1.5.4</version>
+    <version>1.5.5</version>
     <url>https://github.com/apivideo/api.video-android-client</url>
     <description>The official Android api.video client</description>
     <scm>

src/main/java/video/api/client/api/ApiClient.java

@@ -118,7 +118,7 @@ private OkHttpClient initHttpClient(List<Interceptor> interceptors) {
     private void init() {
         verifyingSsl = true;
         json = new JSON();
-        addDefaultHeader("AV-Origin-Client", "android:1.5.4");
+        addDefaultHeader("AV-Origin-Client", "android:1.5.5");
     }
 
     private boolean isValid(String regex, String field) {

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: - `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.
      */
     @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: - `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.
      * 
      * @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;