Skip to content

Commit 97b5f24

Browse files
tiipghcitiipghci
committed
Updating to reflect the latest changes in the TCA API
1 parent 0f51f2c commit 97b5f24

File tree

154 files changed

+295
-274
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+295
-274
lines changed

‎README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# openapi-java-client
22

33
Turnitin Core API
4-
- API version: 1.0.223
5-
- Build date: 2021-08-27T14:06:39.372607Z[Etc/UTC]
4+
- API version: 1.0.225
5+
- Build date: 2021-09-20T14:49:58.536757Z[Etc/UTC]
66

77
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.
88
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).
@@ -67,7 +67,7 @@ Add this dependency to your project's POM:
6767
<dependency>
6868
<groupId>org.openapitools</groupId>
6969
<artifactId>openapi-java-client</artifactId>
70-
<version>1.0.223</version>
70+
<version>1.0.225</version>
7171
<scope>compile</scope>
7272
</dependency>
7373
```
@@ -77,7 +77,7 @@ Add this dependency to your project's POM:
7777
Add this dependency to your project's build file:
7878

7979
```groovy
80-
compile "org.openapitools:openapi-java-client:1.0.223"
80+
compile "org.openapitools:openapi-java-client:1.0.225"
8181
```
8282

8383
### Others
@@ -90,7 +90,7 @@ mvn clean package
9090

9191
Then manually install the following JARs:
9292

93-
* `target/openapi-java-client-1.0.223.jar`
93+
* `target/openapi-java-client-1.0.225.jar`
9494
* `target/lib/*.jar`
9595

9696
## Getting Started

‎api/openapi.yaml

+35-8
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ info:
2929
* The status of the *report* will also be updated to `COMPLETE`
3030
* Request a URL with parameters to view the Similarity Report
3131
title: Turnitin Core API
32-
version: 1.0.223
32+
version: 1.0.225
3333
externalDocs:
3434
description: Developer Portal Documentation page
3535
url: https://developers.turnitin.com/docs
@@ -46,7 +46,7 @@ tags:
4646
name: Features
4747
- description: Manage acceptence of EULAs
4848
name: EULA
49-
- description: Template exclusion
49+
- description: Used for template exclusion
5050
name: Groups
5151
- description: Upload files and retrieve data
5252
name: Submission
@@ -2902,15 +2902,15 @@ components:
29022902
- INTERNET
29032903
- INTERNET
29042904
submission_auto_excludes:
2905-
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
2906-
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
2905+
- 0dacc0d5-2deb-4564-97f9-726d89b6617f
2906+
- 0dacc0d5-2deb-4564-97f9-726d89b6617f
29072907
auto_exclude_self_matching_scope: ALL
29082908
priority: true
29092909
view_settings:
29102910
exclude_crossref_posted_content: true
29112911
exclude_custom_sections: true
29122912
exclude_abstract: true
2913-
exclude_small_matches: 0
2913+
exclude_small_matches: 4
29142914
exclude_publications: true
29152915
exclude_preprints: true
29162916
exclude_internet: true
@@ -3362,8 +3362,8 @@ components:
33623362
- INTERNET
33633363
- INTERNET
33643364
submission_auto_excludes:
3365-
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
3366-
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
3365+
- 0dacc0d5-2deb-4564-97f9-726d89b6617f
3366+
- 0dacc0d5-2deb-4564-97f9-726d89b6617f
33673367
auto_exclude_self_matching_scope: ALL
33683368
priority: true
33693369
properties:
@@ -3382,6 +3382,7 @@ components:
33823382
submission_auto_excludes:
33833383
description: List of submission IDs to exclude from report
33843384
items:
3385+
example: 0dacc0d5-2deb-4564-97f9-726d89b6617f
33853386
format: uuid
33863387
type: string
33873388
type: array
@@ -3420,62 +3421,75 @@ components:
34203421
exclude_quotes:
34213422
description: |
34223423
If set to true, text in quotes will not count as similar content
3424+
example: true
34233425
type: boolean
34243426
exclude_bibliography:
34253427
description: |
34263428
If set to true, text in a bibliography section will not count as similar content
3429+
example: true
34273430
type: boolean
34283431
exclude_citations:
34293432
description: |
34303433
If set to true, text in citations will not count as similar content
3434+
example: true
34313435
type: boolean
34323436
exclude_abstract:
34333437
description: |
34343438
If set to true, text in the abstract section of the submission will not count as similar content
3439+
example: true
34353440
type: boolean
34363441
exclude_methods:
34373442
description: |
34383443
If set to true, text in the method section of the submission will not count as similar content
3444+
example: true
34393445
type: boolean
34403446
exclude_small_matches:
34413447
description: |
34423448
If set, similarity matches that match less than the specified amount of words will not count as similar content
3449+
example: true
34433450
type: boolean
34443451
exclude_internet:
34453452
description: |
34463453
If set to true, text matched to the internet collection will not count as similar content
3454+
example: true
34473455
type: boolean
34483456
exclude_publications:
34493457
description: |
34503458
If set to true, text matched to the publications collection will not count as similar content
3459+
example: true
34513460
type: boolean
34523461
exclude_crossref:
34533462
description: |
34543463
If set to true, text matched to the Crossref collection will not count as similar content
3464+
example: true
34553465
type: boolean
34563466
exclude_crossref_posted_content:
34573467
description: |
34583468
If set to true, text matched to the Crossref Posted Content collection will not count as similar content
3469+
example: true
34593470
type: boolean
34603471
exclude_submitted_works:
34613472
description: |
34623473
If set to true, text matched to the submitted works collection will not count as similar content calculated as if submitted work was not part of the paper
3474+
example: true
34633475
type: boolean
34643476
exclude_custom_sections:
34653477
description: |
34663478
If set to true, text matched to the custom sections defined in the admin settings will not count as similar content calculated as if section was not part of the paper
3479+
example: true
34673480
type: boolean
34683481
exclude_preprints:
34693482
description: |
34703483
If set to true, it will exclude preprints. A preprint is a version of a scholarly or scientific paper that precedes formal peer review and publication in a peer-reviewed scholarly or scientific journal.
3484+
example: true
34713485
type: boolean
34723486
type: object
34733487
SimilarityViewSettings:
34743488
example:
34753489
exclude_crossref_posted_content: true
34763490
exclude_custom_sections: true
34773491
exclude_abstract: true
3478-
exclude_small_matches: 0
3492+
exclude_small_matches: 4
34793493
exclude_publications: true
34803494
exclude_preprints: true
34813495
exclude_internet: true
@@ -3489,54 +3503,67 @@ components:
34893503
exclude_quotes:
34903504
description: |
34913505
If set to true, text in quotes will not count as similar content
3506+
example: true
34923507
type: boolean
34933508
exclude_bibliography:
34943509
description: |
34953510
If set to true, text in a bibliography section will not count as similar content
3511+
example: true
34963512
type: boolean
34973513
exclude_citations:
34983514
description: |
34993515
If set to true, text in citations will not count as similar content
3516+
example: true
35003517
type: boolean
35013518
exclude_abstract:
35023519
description: |
35033520
If set to true, text in the abstract section of the submission will not count as similar content
3521+
example: true
35043522
type: boolean
35053523
exclude_methods:
35063524
description: |
35073525
If set to true, text in the method section of the submission will not count as similar content
3526+
example: true
35083527
type: boolean
35093528
exclude_small_matches:
35103529
description: |
35113530
If set, similarity matches that match less than the specified amount of words will not count as similar content
3531+
example: 4
35123532
type: integer
35133533
exclude_internet:
35143534
description: |
35153535
If set to true, text matched to the internet collection will not count as similar content
3536+
example: true
35163537
type: boolean
35173538
exclude_publications:
35183539
description: |
35193540
If set to true, text matched to the publications collection will not count as similar content
3541+
example: true
35203542
type: boolean
35213543
exclude_crossref:
35223544
description: |
35233545
If set to true, text matched to the Crossref collection will not count as similar content
3546+
example: true
35243547
type: boolean
35253548
exclude_crossref_posted_content:
35263549
description: |
35273550
If set to true, text matched to the Crossref Posted Content collection will not count as similar content
3551+
example: true
35283552
type: boolean
35293553
exclude_submitted_works:
35303554
description: |
35313555
If set to true, text matched to the submitted works collection will not count as similar content calculated as if submitted work was not part of the paper
3556+
example: true
35323557
type: boolean
35333558
exclude_custom_sections:
35343559
description: |
35353560
If set to true, text matched to the custom sections defined in the admin settings will not count as similar content calculated as if section was not part of the paper
3561+
example: true
35363562
type: boolean
35373563
exclude_preprints:
35383564
description: |
35393565
If set to true, it will exclude preprints. A preprint is a version of a scholarly or scientific paper that precedes formal peer review and publication in a peer-reviewed scholarly or scientific journal.
3566+
example: true
35403567
type: boolean
35413568
type: object
35423569
SimilarityScoreData:

‎build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ apply plugin: 'eclipse'
33
apply plugin: 'java'
44

55
group = 'org.openapitools'
6-
version = '1.0.223'
6+
version = '1.0.225'
77

88
buildscript {
99
repositories {

‎build.sbt

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
22
settings(
33
organization := "org.openapitools",
44
name := "openapi-java-client",
5-
version := "1.0.223",
5+
version := "1.0.225",
66
scalaVersion := "2.11.4",
77
scalacOptions ++= Seq("-feature"),
88
javacOptions in compile ++= Seq("-Xlint:deprecation"),

‎git_push.sh

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/bin/sh
22
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
33
#
4-
# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
4+
# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
55

66
git_user_id=$1
77
git_repo_id=$2
@@ -38,14 +38,14 @@ git add .
3838
git commit -m "$release_note"
3939

4040
# Sets the new remote
41-
git_remote=`git remote`
41+
git_remote=$(git remote)
4242
if [ "$git_remote" = "" ]; then # git remote not defined
4343

4444
if [ "$GIT_TOKEN" = "" ]; then
4545
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
4646
git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
4747
else
48-
git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
48+
git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
4949
fi
5050

5151
fi

‎pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<artifactId>openapi-java-client</artifactId>
66
<packaging>jar</packaging>
77
<name>openapi-java-client</name>
8-
<version>1.0.223</version>
8+
<version>1.0.225</version>
99
<url>https://github.com/openapitools/openapi-generator</url>
1010
<description>OpenAPI Java</description>
1111
<scm>

‎src/main/java/org/openapitools/client/ApiCallback.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Turnitin Core API
33
* 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). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button API Keys * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope --> Enter a name --> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the *submission* will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the *report* will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report
44
*
5-
* The version of the OpenAPI document: 1.0.223
5+
* The version of the OpenAPI document: 1.0.225
66
*
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -52,10 +52,10 @@ public interface ApiCallback<T> {
5252
void onUploadProgress(long bytesWritten, long contentLength, boolean done);
5353

5454
/**
55-
* This is called when the API downlond processing.
55+
* This is called when the API download processing.
5656
*
5757
* @param bytesRead bytes Read
58-
* @param contentLength content lenngth of the response
58+
* @param contentLength content length of the response
5959
* @param done Read end
6060
*/
6161
void onDownloadProgress(long bytesRead, long contentLength, boolean done);

‎src/main/java/org/openapitools/client/ApiClient.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* Turnitin Core API
33
* 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). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button API Keys * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope --> Enter a name --> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the *submission* will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the *report* will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report
44
*
5-
* The version of the OpenAPI document: 1.0.223
5+
* The version of the OpenAPI document: 1.0.225
66
*
77
*
88
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -125,7 +125,7 @@ private void init() {
125125
json = new JSON();
126126

127127
// Set default User-Agent.
128-
setUserAgent("OpenAPI-Generator/1.0.223/java");
128+
setUserAgent("OpenAPI-Generator/1.0.225/java");
129129

130130
authentications = new HashMap<String, Authentication>();
131131
}
@@ -441,7 +441,7 @@ public ApiClient setDebugging(boolean debugging) {
441441
/**
442442
* The path of temporary folder used to store downloaded files from endpoints
443443
* with file response. The default value is <code>null</code>, i.e. using
444-
* the system's default tempopary folder.
444+
* the system's default temporary folder.
445445
*
446446
* @see <a href="https://docs.oracle.com/javase/7/docs/api/java/nio/file/Files.html#createTempFile(java.lang.String,%20java.lang.String,%20java.nio.file.attribute.FileAttribute...)">createTempFile</a>
447447
* @return Temporary folder path

0 commit comments

Comments
 (0)