[PCF Exchange Kit] Kit Update Rel. 24.08 #967

wern · 2024-07-05T13:55:00Z

Description

Update of PCF Exchange Kit for Rel. 24.08.

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

[ x ] DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs.
[ x ] Copyright and license header are present on all affected files

…24.08

…latest CX Rel. 24.08 standards (e.g. references to PCF Rulebook and PCF Data Model)

…/wern/eclipse-tractusx.github.io into feature/PCF-Kit-Update_Rel_24.08

…8 standards (e.g. references to PCF Rulebook and PCF Data Model)

Date and version for Rel. 24.08 still need to be revised.

…/wern/eclipse-tractusx.github.io into feature/PCF-Kit-Update_Rel_24.08

…policies.

wern · 2024-07-08T15:54:32Z

@stephanbcbauer This is the PR I mentioned. Who would be responsible to review it?

wern · 2024-07-10T09:13:19Z

@danielmiehle @jSchuetz88 Anyone volunteering for a review? Would be highly appreciated ;)
Release Check ticket: eclipse-tractusx/sig-release#749

jSchuetz88

Thank you for your contribution and overall great update of the PCF KIT.

My findings refer to more "external" dependencies, that unfortunately needs to be resolved.

PCF Framework Agreement: As the links to the PDF-documents won't be supported anymore in the near future. Please update the reference to https://catenax-ev.github.io/docs/next/regulatory-framework/20000ft/use-case-pcf-exchange
Most standard references refer to "https://catena-x.net/de/standard-library". Please consider to update the reference to the newly introduced library, with the specific link to the respective standard (where possible). E.g. https://catenax-ev.github.io/docs/next/standards/CX-0001-EDCDiscoveryAPI for CX-0001
The openAPI plugin will be discontinued and the API and the respective MDX-files needs to be removed, please see the following guidance: [KITs] Remove API Plug-In in KITs #970
Is there a chance to provide the images as SVG-files? Some of the images are hard to read, due to the resolution.

wern · 2024-07-11T08:00:13Z

docs-kits/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md

@@ -9,14 +9,14 @@ sidebar_position: 3

 ## Introduction

-The developer view provides a detailed guide on how to utilize the PCF exchange KIT effectively. Developer will learn how to integrate the kit into there applications and make use of the feature of exchanging PCF values via the Catena-X network.
-IT-Administrators will learn how they need to provide PCF data and which components are needed therefore.
+The developer view provides a detailed guide on how to utilize the PCF exchange KIT effectively. Developers will learn how to integrate the kit into their applications and make use of the feature of exchanging PCF values via the Catena-X network.


jSchuetz88 · 2024-07-10T20:36:55Z

docs-kits/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md

+| [001](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20EDC%20Discovery/post-list-of-bpns-or-an-empty-array-to-retrieve-available-company-connector-authorization-required-roles-view-connectors) (Lookup EDC endpoints) | POST   | /api/administration/Connectors/discovery/                                                            | `[<Company's BPNL>]`                                                                                              |
 | [002](https://eclipse-tractusx.github.io/docs-kits/next/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/catalog) (Look up dDTR)                                                                                                                                            | POST   | /v2/catalog/request |  --> Lookup Asset in the EDC catalog (EDC asset type data.core.digitalTwinRegistry)                                                                                                                 |
 | [003](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20AAS%20Discovery/get-all-asset-administration-shell-ids-by-asset-link) (Lookup Twin ID)                                                                            | GET    | /lookup/shells                                                                                       | `assetIds= [{"key": "manufacturerPartId", "value":"mat345",{"key":"digitalTwinType", "value": "PartType"}}]` |
-| [004](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20AAS%20Registry/get-all-asset-administration-shell-descriptors) (Look Up PCF Submodel/EDC Asset ID)                                                                | GET    | /shell-descriptors                                                                                   | `{DIGITAL TWIN ID}`                                                                                               |
-| [005](../resources/development-view/catena-x-pcf-endpoint-1_1_0.yaml) (Requesting PCF Value)                                                                                                                                                                                                                                                            | GET    | /productIds                                                                                          | {productId}                                                                                                       |
-| [006](../resources/development-view/catena-x-pcf-endpoint-1_1_0.yaml) (Sending PCF Value)                                                                                                                                                                                                                                                                 | PUT    | /productIds                                                                                          | {productId}                                                                                                       |
+| [004](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20AAS%20Registry/get-all-asset-administration-shell-descriptors) (Lookup PCF submodel/EDC asset ID)                                                                | GET    | /shell-descriptors                                                                                   | `{DIGITAL TWIN ID}`                                                                                               |
+| [005](../resources/development-view/catena-x-pcf-endpoint-1_1_1.yaml) (Requesting PCF value)                                                                                                                                                                                                                                                            | GET    | /productIds                                                                                          | {productId}                                                                                                       |
+| [006](../resources/development-view/catena-x-pcf-endpoint-1_1_1.yaml) (Sending PCF value)                                                                                                                                                                                                                                                                 | PUT    | /productIds                                                                                          | {productId}                                                                                                       |


As the API plugin within Docusaurus will be discontinued in the near future and, thus, the links will stop working, please remove or update the references where possible. See: #970

I removed the MDX files, but kept an empty sidebar.js so build does not break. To also remove this file, I would have to change the top level sidebar.js. Didn't want to change on top level without agreement up front. ;-)

In addition: Is there a break save way to link to the openAPI folder? Did not want to do this relatively and an absolute link did not work.

Unfortunately I think, for now you should stick with the relative paths. In my understanding, these files will eventually be automatically copied and rendered with swagger. But for now I'm not sure whether it is already automated or not. Hence, we may need to fix the links later on.

Example link: https://eclipse-tractusx.github.io/api-hub/puris/1.0.0/swagger-ui/
In this case the final link should look like: https://eclipse-tractusx.github.io/api-hub/pcf/1.1.1/swagger-ui/

wern · 2024-07-11T08:04:33Z

docs-kits/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md

+In addition an *optional* constraint for an existing tenant-specific bilateral contract can be added. It should reference the contract number and is NOT backed up by verifiable credentials. Nevertheless it will be checked on a syntactical level during contract negotiation. If such a contract refererence should be used, a specific usage policy per tenant is needed, as constraint concatenation via OR is not recommended.
+
+>**Note**
+>More informations can be found in the official [ODRL Profile Definition](https://github.com/catenax-eV/cx-odrl-profile/blob/main/profile.md).


It meant to be a general note that this is a source of information. No specific version required.

wern · 2024-07-11T08:08:11Z

Thank you for your contribution and overall great update of the PCF KIT.

My findings refer to more "external" dependencies, that unfortunately needs to be resolved.

PCF Framework Agreement: As the links to the PDF-documents won't be supported anymore in the near future. Please update the reference to https://catenax-ev.github.io/docs/next/regulatory-framework/20000ft/use-case-pcf-exchange

Most standard references refer to "https://catena-x.net/de/standard-library". Please consider to update the reference to the newly introduced library, with the specific link to the respective standard (where possible). E.g. https://catenax-ev.github.io/docs/next/standards/CX-0001-EDCDiscoveryAPI for CX-0001

The openAPI plugin will be discontinued and the API and the respective MDX-files needs to be removed, please see the following guidance: [KITs] Remove API Plug-In in KITs DRAFT #970

Is there a chance to provide the images as SVG-files? Some of the images are hard to read, due to the resolution.

@jSchuetz88 Do you have specific images in mind? I tested sequence charts and diagrams and could perfectly zoom in (even on a bigger screen). We should be able to provide SVGs for most images, but wanted to check up front if we need it for some specific ones.

jSchuetz88 · 2024-07-11T08:13:21Z

Thank you for your contribution and overall great update of the PCF KIT.
My findings refer to more "external" dependencies, that unfortunately needs to be resolved.

PCF Framework Agreement: As the links to the PDF-documents won't be supported anymore in the near future. Please update the reference to https://catenax-ev.github.io/docs/next/regulatory-framework/20000ft/use-case-pcf-exchange

Most standard references refer to "https://catena-x.net/de/standard-library". Please consider to update the reference to the newly introduced library, with the specific link to the respective standard (where possible). E.g. https://catenax-ev.github.io/docs/next/standards/CX-0001-EDCDiscoveryAPI for CX-0001

The openAPI plugin will be discontinued and the API and the respective MDX-files needs to be removed, please see the following guidance: [KITs] Remove API Plug-In in KITs DRAFT #970

Is there a chance to provide the images as SVG-files? Some of the images are hard to read, due to the resolution.

@jSchuetz88 Do you have specific images in mind? I tested sequence charts and diagrams and could perfectly zoom in (even on a bigger screen). We should be able to provide SVGs for most images, but wanted to check up front if we need it for some specific ones.

Sorry, I double checked. It seems it was an issue on my side with the zoom. Personally I would sill prefer SVGs, but all of the images are perfectly readable.

danielmiehle

LGTM

danielmiehle · 2024-07-23T20:53:58Z

@maximilianong please add your review.

docs-kits/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md


 ![EDCDiscoveryAndDTRAccess](../resources/development-view/EDCDiscoveryanddDTRAccess.png)

 ### PCF Request

-To actual request PCF values via the PCF API endpoint first of all the EDC PCF asset needs to be identified. Therefore the decentralized Digital Twin Registry (dDTR) is used. Data provider must register their dDTR(s) as EDC assets following the CX-0002 standard. After identifying the dDTR the Digital Twin with the related PCF submodel can be looked up (see [API calls [0003 +0004]](#api-calls)). An example is documented [here](#payload-for-requesting-pcf-sub-model).
+In order to request PCF values via the PCF API endpoint first of all the EDC PCF asset needs to be identified. Therefor, the decentralized Digital Twin Registry (dDTR) is used. Data providers must register their dDTR(s) as EDC assets following the [CX-0002](https://catenax-ev.github.io/docs/next/standards/CX-0002-DigitalTwinsInCatenaX) Digital Twins in Catena-X standard. After identifying the dDTR, the digital twin with the related PCF submodel can be looked up (see [API calls [0003 +0004]](#api-calls)). An example is documented [here](#payload-for-requesting-pcf-sub-model).


jSchuetz88 · 2024-07-24T23:18:11Z

docs-kits/kits/PCF Exchange Kit/resources/development-view/catena-x-pcf-endpoint-1_1_1.yaml

It is unclear to me, why the same openAPI has been uploaded twice? Within the Kit and within the openAPI-folder?
Removing this one, would also prevent the requirement for an IP-clearance check.

jSchuetz88 · 2024-07-24T23:22:04Z

src/pages/CHANGELOG.md

Unclear to me, why was the overall CHANGELOG deleted?

jSchuetz88

Thank you for the updates. Although I have a few last minor remarks, that should be considered, there is nothing left which prevents an approval from my side.

jSchuetz88 · 2024-07-26T09:57:12Z

@wern The PR had to been reverted, as its deleted the overall Changelog. Please re-open a new PR without the Deletion of the src/pages/CHANGELOG

wern and others added 30 commits June 6, 2024 09:25

Change Open API doc to current version.

e79777d

Fix issue eclipse-tractusx#838 - invalid source URL.

9b94625

Update pcf-exchange-api to latest version.

9903ab4

Merge branch 'eclipse-tractusx:main' into feature/PCF-Kit-Update_Rel_…

107d1c9

…24.08

Several fixes and adaptations in "Adoption View" with regards to the …

3849d9f

…latest CX Rel. 24.08 standards (e.g. references to PCF Rulebook and PCF Data Model)

Merge branch 'feature/PCF-Kit-Update_Rel_24.08' of https://github.com…

40cb5a1

…/wern/eclipse-tractusx.github.io into feature/PCF-Kit-Update_Rel_24.08

Several fixes and adaptations with regards to the latest CX Rel. 24.0…

71cdb8c

…8 standards (e.g. references to PCF Rulebook and PCF Data Model)

Minor typo fixes

bb84992

Re-fix source URL ;)

2a19d99

Remove URL based sample data.

32f5c6a

Adapt policy structure and introduce bilateral contracts.

2737182

Fix source link.

fdb7aad

Minor layout correct for collapsing/ expanding payload of PCF data model

a043b85

Corrected some typos

d323137

Enhance JSON sample formatting.

ee0de6d

Fix Notes.

572f2dd

Updated content, fixed several typos after review.

4d58c3d

Fixed several typos

23d57a9

Fixed typos

dcb53c5

Fixed several typos.

d177ac9

Fixed several typos.

246d4ae

Added update information for Rel. 24.08.

d5c189e

Date and version for Rel. 24.08 still need to be revised.

Resolve merge conflicts.

17a0dac

Update datamodel version in diagrams.

6174fc6

Update data model version.

c0c1fe4

Change reference FrameworkAgreement.

c95557a

Update standard version numbers.

b7940c6

Added update information in context of Rel. 24.08

051312f

Merge branch 'feature/PCF-Kit-Update_Rel_24.08' of https://github.com…

0449e98

…/wern/eclipse-tractusx.github.io into feature/PCF-Kit-Update_Rel_24.08

Clarify access polices usage when using bilateral contracts in usage …

2620c37

…policies.

wern and others added 3 commits July 4, 2024 16:22

Remove image transparency.

ecc5a20

Resize and rearrange images to avoid upscaling by docusaurus.

5996432

Updated illustrations and fixed layout issues.

d6bc4f6

This was referenced Jul 5, 2024

[PCF Exchange Kit] Release Checks 24.08 eclipse-tractusx/sig-release#749

Closed

Evolve PCF Exchange Kit for Rel. 24.08 eclipse-tractusx/sig-release#628

Open

SMaierTSI and others added 5 commits July 8, 2024 08:59

Fixed linting errors

e0171e9

Fixed further linting errors

2a112a5

Fixed further linting errors

99ac466

Fix linting issues.

e43473e

Fix more linter findings.

0e021df

danielmiehle requested review from danielmiehle, maximilianong, cwBMW and jSchuetz88 July 10, 2024 09:51

jSchuetz88 suggested changes Jul 10, 2024

View reviewed changes

Incorporate review findings.

8f000d8

danielmiehle approved these changes Jul 23, 2024

View reviewed changes

jSchuetz88 reviewed Jul 24, 2024

View reviewed changes

src/pages/CHANGELOG.md

Copy link

Member

jSchuetz88 Jul 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unclear to me, why was the overall CHANGELOG deleted?

jSchuetz88 approved these changes Jul 24, 2024

View reviewed changes

maximilianong approved these changes Jul 26, 2024

View reviewed changes

maximilianong merged commit eaea65e into eclipse-tractusx:main Jul 26, 2024
5 checks passed

maximilianong mentioned this pull request Jul 26, 2024

Revert "[PCF Exchange Kit] Kit Update Rel. 24.08" #1003

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PCF Exchange Kit] Kit Update Rel. 24.08 #967

[PCF Exchange Kit] Kit Update Rel. 24.08 #967

wern commented Jul 5, 2024

wern commented Jul 8, 2024

wern commented Jul 10, 2024

jSchuetz88 left a comment •

edited

Loading

This comment was marked as resolved.

wern Jul 11, 2024

jSchuetz88 Jul 10, 2024

wern Jul 11, 2024

jSchuetz88 Jul 24, 2024 •

edited

Loading

This comment was marked as resolved.

wern Jul 11, 2024

wern commented Jul 11, 2024

jSchuetz88 commented Jul 11, 2024

danielmiehle left a comment

danielmiehle commented Jul 23, 2024

This comment was marked as resolved.

jSchuetz88 Jul 24, 2024 •

edited

Loading

jSchuetz88 Jul 24, 2024

jSchuetz88 left a comment

jSchuetz88 commented Jul 26, 2024

[PCF Exchange Kit] Kit Update Rel. 24.08 #967

[PCF Exchange Kit] Kit Update Rel. 24.08 #967

Conversation

wern commented Jul 5, 2024

Description

Pre-review checks

wern commented Jul 8, 2024

wern commented Jul 10, 2024

jSchuetz88 left a comment • edited Loading

Choose a reason for hiding this comment

This comment was marked as resolved.

wern Jul 11, 2024

Choose a reason for hiding this comment

jSchuetz88 Jul 10, 2024

Choose a reason for hiding this comment

wern Jul 11, 2024

Choose a reason for hiding this comment

jSchuetz88 Jul 24, 2024 • edited Loading

Choose a reason for hiding this comment

This comment was marked as resolved.

wern Jul 11, 2024

Choose a reason for hiding this comment

wern commented Jul 11, 2024

jSchuetz88 commented Jul 11, 2024

danielmiehle left a comment

Choose a reason for hiding this comment

danielmiehle commented Jul 23, 2024

This comment was marked as resolved.

jSchuetz88 Jul 24, 2024 • edited Loading

Choose a reason for hiding this comment

jSchuetz88 Jul 24, 2024

Choose a reason for hiding this comment

jSchuetz88 left a comment

Choose a reason for hiding this comment

jSchuetz88 commented Jul 26, 2024

jSchuetz88 left a comment •

edited

Loading

jSchuetz88 Jul 24, 2024 •

edited

Loading

jSchuetz88 Jul 24, 2024 •

edited

Loading