docs: add free form properties schema type (#3555)

* docs: add missing additional properties true on free-form properties attributes * docs: add a free form properties schema type
eclipse-edc · Oct 20, 2023 · cba9558 · cba9558
1 parent 2ea0ecc
commit cba9558
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 11 deletions.
diff --git a/...main/java/org/eclipse/edc/connector/api/management/configuration/ManagementApiSchema.java b/...main/java/org/eclipse/edc/connector/api/management/configuration/ManagementApiSchema.java
@@ -96,6 +96,9 @@ record DataAddressSchema(
                 """;
     }
 
+    @Schema(name = "Properties", additionalProperties = Schema.AdditionalPropertiesValue.TRUE)
+    record FreeFormPropertiesSchema() {}
+
     @Schema(name = "Policy", description = "ODRL policy", example = PolicySchema.POLICY_EXAMPLE)
     record PolicySchema() {
         public static final String POLICY_EXAMPLE = """

diff --git a/...i/asset-api/src/main/java/org/eclipse/edc/connector/api/management/asset/v3/AssetApi.java b/...i/asset-api/src/main/java/org/eclipse/edc/connector/api/management/asset/v3/AssetApi.java
@@ -28,8 +28,6 @@
 import org.eclipse.edc.api.model.ApiCoreSchema;
 import org.eclipse.edc.connector.api.management.configuration.ManagementApiSchema;
 
-import java.util.Map;
-
 import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.REQUIRED;
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.CONTEXT;
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.ID;
@@ -112,8 +110,8 @@ record AssetInputSchema(
             @Schema(name = TYPE, example = EDC_ASSET_TYPE)
             String type,
             @Schema(requiredMode = REQUIRED)
-            Map<String, Object> properties,
-            Map<String, Object> privateProperties,
+            ManagementApiSchema.FreeFormPropertiesSchema properties,
+            ManagementApiSchema.FreeFormPropertiesSchema privateProperties,
             @Schema(requiredMode = REQUIRED)
             ManagementApiSchema.DataAddressSchema dataAddress
     ) {
@@ -142,8 +140,8 @@ record AssetOutputSchema(
             String id,
             @Schema(name = TYPE, example = EDC_ASSET_TYPE)
             String type,
-            Map<String, Object> properties,
-            Map<String, Object> privateProperties,
+            ManagementApiSchema.FreeFormPropertiesSchema properties,
+            ManagementApiSchema.FreeFormPropertiesSchema privateProperties,
             ManagementApiSchema.DataAddressSchema dataAddress,
             long createdAt
     ) {

diff --git a/...ain/java/org/eclipse/edc/connector/api/management/transferprocess/TransferProcessApi.java b/...ain/java/org/eclipse/edc/connector/api/management/transferprocess/TransferProcessApi.java
@@ -32,7 +32,6 @@
 import org.eclipse.edc.connector.transfer.spi.types.TransferProcess;
 
 import java.util.List;
-import java.util.Map;
 
 import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.REQUIRED;
 import static org.eclipse.edc.connector.transfer.spi.types.TransferProcess.TRANSFER_PROCESS_TYPE;
@@ -140,8 +139,9 @@ record TransferRequestSchema(
             @Schema(requiredMode = REQUIRED)
             ManagementApiSchema.DataAddressSchema dataDestination,
             @Schema(deprecated = true, description = "Deprecated as this field is not used anymore, please use privateProperties instead")
-            Map<String, String> properties,
-            Map<String, String> privateProperties,
+            ManagementApiSchema.FreeFormPropertiesSchema properties,
+            @Schema(additionalProperties = Schema.AdditionalPropertiesValue.TRUE)
+            ManagementApiSchema.FreeFormPropertiesSchema privateProperties,
             List<ManagementApiSchema.CallbackAddressSchema> callbackAddresses) {
 
         public static final String TRANSFER_REQUEST_EXAMPLE = """
@@ -185,8 +185,9 @@ record TransferProcessSchema(
             String errorDetail,
             @Deprecated(since = "0.2.0")
             @Schema(deprecated = true)
-            Map<String, String> properties,
-            Map<String, Object> privateProperties,
+            ManagementApiSchema.FreeFormPropertiesSchema properties,
+            ManagementApiSchema.DataAddressSchema dataDestination,
+            ManagementApiSchema.FreeFormPropertiesSchema privateProperties,
             List<ManagementApiSchema.CallbackAddressSchema> callbackAddresses
     ) {
         public static final String TRANSFER_PROCESS_EXAMPLE = """