feat!: Add apiKey support to API requests

- Introduced `apiKey` field for secure authentication in configuration and API requests.
- Updated clear and task APIs to accept enhanced request objects.
- Added required tests and assertions for `apiKey` handling across all request types.
- Refactored HTTP operations to include `apiKey` in request headers.
- Introduced new classes for managing authentication details.

Fixes #187

Signed-off-by: Eric Deandrea <[email protected]>

Author: edeandrea

docling-testcontainers/src/main/java/ai/docling/testcontainers/serve/config/DoclingServeContainerConfig.java

@@ -3,6 +3,8 @@
 import java.time.Duration;
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * A configuration interface for defining properties and settings related
  * to the Docling container. This interface provides methods for retrieving
@@ -73,6 +75,7 @@ public interface DoclingServeContainerConfig {
    *
    * @return a {@code String} representing the API key.
    */
+  @Nullable
   String apiKey();
 
   /**
@@ -146,6 +149,7 @@ class Builder {
      *
      * This field is protected and may be configured through the {@link Builder} class.
      */
+    @Nullable
     protected String apiKey;
 
     /**

docs/src/doc/docs/testcontainers.md

@@ -143,6 +143,8 @@ DoclingServeContainerConfig config = DoclingServeContainerConfig.builder()
     ))
     // Increase startup timeout if your CI is slow to pull images
     .startupTimeout(Duration.ofMinutes(2))
+    // Set an optional api key for that consumers must specify
+    .apiKey("my-secret-api-key")
     .build();
 
 DoclingServeContainer container = new DoclingServeContainer(config);