SK-2814: Java SDK v2.1 — Public interface nomenclature cleanup, backward compat deprecations, and docs

.cspell.json

@@ -73,9 +73,26 @@
     "pkcs",
     "prioritise",
     "Prioritise",
+    "prioritised",
     "Timeto",
     "Wdex",
-    "jacoco"
+    "jacoco",
+    "serialise",
+    "serialised",
+    "serialises",
+    "serialising",
+    "normalise",
+    "Normalise",
+    "normalised",
+    "normalises",
+    "Normalises",
+    "normalising",
+    "behaviour",
+    "Behaviour",
+    "behaviours",
+    "sanitisation",
+    "recognised",
+    "unrecognised"
   ],
   "languageSettings": [
     {
@@ -98,14 +115,17 @@
     "src/main/java/com/skyflow/generated/**",
     "**/*.ts",
     "**/processed-*",
-    "samples/src/main/java/com/example/credentials.json"
+    "samples/src/main/java/com/example/credentials.json",
+    "RUNNING_SAMPLES.md",
+    "docs/superpowers/**"
   ],
   "ignoreRegExpList": [
     "/\\b[A-Z][A-Z0-9_]{2,}\\b/g",
     "/https?:\\/\\/[^\\s]*/g",
     "/(eyJ[A-Za-z0-9+/=_-]+\\.)+[A-Za-z0-9+/=_-]+/g",
     "/[A-Za-z0-9_.~-]*%[0-9A-Fa-f]{2}[A-Za-z0-9_.~%-]*/g",
     "/\\b[A-Za-z0-9_]{7,}\\b(?=])/g",
-    "/\"[A-Za-z0-9+/=]{15,}\"/g"
+    "/\"[A-Za-z0-9+/=]{15,}\"/g",
+    "/-D[A-Za-z][A-Za-z0-9.]*/g"
   ]
 }

.gitignore

@@ -1,3 +1,7 @@
 .idea
 
-target
+target
+
+RUNNING_SAMPLES.md
+
+docs/superpowers/

CHANGELOG.md

@@ -1,103 +1,5 @@
 # Changelog
-All notable changes to this project will be documented in this file.
 
-## [1.15.0] - 2024-08-01
-### Added
-- insert data using bulk operation `insertBulk`
+All notable changes to this project will be documented as part of the release notes.
 
-## [1.14.0] - 2024-02-01
-### Fixed
-- handling of detokenize response to avoid breaking changes.
-
-## [1.13.0] - 2024-01-10
-### Added
-- Continue on error support for batch Insert.
-
-## [1.12.1] - 2023-11-09
-### Fixed
-- Static Bearer token being used for multiple Skyflow Client instances.
-
-## [1.12.0] - 2023-10-25
-### Added
-- `tokens` support in Get Method
-
-## [1.11.0] - 2023-09-01
-### Added
-- `query` vault API
-
-## [1.10.0] - 2023-08-09
-- Added `delete` vault API support. 
-## [1.9.0] - 2023-06-08
-### Added
-- `redaction` key for detokenize method for column group support.
-
-## [1.8.2] - 2023-03-20
-### Fixed
-- removed grace period logic for bearer token generation.
-
-## [1.8.1] - 2023-03-01
-### Fixed
-- java cached token bug
-
-## [1.8.0] - 2023-01-10
-### Added
-- `update` vault API
-- `get` vault API
-
-## [1.7.1] - 2022-11-29
-### Changed
-- `setContext` to `setCtx` method.
-- `setTimetoLive` accepts seconds in `Integer` instead of `Double`.
-
-## [1.7.0] - 2022-11-22
-### Added
-- `upsert` support for insert method.
-
-## [1.6.0] - 2022-10-11
-
-### Added
-- Added Support for Context Aware Authorization.
-- Added Support to generate scoped skyflow bearer tokens.
-## [1.5.0] - 2022-04-12
-
-### Added
-- support for application/x-www-form-urlencoded and multipart/form-data content-type's in connections.
-
-## [1.4.1] - 2022-03-29
-
-### Fixed 
-- Request headers not getting overridden due to case sensitivity
-
-## [1.4.0] - 2022-03-15
-
-### Changed
-
-- deprecated `isValid` in favour of `isExpired`
-
-## [1.3.0] - 2022-02-24
-
-### Added
-
-- `requestId` in error logs and error responses for API Errors
-- `isValid` method for validating Service Account bearer token
-
-## [1.2.0] - 2022-01-11
-
-### Added
-- Logging functionality
-- `Configuration.setLogLevel` function for setting the package-level LogLevel
-- `generateBearerTokenFromCreds` function which takes credentials as string
-
-### Changed
-- Renamed and deprecated `GenerateToken` in favor of `generateBearerToken`
-- `vaultID` and `vaultURL` are optional in `SkyflowConfiguration` constructor
-
-## [1.1.0] - 2021-11-10
-### Added
-- `insert` vault API
-- `detokenize` vault API
-- `getById` vault API
-- `invokeConnection` 
-## [1.0.1] - 2021-10-20
-### Added 
--  Service Account Token generation
+See [GitHub](https://github.com/skyflowapi/skyflow-java/releases) or [Maven](https://mvnrepository.com/artifact/com.skyflow/skyflow-java) for more details on each released version.