Rename ClientApi to DocApi.

jqr · jqr · commit 2d591524ddc4 · 2016-01-29T18:09:52.000-05:00
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@ import com.docraptor.*;
 
 public class Sync {
   public static void main(String[] args) throws Exception {
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
     ApiClientclient = docraptor.getApiClient();
    client.setUsername("YOUR_API_KEY_HERE"); // this key works for test documents
     //client.setDebugging(true);
diff --git a/docraptor.yaml b/docraptor.yaml
@@ -10,7 +10,7 @@ schemes: [https]
 securityDefinitions:
   basicAuth:
     type: basic
-    description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`
+    description: Use your API key as the username. Password does not need to be set.
 produces:
   - application/json
   - application/xml
@@ -22,11 +22,10 @@ paths:
   /docs:
     post:
       operationId: createDoc
-      tags: [Client]
+      tags: [Doc]
       description: >
         Creates a document synchronously.
       security:
-
         - basicAuth: []
       parameters:
         - name: doc
@@ -54,7 +53,7 @@ paths:
   /async_docs:
     post:
       operationId: createAsyncDoc
-      tags: [Client]
+      tags: [Doc]
       description: >
         Creates a document asynchronously.
         You must use a callback url or the the returned status id and the status api to find out when it completes.
@@ -87,11 +86,10 @@ paths:
   /status/{id}:
     get:
       operationId: getAsyncDocStatus
-      tags: [Client]
+      tags: [Doc]
       description: >
         Check on the status of an asynchronously created document.
       security:
-
         - basicAuth: []
       parameters:
         - name: id
@@ -112,15 +110,13 @@ paths:
         500:
           description: Server Error
 
-
   /download/{id}:
     get:
       operationId: getAsyncDoc
-      tags: [Client]
-      description:
+      tags: [Doc]
+      description: >
         Downloads a document.
       security:
-
         - basicAuth: []
       parameters:
         - name: id
diff --git a/examples/Async.java b/examples/Async.java
@@ -17,7 +17,7 @@
 public class Async {
   public static void main(String[] args) throws Exception {
     try {
-      ClientApi docraptor = new ClientApi();
+      DocApi docraptor = new DocApi();
       ApiClient client = docraptor.getApiClient();
       client.setUsername("YOUR_API_KEY_HERE"); // this key works for test documents
       // client.setDebugging(true);
diff --git a/examples/Sync.java b/examples/Sync.java
@@ -17,7 +17,7 @@
 
 public class Sync {
   public static void main(String[] args) throws Exception {
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
     ApiClient client = docraptor.getApiClient();
     client.setUsername("YOUR_API_KEY_HERE"); // this key works for test documents
     // client.setDebugging(true);
diff --git a/src/main/java/com/docraptor/DocApi.java b/src/main/java/com/docraptor/DocApi.java
@@ -14,14 +14,14 @@
 import java.util.*;
 
 
-public class ClientApi {
+public class DocApi {
   private ApiClient apiClient;
 
-  public ClientApi() {
+  public DocApi() {
     this(Configuration.getDefaultApiClient());
   }
 
-  public ClientApi(ApiClient apiClient) {
+  public DocApi(ApiClient apiClient) {
     this.apiClient = apiClient;
   }
 
diff --git a/test/Async.java b/test/Async.java
@@ -4,7 +4,7 @@
 
 public class Async {
   public static void main(String[] args) throws Exception {
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
     ApiClient client = docraptor.getApiClient();
     client.setUsername("YOUR_API_KEY_HERE");
     // client.setDebugging(true);
diff --git a/test/InvalidAsync.java b/test/InvalidAsync.java
@@ -4,7 +4,7 @@
 
 public class InvalidAsync {
   public static void main(String[] args) throws Exception {
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
     ApiClient client = docraptor.getApiClient();
     client.setUsername("YOUR_API_KEY_HERE");
     // client.setDebugging(true);
diff --git a/test/InvalidSync.java b/test/InvalidSync.java
@@ -4,7 +4,7 @@
 
 public class InvalidSync {
   public static void main(String[] args) throws Exception {
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
     ApiClient client = docraptor.getApiClient();
     client.setUsername("YOUR_API_KEY_HERE");
     // client.setDebugging(true);
diff --git a/test/Sync.java b/test/Sync.java
@@ -4,7 +4,7 @@
 
 public class Sync {
   public static void main(String[] args) throws Exception {
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
     ApiClient client = docraptor.getApiClient();
     client.setUsername("YOUR_API_KEY_HERE");
     // client.setDebugging(true);
diff --git a/test/Xlsx.java b/test/Xlsx.java
@@ -4,7 +4,7 @@
 
 public class Xlsx {
   public static void main(String[] args) throws Exception {
-    ClientApi docraptor = new ClientApi();
+    DocApi docraptor = new DocApi();
     ApiClient client = docraptor.getApiClient();
     client.setUsername("YOUR_API_KEY_HERE");
     // client.setDebugging(true);

Original file line number	Diff line number	Diff line change
`@@ -14,14 +14,14 @@`
`14`	`14`	`import java.util.*;`
`15`	`15`
`16`	`16`
`17`		`-public class ClientApi {`
	`17`	`+public class DocApi {`
`18`	`18`	`private ApiClient apiClient;`
`19`	`19`
`20`		`- public ClientApi() {`
	`20`	`+ public DocApi() {`
`21`	`21`	`this(Configuration.getDefaultApiClient());`
`22`	`22`	`}`
`23`	`23`
`24`		`- public ClientApi(ApiClient apiClient) {`
	`24`	`+ public DocApi(ApiClient apiClient) {`
`25`	`25`	`this.apiClient = apiClient;`
`26`	`26`	`}`
`27`	`27`