More Documentation on Asset creation

[nilutz]

Feature Request

More Documentation on Asset creation

Description

In a current use case we want to use an Asset and set its dataAddress to allow proxyQueryParams. As an example consider the following, our Asset has a baseUrl of https://example.com and the user can use queryParams to request different underlying data like so: https://example.com?query=hello&id=123. The question now arises how the assets in EDC would support such a behaviour. After some research we found out that one can enable flags to enable certain behaviour on producer side. So in order to create an asset, one would need to enable proxyQueryParams like so:

    "dataAddress": {
        "properties": {
            "type": "HttpData",
            "baseUrl": "https://example.com",
            "method": "GET",
            "proxyQueryParams":True,
        }
    }

But how would the consumer now tell the producer which params to proxy to the dataAdress baseUrl ? I tried with the following request data:

"dataDestination": {
    "properties": {
      "type": "HttpData",
      "baseUrl": https://destination-url.com,
      "assetId": "asset-id-123",
    },
  },
  "properties" : {
    "queryParams":  {
        "query":"hello",
        "id":123
    }
}

But had no luck. In addition the documentation or openapi.yaml has no information on what could go into the "properties" section on how to control the "dataAdress" or "dataDestination" behaviour.

Why Is the Feature Desired?

In order to for developers to use the EDC to hook up any data source this part of the documentation is crucial