Minor API Refactor to comply with REST conventions

Author: maxyu1115

README.md

@@ -1,8 +1,8 @@
 # memas-client
 
 MeMaS DP APIs
-- API version: 0.1.0
-  - Build date: 2023-09-14T00:12:57.878084868-07:00[America/Los_Angeles]
+- API version: 0.1.1
+  - Build date: 2023-12-17T16:04:35.398509042-08:00[America/Los_Angeles]
 
 This is the Data Plane client for MeMaS (Memory Management Service). 
 See https://github.com/memas-ai/MeMaS for more details.
@@ -41,7 +41,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>ai.memas</groupId>
   <artifactId>memas-client</artifactId>
-  <version>0.1.4</version>
+  <version>0.1.5</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -57,7 +57,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-     implementation "ai.memas:memas-client:0.1.4"
+     implementation "ai.memas:memas-client:0.1.5"
   }
 ```
 
@@ -71,7 +71,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/memas-client-0.1.4.jar`
+* `target/memas-client-0.1.5.jar`
 * `target/lib/*.jar`
 
 ## Getting Started
@@ -93,7 +93,7 @@ public class Example {
     defaultClient.setBasePath("http://localhost");
 
     DpApi apiInstance = new DpApi(defaultClient);
-    MemorizeRequest memorizeRequest = new MemorizeRequest(); // MemorizeRequest | Request object for memorizing a document
+    MemorizeRequest memorizeRequest = new MemorizeRequest(); // MemorizeRequest | 
     try {
       Memorize200Response result = apiInstance.memorize(memorizeRequest);
       System.out.println(result);
@@ -116,7 +116,7 @@ All URIs are relative to *http://localhost*
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *DpApi* | [**memorize**](docs/DpApi.md#memorize) | **POST** /dp/memorize | Memorize information
-*DpApi* | [**recall**](docs/DpApi.md#recall) | **POST** /dp/recall | Recalls information
+*DpApi* | [**recall**](docs/DpApi.md#recall) | **GET** /dp/recall | Recalls information
 
 
 ## Documentation for Models

api/openapi.yaml

@@ -8,7 +8,7 @@ info:
     name: Apache 2.0
     url: http://www.apache.org/licenses/LICENSE-2.0.html
   title: MeMaS DP APIs
-  version: 0.1.0
+  version: 0.1.1
 externalDocs:
   description: Find out more about MeMaS
   url: http://memas.ai
@@ -23,7 +23,11 @@ paths:
       description: Memorize information
       operationId: memorize
       requestBody:
-        $ref: '#/components/requestBodies/MemorizeRequest'
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/memorize_request'
+        required: true
       responses:
         "200":
           content:
@@ -43,7 +47,7 @@ paths:
       x-content-type: application/json
       x-accepts: application/json
   /dp/recall:
-    post:
+    get:
       description: Recalls relevant information related to the given clue
       operationId: recall
       requestBody:
@@ -73,14 +77,6 @@ paths:
       x-content-type: application/json
       x-accepts: application/json
 components:
-  requestBodies:
-    MemorizeRequest:
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/memorize_request'
-      description: Request object for memorizing a document
-      required: true
   responses:
     OperationSuccess:
       content:

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'ai.memas'
-version = '0.1.4'
+version = '0.1.5'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "ai.memas",
     name := "memas-client",
-    version := "0.1.4",
+    version := "0.1.5",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/DpApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *http://localhost*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**memorize**](DpApi.md#memorize) | **POST** /dp/memorize | Memorize information |
-| [**recall**](DpApi.md#recall) | **POST** /dp/recall | Recalls information |
+| [**recall**](DpApi.md#recall) | **GET** /dp/recall | Recalls information |
 
 
 <a id="memorize"></a>
@@ -31,7 +31,7 @@ public class Example {
     defaultClient.setBasePath("http://localhost");
 
     DpApi apiInstance = new DpApi(defaultClient);
-    MemorizeRequest memorizeRequest = new MemorizeRequest(); // MemorizeRequest | Request object for memorizing a document
+    MemorizeRequest memorizeRequest = new MemorizeRequest(); // MemorizeRequest | 
     try {
       Memorize200Response result = apiInstance.memorize(memorizeRequest);
       System.out.println(result);
@@ -50,7 +50,7 @@ public class Example {
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **memorizeRequest** | [**MemorizeRequest**](MemorizeRequest.md)| Request object for memorizing a document | |
+| **memorizeRequest** | [**MemorizeRequest**](MemorizeRequest.md)|  | |
 
 ### Return type
 

pom.xml

@@ -5,7 +5,7 @@
     <artifactId>memas-client</artifactId>
     <packaging>jar</packaging>
     <name>memas-client</name>
-    <version>0.1.4</version>
+    <version>0.1.5</version>
     <url>https://github.com/memas-ai/MeMaS-java-client</url>
     <description>OpenAPI Java</description>
     <scm>

src/main/java/ai/memas/memasclient/api/DpApi.java

@@ -2,7 +2,7 @@
  * MeMaS DP APIs
  * This is the Data Plane client for MeMaS (Memory Management Service).  See https://github.com/memas-ai/MeMaS for more details.
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 0.1.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -79,7 +79,7 @@ public void setCustomBaseUrl(String customBaseUrl) {
 
     /**
      * Build call for memorize
-     * @param memorizeRequest Request object for memorizing a document (required)
+     * @param memorizeRequest  (required)
      * @param _callback Callback for upload/download progress
      * @return Call to execute
      * @throws ApiException If fail to serialize the request body object
@@ -149,7 +149,7 @@ private okhttp3.Call memorizeValidateBeforeCall(MemorizeRequest memorizeRequest,
     /**
      * Memorize information
      * Memorize information
-     * @param memorizeRequest Request object for memorizing a document (required)
+     * @param memorizeRequest  (required)
      * @return Memorize200Response
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
      * @http.response.details
@@ -167,7 +167,7 @@ public Memorize200Response memorize(MemorizeRequest memorizeRequest) throws ApiE
     /**
      * Memorize information
      * Memorize information
-     * @param memorizeRequest Request object for memorizing a document (required)
+     * @param memorizeRequest  (required)
      * @return ApiResponse<Memorize200Response>
      * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
      * @http.response.details
@@ -186,7 +186,7 @@ public ApiResponse<Memorize200Response> memorizeWithHttpInfo(MemorizeRequest mem
     /**
      * Memorize information (asynchronously)
      * Memorize information
-     * @param memorizeRequest Request object for memorizing a document (required)
+     * @param memorizeRequest  (required)
      * @param _callback The callback to be executed when the API call finishes
      * @return The request call
      * @throws ApiException If fail to process the API call, e.g. serializing the request body object
@@ -259,7 +259,7 @@ public okhttp3.Call recallCall(RecallRequest recallRequest, final ApiCallback _c
         }
 
         String[] localVarAuthNames = new String[] {  };
-        return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
+        return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
     }
 
     @SuppressWarnings("rawtypes")

src/main/java/ai/memas/memasclient/invoker/ApiCallback.java

@@ -2,7 +2,7 @@
  * MeMaS DP APIs
  * This is the Data Plane client for MeMaS (Memory Management Service).  See https://github.com/memas-ai/MeMaS for more details.
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 0.1.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/main/java/ai/memas/memasclient/invoker/ApiClient.java

@@ -2,7 +2,7 @@
  * MeMaS DP APIs
  * This is the Data Plane client for MeMaS (Memory Management Service).  See https://github.com/memas-ai/MeMaS for more details.
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 0.1.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -138,7 +138,7 @@ private void init() {
         json = new JSON();
 
         // Set default User-Agent.
-        setUserAgent("OpenAPI-Generator/0.1.4/java");
+        setUserAgent("OpenAPI-Generator/0.1.5/java");
 
         authentications = new HashMap<String, Authentication>();
     }

src/main/java/ai/memas/memasclient/invoker/ApiException.java

@@ -2,7 +2,7 @@
  * MeMaS DP APIs
  * This is the Data Plane client for MeMaS (Memory Management Service).  See https://github.com/memas-ai/MeMaS for more details.
  *
- * The version of the OpenAPI document: 0.1.0
+ * The version of the OpenAPI document: 0.1.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,7 +22,7 @@
  * <p>ApiException class.</p>
  */
 @SuppressWarnings("serial")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-09-14T00:12:57.878084868-07:00[America/Los_Angeles]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-12-17T16:04:35.398509042-08:00[America/Los_Angeles]")
 public class ApiException extends Exception {
     private int code = 0;
     private Map<String, List<String>> responseHeaders = null;