Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Shell Descriptor - DisplayName and endpoint Information are not persisted/returned by DTR GET Endpoints #451

Open
ipa-big opened this issue Jul 26, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@ipa-big
Copy link

ipa-big commented Jul 26, 2024

Description

As a user of the digital twin registry I want to create Shell Descriptors via the API of the DTR including "DisplayName" and "endpoint" information so that those information can be consumed/used by other tools e.g. basyx aas gui ( https://github.com/eclipse-basyx/basyx-applications/tree/main/aas-gui )

Acceptance Criteria

API of DTR returns

  • DisplayName
  • endpoint information

Additional Information

Creating Shell Descriptor as follows:

POST http://digital-twin-registry.tx.test/api/v3.0/shell-descriptors
Content-Type: application/json

{
  "description": null,
  "displayName": [
    {
      "language": "de",
      "text": "My Test Descriptor"
    }
  ],
  "extensions": null,
  "administration": null,
  "assetKind": null,
  "assetType": null,
  "endpoints": [
    {
      "interface": "http",
      "protocolInformation": {
        "href": "http://<shell-repo-url>/api/aas/shells/<b64encoded-shell-id>",
        "endpointProtocol": null,
        "endpointProtocolVersion": null,
        "subprotocol": null,
        "subprotocolBody": null,
        "subprotocolBodyEncoding": null,
        "securityAttributes": null
      }
    }
  ],
  "globalAssetId": null,
  "idShort": "id_short",
  "id": "no_id_short",
  "specificAssetIds": [
    {
      "name": "manufacturerPartId",
      "value": "98178I1-06",
      "externalSubjectId": {
        "type": "ExternalReference",
        "keys": [
          {
            "type": "GlobalReference",
            "value": "PUBLIC_READABLE"
          }
        ]
      }
    }
  ],
  "submodelDescriptors": [ ]
}

At the current state API returns (displayname and endpoint information are missing):

GET http://digital-twin-registry.tx.test/api/v3.0/shell-descriptors?limit=1000
{
  "paging_metadata": {},
  "result": [
    {
      "description": [],
      "displayName": [],
      "id": "no_id_short",
      "specificAssetIds": [
        {
          "supplementalSemanticIds": [],
          "name": "manufacturerPartId",
          "value": "98178I1-06",
          "externalSubjectId": {
            "type": "ExternalReference",
            "keys": [
              {
                "type": "GlobalReference",
                "value": "PUBLIC_READABLE"
              }
            ]
          }
        }
      ],
      "submodelDescriptors": []
    }
  ]
}

Instead, API should return:

{
  "paging_metadata":{ },
  "result":[
    {
      "description":[ ],
      "displayName":[ ],
      "id":"no_id_short",
      "endpoints":[
        {
          "interface":"http",
          "protocolInformation":{
            "href":"http://<shell-repo-url>/api/aas/shells/<b64encoded-shell-id>",
            "endpointProtocol":null,
            "endpointProtocolVersion":null,
            "subprotocol":null,
            "subprotocolBody":null,
            "subprotocolBodyEncoding":null,
            "securityAttributes":null
          }
        }
      ],
      "specificAssetIds":[
        {
          "supplementalSemanticIds":[ ],
          "name":"manufacturerPartId",
          "value":"98178I1-06",
          "externalSubjectId":{
            "type":"ExternalReference",
            "keys":[
              {
                "type":"GlobalReference",
                "value":"PUBLIC_READABLE"
              }
            ]
          }
        }
      ],
      "submodelDescriptors":[ ]
    }
  ]
}

The Consequence is that BaSyx AAS GUI is not able to show AAS in a correct way:
image

@ipa-big ipa-big added the enhancement New feature or request label Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant