Skip to content

Commit

Permalink
Updating to reflect the latest changes in the TCA API
Browse files Browse the repository at this point in the history
  • Loading branch information
tiipghci committed Apr 29, 2022
1 parent 6e4b2b5 commit f21cd0d
Show file tree
Hide file tree
Showing 209 changed files with 2,068 additions and 1,858 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
#
# This file is auto-generated by OpenAPI Generator (https://openapi-generator.tech)

name: Java CI with Maven

on:
push:
branches: [ main, master ]
pull_request:
branches: [ main, master ]

jobs:
build:
name: Build Turnitin Core API
runs-on: ubuntu-latest
strategy:
matrix:
java: [ '8' ]
steps:
- uses: actions/checkout@v2
- name: Set up JDK
uses: actions/setup-java@v2
with:
java-version: ${{ matrix.java }}
distribution: 'temurin'
cache: maven
- name: Build with Maven
run: mvn -B package --no-transfer-progress --file pom.xml
1 change: 1 addition & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.github/workflows/maven.yml
.gitignore
.travis.yml
README.md
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# openapi-java-client

Turnitin Core API
- API version: 1.0.241
- Build date: 2022-02-16T12:23:06.789415Z[Etc/UTC]
- API version: 1.0.246
- Build date: 2022-04-29T18:43:07.985965Z[Etc/UTC]

Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download.
Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs).
Expand Down Expand Up @@ -67,7 +67,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-java-client</artifactId>
<version>1.0.241</version>
<version>1.0.246</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -83,7 +83,7 @@ Add this dependency to your project's build file:
}
dependencies {
implementation "org.openapitools:openapi-java-client:1.0.241"
implementation "org.openapitools:openapi-java-client:1.0.246"
}
```

Expand All @@ -97,7 +97,7 @@ mvn clean package

Then manually install the following JARs:

* `target/openapi-java-client-1.0.241.jar`
* `target/openapi-java-client-1.0.246.jar`
* `target/lib/*.jar`

## Getting Started
Expand Down
32 changes: 16 additions & 16 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ info:
\ is complete\n * The status of the *report* will also be updated to `COMPLETE`\n\
\ * Request a URL with parameters to view the Similarity Report\n"
title: Turnitin Core API
version: 1.0.241
version: 1.0.246
externalDocs:
description: Developer Portal Documentation page
url: https://developers.turnitin.com/docs
Expand Down Expand Up @@ -242,7 +242,7 @@ paths:
tags:
- EULA
x-codegen-request-body-name: data
x-contentType: application/json
x-content-type: application/json
x-accepts: application/json
/eula/{version_id}/accept/{user_id}:
get:
Expand Down Expand Up @@ -502,7 +502,7 @@ paths:
tags:
- Submission
x-codegen-request-body-name: data
x-contentType: application/json
x-content-type: application/json
x-accepts: application/json
/submissions/{id}/original:
put:
Expand Down Expand Up @@ -603,7 +603,7 @@ paths:
tags:
- Submission
x-codegen-request-body-name: file
x-contentType: binary/octet-stream
x-content-type: binary/octet-stream
x-accepts: application/json
/submissions/{id}:
delete:
Expand Down Expand Up @@ -939,7 +939,7 @@ paths:
tags:
- Similarity
x-codegen-request-body-name: data
x-contentType: application/json
x-content-type: application/json
x-accepts: application/json
/submissions/{id}/viewer-url:
post:
Expand Down Expand Up @@ -1010,7 +1010,7 @@ paths:
tags:
- Similarity
x-codegen-request-body-name: data
x-contentType: application/json
x-content-type: application/json
x-accepts: application/json
/submissions/{id}/similarity/pdf:
post:
Expand Down Expand Up @@ -1694,7 +1694,7 @@ paths:
tags:
- Webhook
x-codegen-request-body-name: data
x-contentType: application/json
x-content-type: application/json
x-accepts: application/json
/webhooks/{id}:
delete:
Expand Down Expand Up @@ -1859,7 +1859,7 @@ paths:
tags:
- Webhook
x-codegen-request-body-name: data
x-contentType: application/json
x-content-type: application/json
x-accepts: application/json
/groups/{group_id}:
get:
Expand Down Expand Up @@ -1991,7 +1991,7 @@ paths:
tags:
- Groups
x-codegen-request-body-name: data
x-contentType: application/json
x-content-type: application/json
x-accepts: application/json
/groups/{group_id}/attachments:
get:
Expand Down Expand Up @@ -2115,7 +2115,7 @@ paths:
tags:
- Groups
x-codegen-request-body-name: data
x-contentType: application/json
x-content-type: application/json
x-accepts: application/json
/groups/{group_id}/attachments/{attach_id}/original:
put:
Expand Down Expand Up @@ -2216,7 +2216,7 @@ paths:
tags:
- Groups
x-codegen-request-body-name: file
x-contentType: binary/octet-stream
x-content-type: binary/octet-stream
x-accepts: application/json
/groups/{group_id}/attachments/{attach_id}:
delete:
Expand Down Expand Up @@ -2390,7 +2390,7 @@ paths:
tags:
- Groups
x-codegen-request-body-name: data
x-contentType: application/json
x-content-type: application/json
x-accepts: application/json
components:
parameters:
Expand Down Expand Up @@ -2823,8 +2823,8 @@ components:
exclude_bibliography: true
exclude_crossref: true
access_options:
- Native
- Native
- NATIVE
- NATIVE
product_name: product_name
tenant:
require_eula: true
Expand All @@ -2838,9 +2838,9 @@ components:
access_options:
items:
enum:
- Native
- NATIVE
- CORE_API
- Draft Coach
- DRAFT_COACH
type: string
type: array
type: object
Expand Down
26 changes: 13 additions & 13 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ apply plugin: 'java'
apply plugin: 'com.diffplug.spotless'

group = 'org.openapitools'
version = '1.0.241'
version = '1.0.246'

buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.3.+'
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
classpath 'com.diffplug.spotless:spotless-plugin-gradle:5.17.1'
classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.3.0'
}
}

Expand Down Expand Up @@ -106,19 +106,19 @@ ext {
}

dependencies {
implementation 'io.swagger:swagger-annotations:1.5.24'
implementation 'io.swagger:swagger-annotations:1.6.5'
implementation "com.google.code.findbugs:jsr305:3.0.2"
implementation 'com.squareup.okhttp3:okhttp:4.9.1'
implementation 'com.squareup.okhttp3:logging-interceptor:4.9.1'
implementation 'com.google.code.gson:gson:2.8.6'
implementation 'io.gsonfire:gson-fire:1.8.4'
implementation 'com.squareup.okhttp3:okhttp:4.9.3'
implementation 'com.squareup.okhttp3:logging-interceptor:4.9.3'
implementation 'com.google.code.gson:gson:2.9.0'
implementation 'io.gsonfire:gson-fire:1.8.5'
implementation 'javax.ws.rs:jsr311-api:1.1.1'
implementation 'javax.ws.rs:javax.ws.rs-api:2.0'
implementation 'org.openapitools:jackson-databind-nullable:0.2.1'
implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.10'
implementation 'javax.ws.rs:javax.ws.rs-api:2.1.1'
implementation 'org.openapitools:jackson-databind-nullable:0.2.2'
implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.12.0'
implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version"
testImplementation 'junit:junit:4.13.1'
testImplementation 'org.mockito:mockito-core:3.11.2'
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.2'
testImplementation 'org.mockito:mockito-core:3.12.4'
}

javadoc {
Expand Down
18 changes: 9 additions & 9 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@ lazy val root = (project in file(".")).
settings(
organization := "org.openapitools",
name := "openapi-java-client",
version := "1.0.241",
version := "1.0.246",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
publishArtifact in (Compile, packageDoc) := false,
resolvers += Resolver.mavenLocal,
libraryDependencies ++= Seq(
"io.swagger" % "swagger-annotations" % "1.5.24",
"com.squareup.okhttp3" % "okhttp" % "4.9.1",
"com.squareup.okhttp3" % "logging-interceptor" % "4.9.1",
"com.google.code.gson" % "gson" % "2.8.6",
"org.apache.commons" % "commons-lang3" % "3.10",
"io.swagger" % "swagger-annotations" % "1.6.5",
"com.squareup.okhttp3" % "okhttp" % "4.9.3",
"com.squareup.okhttp3" % "logging-interceptor" % "4.9.3",
"com.google.code.gson" % "gson" % "2.9.0",
"org.apache.commons" % "commons-lang3" % "3.12.0",
"javax.ws.rs" % "jsr311-api" % "1.1.1",
"javax.ws.rs" % "javax.ws.rs-api" % "2.0",
"javax.ws.rs" % "javax.ws.rs-api" % "2.1.1",
"org.openapitools" % "jackson-databind-nullable" % "0.2.2",
"io.gsonfire" % "gson-fire" % "1.8.3" % "compile",
"io.gsonfire" % "gson-fire" % "1.8.5" % "compile",
"jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile",
"com.google.code.findbugs" % "jsr305" % "3.0.2" % "compile",
"jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile",
"junit" % "junit" % "4.13.1" % "test",
"org.junit.jupiter" % "junit-jupiter-api" % "5.8.2" % "test",
"com.novocode" % "junit-interface" % "0.10" % "test"
)
)
8 changes: 4 additions & 4 deletions docs/AddGroupAttachmentRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Request Object to add group attachment.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **String** | Attachment title | [optional]
**template** | **Boolean** | template | [optional]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**title** | **String** | Attachment title | [optional] |
|**template** | **Boolean** | template | [optional] |



6 changes: 3 additions & 3 deletions docs/AddGroupAttachmentResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Object returned for add group attachment.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | Attachment uuid | [optional]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | Attachment uuid | [optional] |



32 changes: 16 additions & 16 deletions docs/AggregateGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,32 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | (required) | [optional]
**name** | **String** | | [optional]
**type** | [**TypeEnum**](#TypeEnum) | | [optional]
**groupContext** | [**GroupContext**](GroupContext.md) | | [optional]
**dueDate** | **LocalDate** | due date for the group | [optional]
**reportGeneration** | [**ReportGenerationEnum**](#ReportGenerationEnum) | | [optional]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**id** | **String** | (required) | [optional] |
|**name** | **String** | | [optional] |
|**type** | [**TypeEnum**](#TypeEnum) | | [optional] |
|**groupContext** | [**GroupContext**](GroupContext.md) | | [optional] |
|**dueDate** | **LocalDate** | due date for the group | [optional] |
|**reportGeneration** | [**ReportGenerationEnum**](#ReportGenerationEnum) | | [optional] |



## Enum: TypeEnum

Name | Value
---- | -----
ASSIGNMENT | &quot;ASSIGNMENT&quot;
FOLDER | &quot;FOLDER&quot;
| Name | Value |
|---- | -----|
| ASSIGNMENT | &quot;ASSIGNMENT&quot; |
| FOLDER | &quot;FOLDER&quot; |



## Enum: ReportGenerationEnum

Name | Value
---- | -----
IMMEDIATELY | &quot;IMMEDIATELY&quot;
IMMEDIATELY_AND_DUE_DATE | &quot;IMMEDIATELY_AND_DUE_DATE&quot;
| Name | Value |
|---- | -----|
| IMMEDIATELY | &quot;IMMEDIATELY&quot; |
| IMMEDIATELY_AND_DUE_DATE | &quot;IMMEDIATELY_AND_DUE_DATE&quot; |



8 changes: 4 additions & 4 deletions docs/AuthorMetadataOverride.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**givenName** | **String** | Given or first name of submission author | [optional]
**familyName** | **String** | Family or last name of submission author | [optional]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**givenName** | **String** | Given or first name of submission author | [optional] |
|**familyName** | **String** | Family or last name of submission author | [optional] |



8 changes: 4 additions & 4 deletions docs/Error.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ The generic object returned for errors. Updated for recent TCA changes.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **String** | an HTTP Response JobStatus Code | [optional]
**message** | **String** | A message explaining what happened | [optional]
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**status** | **String** | an HTTP Response JobStatus Code | [optional] |
|**message** | **String** | A message explaining what happened | [optional] |



Loading

0 comments on commit f21cd0d

Please sign in to comment.