eclipse-tractusx / sldt-digital-twin-registry

Apache License 2.0
13 stars 26 forks source link

Documentation deprecated: #264

Open marcoGrebe opened 11 months ago

marcoGrebe commented 11 months ago

https://github.com/eclipse-tractusx/sldt-digital-twin-registry/tree/main/docs -> 4 -runtime view -> 1 (asset creation) has a deprecated example.

  1. It should use the v3 api of edc for the asset creation <PROVIDER_DATAMGMT_URL>/management/v3/assets instead of <PROVIDER_DATAMGMT_URL>/management/v3/assets
  2. The key "oauth2:clientSecret" is deprecated and should be replaced by "oauth2:clientSecretKey" which does not contain the secret itself but a reference to vault, where the key should be stored.
  3. The example working for us is
    
    {
    "@context": {
    "@vocab": "https://w3id.org/edc/v0.0.1/ns/"
    },
    "@type": "Asset",
    "@id": "{{ASSET_ID}}",
    "properties": {
       "description": "ddtr",
       "name": "ddtr",
       "contenttype": "data.core.digitalTwinRegistry"
    },
    "dataAddress": {
        "@type": "DataAddress",
        "type": "HttpData",
        "baseUrl": "{{BACKEND_SERVICE}}",
        "proxyPath": "true",
        "proxyBody": "true",
        "proxyMethod": "true",
        "proxyQueryParams": "true",
        "oauth2:clientId": "{{REGISTRY_CLIENT_ID}}",
        "oauth2:clientSecretKey": "{{REGISTRY_CLIENT_SECRET_KEY}}", 
        "oauth2:tokenUrl": "{{REGISTRY_TOKEN_ENDPOINT}}",
        "oauth2:scope": "{{REGISTRY_TOKEN_SCOPE}}"
    }
    }
tunacicek commented 10 months ago

Hi @marcoGrebe , thats right. Thank you for the hint. We will adjust the documentation.