Skip to content

Commit 22ef182

Browse files
Merge pull request #114 from apivideo/update-video-status-endpoint-description
Update VideoStatusIngest enum descriptions
2 parents d550abe + 93ea5c3 commit 22ef182

File tree

8 files changed

+34
-21
lines changed

8 files changed

+34
-21
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Changelog
22
All changes to this project will be documented in this file.
33

4+
## [1.3.2] - 2024-02-19
5+
- Update VideoStatusIngest enum
6+
47
## [1.3.1] - 2023-08-10
58
- Fix upload with upload token and video id when video is smaller than chunk size
69

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Add this dependency to your project's POM:
6868
<dependency>
6969
<groupId>video.api</groupId>
7070
<artifactId>java-api-client</artifactId>
71-
<version>1.3.1</version>
71+
<version>1.3.2</version>
7272
<scope>compile</scope>
7373
</dependency>
7474
```
@@ -78,7 +78,7 @@ Add this dependency to your project's POM:
7878
Add this dependency to your project's build file:
7979

8080
```groovy
81-
implementation "video.api:java-api-client:1.3.1"
81+
implementation "video.api:java-api-client:1.3.2"
8282
```
8383

8484
#### Others
@@ -91,7 +91,7 @@ mvn clean package
9191

9292
Then manually install the following JARs:
9393

94-
* `target/java-api-client-1.3.1.jar`
94+
* `target/java-api-client-1.3.2.jar`
9595
* `target/lib/*.jar`
9696

9797
### Code sample

api/openapi.yaml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12055,14 +12055,17 @@ components:
1205512055
video for use immediately or in the future.
1205612056
properties:
1205712057
status:
12058-
description: There are three possible ingest statuses. missing - you are
12059-
missing information required to ingest the video. uploading - the video
12060-
is in the process of being uploaded. uploaded - the video is ready for
12061-
use.
12058+
description: |
12059+
There are four possible statuses depending on how you provide a video file:
12060+
- `uploading` - the API is gathering the video source file from an upload.
12061+
- `uploaded` - the video file is fully uploaded.
12062+
- `ingesting` - the API is gathering the video source file from either a URL, or from cloning.
12063+
- `ingested` - the video file is fully stored.
1206212064
enum:
12063-
- missing
1206412065
- uploading
1206512066
- uploaded
12067+
- ingesting
12068+
- ingested
1206612069
example: uploaded
1206712070
type: string
1206812071
filesize:

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ apply plugin: 'com.diffplug.spotless'
44
apply plugin: 'maven-publish'
55

66
group = 'video.api'
7-
version = '1.3.1'
7+
version = '1.3.2'
88

99
buildscript {
1010
repositories {

docs/VideoStatusIngest.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Details about the capturing, transferring, and storing of your video for use imm
77

88
Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
10-
**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]
10+
**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]
1111
**filesize** | **Integer** | The size of your file in bytes. | [optional]
1212
**receivedBytes** | [**List&lt;BytesRange&gt;**](BytesRange.md) | The total number of bytes received, listed for each chunk of the upload. | [optional]
1313
**receivedParts** | [**VideoStatusIngestReceivedParts**](VideoStatusIngestReceivedParts.md) | | [optional]
@@ -18,9 +18,10 @@ Name | Type | Description | Notes
1818

1919
Name | Value
2020
---- | -----
21-
MISSING | &quot;missing&quot;
2221
UPLOADING | &quot;uploading&quot;
2322
UPLOADED | &quot;uploaded&quot;
23+
INGESTING | &quot;ingesting&quot;
24+
INGESTED | &quot;ingested&quot;
2425

2526

2627
## Implemented Interfaces

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<artifactId>java-api-client</artifactId>
66
<packaging>jar</packaging>
77
<name>${project.groupId}:${project.artifactId}</name>
8-
<version>1.3.1</version>
8+
<version>1.3.2</version>
99
<url>https://github.com/apivideo/api.video-java-client</url>
1010
<description>api.video Java API client</description>
1111
<scm>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ private OkHttpClient initHttpClient(List<Interceptor> interceptors) {
118118
private void init() {
119119
verifyingSsl = true;
120120
json = new JSON();
121-
addDefaultHeader("AV-Origin-Client", "java:1.3.1");
121+
addDefaultHeader("AV-Origin-Client", "java:1.3.2");
122122
}
123123

124124
private boolean isValid(String regex, String field) {

src/main/java/video/api/client/api/models/VideoStatusIngest.java

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,20 @@ public class VideoStatusIngest implements Serializable {
3636
private static final long serialVersionUID = 1L;
3737

3838
/**
39-
* There are three possible ingest statuses. missing - you are missing information required to ingest the video.
40-
* uploading - the video is in the process of being uploaded. uploaded - the video is ready for use.
39+
* There are four possible statuses depending on how you provide a video file: - &#x60;uploading&#x60; - the API is
40+
* gathering the video source file from an upload. - &#x60;uploaded&#x60; - the video file is fully uploaded. -
41+
* &#x60;ingesting&#x60; - the API is gathering the video source file from either a URL, or from cloning. -
42+
* &#x60;ingested&#x60; - the video file is fully stored.
4143
*/
4244
@JsonAdapter(StatusEnum.Adapter.class)
4345
public enum StatusEnum {
44-
MISSING("missing"),
45-
4646
UPLOADING("uploading"),
4747

48-
UPLOADED("uploaded");
48+
UPLOADED("uploaded"),
49+
50+
INGESTING("ingesting"),
51+
52+
INGESTED("ingested");
4953

5054
private String value;
5155

@@ -107,13 +111,15 @@ public VideoStatusIngest status(StatusEnum status) {
107111
}
108112

109113
/**
110-
* There are three possible ingest statuses. missing - you are missing information required to ingest the video.
111-
* uploading - the video is in the process of being uploaded. uploaded - the video is ready for use.
114+
* There are four possible statuses depending on how you provide a video file: - &#x60;uploading&#x60; - the API is
115+
* gathering the video source file from an upload. - &#x60;uploaded&#x60; - the video file is fully uploaded. -
116+
* &#x60;ingesting&#x60; - the API is gathering the video source file from either a URL, or from cloning. -
117+
* &#x60;ingested&#x60; - the video file is fully stored.
112118
*
113119
* @return status
114120
**/
115121
@javax.annotation.Nullable
116-
@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.")
122+
@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. ")
117123

118124
public StatusEnum getStatus() {
119125
return status;

0 commit comments

Comments
 (0)