GAIA-X4PLC-AAD / ontology-management-base

Our implementation for an open automated ontology management process for GAIA-X interoperable ecosystems. Please use a community agreed domain specific class or if not yet available please create a new class and submit it for review.
Other
2 stars 0 forks source link

ID-definition for 'domain-specific' claims #67

Open rcrswld opened 4 days ago

rcrswld commented 4 days ago

Domain-specific claims will be created mostly before the the gx-relevant claims will be defined. How do we create a unique id for the domain-specific claim which I can use for referencing to the gx-claims (data resource, etc.)?

Example: "@id": "did:web:registry.gaia-x.eu:HdMap:wDgNY3gZAxMe3LjhdAZ9TbPiYnQ-yybNhCu8",

https://github.com/GAIA-X4PLC-AAD/hd-map-asset-example/blob/main/metadata/Gaia_X_Example_Asset_TestfeldNiedersachsen_ALKS_ODR_offset.json

Follow-up question: Do we use a did or regular url as id, s.: "@id": "https://www.msg.group/dataresource",

https://github.com/GAIA-X4PLC-AAD/gaia-x-compliant-claims-example/blob/main/src/DataResource-instance.json

rcrswld commented 4 days ago

ID of domain-specific claim must be equal to ID of according data resource.

Proposal for unique ID: identifierPrefix+UUID e.g.: "@id": "https://www.gaia-x4plcaad.info/claims/data-resource/d1f3d6e1-9c24-416c-85c2-cbe4190eb707"

Therefore, first step would be ideally to create gaia-x claims with the claim compliance provider (https://claim-compliance-provider.gxfs.gx4fm.org/docs/#/Claim%20Compliance%20Provider%20Controller/post_v1_generate_claims) in order to have the correct ID which can be used for domain-specific claims.

Sample from claim compliance provider can be used as template and the actual attributes like name and description can then be added, when a service offerings has to defined.

@aparduzi , @jodemer , please check if this works for you.

robertschubert commented 4 days ago

also my proposal: create a template from the result from the claim-compliance-provider (or https://github.com/GAIA-X4PLC-AAD/gaia-x-compliant-claims-example) with placeholders for ID and other fields like name or description and others. Make sure the ID-relations are correct and link the proper objects. Then you can determine the ids, name, description, ... in your "claim-creator and replace the placeholders with the correct values.

robertschubert commented 4 days ago

I will put the source code of the claim compliance provider on GitHub next week. There are templates for the https://claim-compliance-provider.gxfs.gx4fm.org/docs/#/Claim%20Compliance%20Provider%20Controller/post_v1_generate_claims endpoint defined there, so you can take them as a starting point.

robertschubert commented 4 days ago

Follow-up question: Do we use a did or regular url as id, s.: "@id": "https://www.msg.group/dataresource",

This can be an URL, a DID or any other unique identifier. As @rcrswld mentioned, a UUID should be used to ensure uniqueness. The ID is used in the federated catalogue to link objects in the graph db together.

If you use a DID you should ensure that this did is resolvable and has a DID-Document which is returned by a common did resolver (e.g. https://dev.uniresolver.io). Same would be nice in case of https://* prefix in the ID. But both is not mandatory for the federated catalogue since the ID is only needed for linkage.

If you are not able to put the document into a CDN my suggestion is: do not use did. Use an URL having a prefix related to your company with a UUID (like the example in ccp , e.g. https://www.gaia-x4plcaad.info/claims/data-resource/25929d5f-a577-475c-aab8-aa05c65e8d1c)