Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update VideoStatusIngest enum descriptions #104

Merged
merged 1 commit into from
Feb 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
```
Expand All @@ -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
Expand All @@ -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
Expand Down
13 changes: 8 additions & 5 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
5 changes: 3 additions & 2 deletions docs/VideoStatusIngest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions maven-push.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/video/api/client/api/ApiClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
22 changes: 14 additions & 8 deletions src/main/java/video/api/client/api/models/VideoStatusIngest.java
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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;
Expand Down
Loading