Mirror okhttp parity in approov-service-httpsurlconn

.gitignore

@@ -42,6 +42,12 @@ captures/
 # OSX filesystem
 .DS_Store
 
+# Generated documentation artifacts
+approov-service/docs/*.jar
+
+# Local tool state
+.wrangler/
+
 # Pods
 Podfile.lock
 Pods/

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this package will be documented in this file.
+
+The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
+
+## [Unreleased]
+
+### Added
+- `ApproovServiceMutator` support to centralize decision points in the `HttpsURLConnection` service flow.
+- `USAGE.md`, `REFERENCE.md`, and `CHANGELOG.md` at the repository root.
+- `setUseApproovStatusIfNoToken` support for propagating fetch status in the Approov token header when no token is available.
+- `Approov-TraceID` configuration helpers.
+- Configurable query parameter substitution APIs.
+- `addApproovToConnection(HttpsURLConnection)` for flows that need to continue with a wrapped connection.
+
+### Changed
+- `ApproovService` now routes request-preparation decisions through the service mutator.
+- `addApproov(HttpsURLConnection)` preserves the original in-place API, while `addApproovToConnection(HttpsURLConnection)` supports mutator-driven signing, optional URL substitution, and deferred body-aware processing.
+- Message signing now supports the `HttpsURLConnection` request path, including optional body digest generation when request buffering is used.
+
+### Deprecated
+- `ApproovInterceptorExtensions` in favor of `ApproovServiceMutator`.
+- `setProceedOnNetworkFail()` and `getProceedOnNetworkFail()` in favor of `ApproovServiceMutator`.
+- `getMessageSignature()` in favor of `getAccountMessageSignature()`.

README.md

@@ -1,5 +1,17 @@
-# Approov Service for HttpsUrlConnection
+# Approov Service for HttpsURLConnection
 
-A wrapper for the [Approov SDK](https://github.com/approov/approov-android-sdk) to enable easy integration when using [`HttpsUrlConnection`](https://developer.android.com/reference/javax/net/ssl/HttpsURLConnection) for making the API calls that you wish to protect with Approov. In order to use this you will need a trial or paid [Approov](https://www.approov.io) account.
+A wrapper for the [Approov SDK](https://github.com/approov/approov-android-sdk) to enable easy integration when using [`HttpsURLConnection`](https://developer.android.com/reference/javax/net/ssl/HttpsURLConnection) for making the API calls that you wish to protect with Approov. In order to use this you will need a trial or paid [Approov](https://www.approov.io) account.
 
-Please follow the [Quickstart](https://github.com/approov/quickstart-android-java-httpsurlconn) for instructions on usage.
+Please see the [Quickstart](https://github.com/approov/quickstart-android-java-httpsurlconn/blob/master/README.md) for example integration.
+
+# Changelog
+
+Please see the [CHANGELOG.md](CHANGELOG.md) for more information on the changes in each version.
+
+# Reference
+
+Please see the [REFERENCE.md](REFERENCE.md) for more information on the Approov Service for HttpsURLConnection.
+
+# Usage
+
+Please see the [USAGE.md](USAGE.md) for more information on how to use this wrapper.