docs: APPS-882 Clarify providing GeoJSON bin types

Makefile

@@ -16,6 +16,12 @@ package: clean validatedocs build
 build:
 	./gradlew build -x test
 
+.PHONY: run
+run:
+	./gradlew bootRun
+
+
+
 .PHONY: clean
 clean:
 	echo $(VERSION)

README.md

@@ -20,7 +20,7 @@ here [Aerospike REST Gateway API Documentation](https://docs.aerospike.com/apido
 
 ## Prerequisites
 
-* Java 17 or later for REST Gateway 2.0 and newer.  Java 8 or later for REST Gateway 1.11 and earlier.
+* Java 17 or later for REST Gateway 2.0 and newer. Java 8 or later for REST Gateway 1.11 and earlier.
 * Aerospike Server version 4.9+
 
 ## Installation
@@ -85,7 +85,7 @@ languages.
 
 1. Go to [Swagger Editor](https://editor.swagger.io/).
 2. Import the Aerospike REST
-   Client [openapi.json](https://github.com/aerospike/aerospike-rest-gateway/blob/master/docs/openapi.json) file.
+   Client [openapi.json](https://aerospike.github.io/aerospike-rest-gateway/openapi.json) file.
 3. Click on Generate Server/Generate Client and choose the desired language/framework.
 4. A .zip file that contains all the necessary files for a server/client will be downloaded.
 

docs/data-formats.md

@@ -1,4 +1,4 @@
-# Rest Gateway Data Formats
+# REST Gateway Data Formats
 
 API Requests which involve sending data can use the `JSON`, or `MessagePack` formats. By default JSON will be assumed.
 To use `MessagePack`, set the `Content-Type` header to ``"application/msgpack"``. Similarly
@@ -11,13 +11,9 @@ For many uses `JSON` is a simpler and completely valid option. It provides simpl
 Key Value operations are being used, and neither Maps with non string keys, Bytes nor GeoJSON are required, then `JSON`
 will work completely with the Aerospike data model.
 
-**Note**: In version 1.0 GeoJSON and ByteArray bin values are supported. A GeoJSON map with the keys "type" and "
-coordinates" will automatically be understood as a GeoJSON type. Similarly, a ByteArray can be provided using a map with
-the keys "type"
-and "value" where the type is "byteArray" and the value is a base64 encoded string. One caveat is GeoJSON and ByteArrays
-can not be nested in CDTs.
+**Note**: GeoJSON and ByteArrays can not be nested in CDTs.
 
-Ex. GeoJSON
+In 2.0.1, a GeoJSON map with the keys "type" and "coordinates" will automatically be understood as a GeoJSON type.
 
 ```javascript
 {
@@ -26,7 +22,21 @@ Ex. GeoJSON
 }
 ```
 
-Ex. ByteArray
+In version prior to 2.0.1, a GeoJSON object can be provided by sending a base64 encoded GeoJSON string.
+Base64 encoding the following string `{"type": "Point", "coordinates": [1.123, 4.156]}` results
+in `eyJ0eXBlIjogIlBvaW50IiwgImNvb3JkaW5hdGVzIjogWzEuMTIzLCA0LjE1Nl19Cg==`.
+To write the GeoJSON object use
+
+```javascript
+{
+    "type": "GEO_JSON",
+    "value": "eyJ0eXBlIjogIlBvaW50IiwgImNvb3JkaW5hdGVzIjogWzEuMTIzLCA0LjE1Nl19Cg=="
+  }
+```
+
+Similarly, starting in 1.0.0 a ByteArray can be provided using a map with
+the keys "type"
+and "value" where the type is "byteArray" and the value is a base64 encoded string.
 
 ```javascript
 {

docs/installation-and-config.md

@@ -19,7 +19,7 @@ make build
 * Run Locally during development:
 
 ```sh
-./gradlew bootRun
+make run
 ```
 
 ### Run using a Jar file

docs/operate.md

@@ -2,7 +2,7 @@
 
 # DEPRECATED
 
-    Operatation documentation is now imbedded in the swagger documentation.
+# Operation documentation is now embedded in the swagger documentation as of 2.0.1
 
 # Rest Gateway Operations
 

src/main/java/com/aerospike/restclient/util/APIParamDescriptors.java

@@ -20,7 +20,7 @@ public class APIParamDescriptors {
     public static final String NAMESPACE_NOTES = "Namespace for the record; equivalent to database name.";
     public static final String SET_NOTES = "Set for the record; equivalent to database table.";
     public static final String USERKEY_NOTES = "Userkey for the record.";
-    public static final String STORE_BINS_NOTES = "Bins to be stored in the record. This is a mapping from a string bin name to a value. " + "Value can be a String, integer, floating point number, list, map, bytearray, or GeoJSON value. Bytearrays and GeoJSON can " + "only be sent using MessagePack\n " + "example: {\"bin1\":5, \"bin2\":\"hello\", \"bin3\": [1,2,3], \"bin4\": {\"one\": 1}}";
+    public static final String STORE_BINS_NOTES = "Bins to be stored in the record. This is a mapping from a string bin name to a value. " + "Value can be a String, integer, floating point number, list, map, bytearray, or GeoJSON value.";
 
     public static final String QUERY_PARTITION_BEGIN_NOTES = "Start partition id (0 - 4095)";
     public static final String QUERY_PARTITION_COUNT_NOTES = "Number of partitions";

src/main/java/com/aerospike/restclient/util/RequestBodyExamples.java

@@ -32,5 +32,5 @@ public class RequestBodyExamples {
 
     // key value
     public static final String BINS_NAME = "Bins request body example";
-    public static final String BINS_VALUE = "{\"bin1\":5, \"bin2\":\"hello\", \"bin3\": [1,2,3], \"bin4\": {\"one\": 1}}";
+    public static final String BINS_VALUE = "{\"intBin\":5, \"strBin\":\"hello\", \"listBin\": [1,2,3], \"dictBin\": {\"one\": 1}, \"geoJsonBin\": {\"type\": \"Point\", \"coordinates\": [1.123, 4.156]}, \"byteArrayBin\": {\"type\": \"BYTE_ARRAY\", \"value\": \"YWVyb3NwaWtlCg==\"}}";
 }