docs: annotate properly settings and refer to autodoc from the README…

… files (eclipse-edc#3986) * avoid outdatedness of the documentation of config params in README files
segoranov · Apr 4, 2024 · feccf4e · feccf4e
1 parent 0b83737
commit feccf4e
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 16 deletions.
diff --git a/extensions/control-plane/transfer/transfer-data-plane/README.md b/extensions/control-plane/transfer/transfer-data-plane/README.md
@@ -44,9 +44,4 @@ of its public API. OpenApi documentation can be found [here](../../../../resourc
 
 ### Configurations
 
-| Parameter name                                      | Description                                                                                    | Mandatory | Default value         |
-|:----------------------------------------------------|:-----------------------------------------------------------------------------------------------|:----------|:----------------------|
-| `edc.transfer.proxy.token.validity.seconds`         | Validity (in seconds) of tokens generated by the extension for accessing Data Plane public API | false     | 600                   | 
-| `edc.transfer.client.selector.strategy`             | Strategy for Data Plane instance selection                                                     | false     | random                |
-| `edc.transfer.proxy.token.signer.privatekey.alias`  | Alias of private key used for signing tokens                                                   | false     | Random EC public key  |
-| `edc.transfer.proxy.token.verifier.publickey.alias` | Alias of public key used for verifying the tokens                                              | false     | Random EC private key |
+See [here](https://eclipse-edc.github.io/Connector/autodoc/#transfer-data-plane) the latest documentation for the available configuration parameters.
diff --git a/extensions/data-plane/data-plane-control-api/README.md b/extensions/data-plane/data-plane-control-api/README.md
@@ -50,9 +50,7 @@ _Provide some information about dependencies, e.g., used extensions._
 
 ### Configurations
 
-| Parameter name                                      | Description                                                                                       | Mandatory | Default value                          |
-|:----------------------------------------------------|:--------------------------------------------------------------------------------------------------|:----------|:---------------------------------------|
-| `edc.dataplane.token.validation.endpoint`  | Endpoint of the token validation server that will be hit when targeting the Data Plane public API | true      |                                        |
+See [here](https://eclipse-edc.github.io/Connector/autodoc/#data-plane-http) the latest documentation for the available configuration parameters.
 
 ## Design Principles
 

diff --git a/extensions/data-plane/data-plane-http/README.md b/extensions/data-plane/data-plane-http/README.md
@@ -23,11 +23,7 @@ Typically, this extension is used to fetch or post data from/to a REST endpoint.
 
 ### Configurations
 
-The setting parameters of this extension are listed below:
-
-| Parameter name                           | Description                                                          | Mandatory | Default value |
-|:-----------------------------------------|:---------------------------------------------------------------------|:----------|:--------------|
-| `edc.dataplane.http.sink.partition.size` | Number of partitions for parallel message push in the `HttpDataSink` | false     | 5             |
+See [here](https://eclipse-edc.github.io/Connector/autodoc/#data-plane-http) the latest documentation for the available configuration parameters.
 
 ### Provided Services
 

diff --git a/...e-http/src/main/java/org/eclipse/edc/connector/dataplane/http/DataPlaneHttpExtension.java b/...e-http/src/main/java/org/eclipse/edc/connector/dataplane/http/DataPlaneHttpExtension.java
@@ -41,7 +41,7 @@ public class DataPlaneHttpExtension implements ServiceExtension {
     public static final String NAME = "Data Plane HTTP";
     private static final int DEFAULT_PART_SIZE = 5;
 
-    @Setting
+    @Setting(value = "Number of partitions for parallel message push in the HttpDataSink", defaultValue = "5")
     private static final String EDC_DATAPLANE_HTTP_SINK_PARTITION_SIZE = "edc.dataplane.http.sink.partition.size";
 
     @Inject

diff --git a/...pi/src/main/java/org/eclipse/edc/connector/dataplane/api/DataPlanePublicApiExtension.java b/...pi/src/main/java/org/eclipse/edc/connector/dataplane/api/DataPlanePublicApiExtension.java
@@ -45,7 +45,7 @@ public class DataPlanePublicApiExtension implements ServiceExtension {
     private static final String PUBLIC_CONTEXT_ALIAS = "public";
     private static final String PUBLIC_CONTEXT_PATH = "/api/v1/public";
 
-    @Setting
+    @Setting(value = "Endpoint of the token validation server that will be hit when targeting the Data Plane public API", required = true)
     private static final String CONTROL_PLANE_VALIDATION_ENDPOINT = "edc.dataplane.token.validation.endpoint";
 
     private static final int DEFAULT_THREAD_POOL = 10;