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

docs(ecopass-kit): Updated the EcoPass KIT Software Development View #791

Conversation

matbmoser
Copy link
Contributor

@matbmoser matbmoser commented Mar 25, 2024

Why do we create this PR?

We want to update the software development view from the Eco Pass kit for release 24.05.

What we want to achieve with this PR?

Have the software development view referencing the other KITs from Tractus-X in the list of standards.
Updated latest functionalities added to the KIT reference implementation.

What's new?

Added

  • Added reference to other Tractus-X KITs in the list of standards and prerequisites in the Software Development View
  • Added single api retrival flow and api documentation from the DPP reference implementation
  • Added reference to the digital product pass verification feature coming in 24.05
  • Added description of digital product pass addons

Pre-review checks

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

  • DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs. (NO DEPENDENCIES)
  • Copyright and license header are present on all affected files
  • LINTING issues are resolved.
  • CHANGELOG updated

@matbmoser matbmoser added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 25, 2024
@matbmoser matbmoser requested a review from LuisRickert March 25, 2024 17:19
@matbmoser matbmoser self-assigned this Mar 25, 2024
@matbmoser matbmoser marked this pull request as ready for review April 9, 2024 15:13
@matbmoser matbmoser force-pushed the ECO-Pass-KIT-Update-24.05-Software-View branch from 1a5eb95 to 6a7f1ac Compare April 25, 2024 11:53
@matbmoser
Copy link
Contributor Author

Ok I checked for the linting and now it it is working.

Comment on lines +404 to +407
{
"key" : "assetLifecyclePhase",
"value": "AsBuilt"
},
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not mandated by the industry core for R24-05 anymore. Leave it in only if you want to go beyond the compatibility guarantees of CX.

Copy link
Contributor

Choose a reason for hiding this comment

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

@matbmoser should we leave this is ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You can remove it, we need just the digital twin type, that's mandatory

Copy link

@HFocken HFocken left a comment

Choose a reason for hiding this comment

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

Thank you - minor detail change required, then good to go!


- Updated battery pass model to latest version `v4.0.0`
- Updated Business Architecture Diagram

## [0.1.0] - 2023-08-11

### Added
### 23.08 Added
Copy link

Choose a reason for hiding this comment

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

Please change to 23.09 (also below) - 23.08 does not exist.

Copy link
Contributor

Choose a reason for hiding this comment

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

Done

danielmiehle
danielmiehle previously approved these changes May 15, 2024
Copy link
Contributor

@danielmiehle danielmiehle left a comment

Choose a reason for hiding this comment

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

LGTM

@matbmoser
Copy link
Contributor Author

Before we merge this I need to include a link to your digital product pass tutorial and verification addons

Copy link

@HFocken HFocken left a comment

Choose a reason for hiding this comment

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

Thank you for addressing the change requests!

@arnoweiss
Copy link
Contributor

Y'all are still failing the dash-licence and markdown-lint actions. Also, when building the website, there's a lot of warnings wrt to figures in the eco-pass-kit [1]. Is this addressed in this PR?

[1]

image

Copy link
Member

@jSchuetz88 jSchuetz88 left a comment

Choose a reason for hiding this comment

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

Thank you for the update of the KIT, looks good to me. Only one minor remark.

| Submodel Server | The data source adhering to a subset of the Submodel API as defined in AAS Part-2 3.0. Where the Passport Aspects are stored | [FA³ST-Framework](https://github.com/FraunhoferIOSB/FAAAST-Service), [Eclipse Basyx](https://github.com/eclipse-basyx/basyx-java-sdk), [AASX Server](https://github.com/admin-shell-io/aasx-server) | CX - 0002 |
| EDC | Main gateaway to the network. In this use case two EDC need be existing, one connected to the Digital Product Pass (EcoPass KIT) [EDC Consumer] and another to the Provider Catena-X components [EDC Provider] | [eclipse-tractusx/tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc) | CX - 0018 |
| EDC | Main gateaway to the network. In this use case two EDC need be existing, one connected to the Digital Product Pass (EcoPass KIT) [EDC Consumer] and another to the Provider Catena-X components [EDC Provider] | [eclipse-tractusx/tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc) | CX - 0018 OR [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/category/connector-kit) |
| Digital Product Pass | The [**EcoPass KIT**] reference implementation. The application responsible for retrieving the passports and interacting with the services listed above. | [eclipse-tractusx/digital-product-pass](https://github.com/eclipse-tractusx/digital-product-pass) | CX - 0096 |
Copy link
Member

Choose a reason for hiding this comment

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

The CX-Identifier (CX-0096) should be updated to "CX-0143" (Use Case Circular Economy - Digital Product Passport Standard 1.0.0) as the successor of CX-0096 in R24.05.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

@danielmiehle
Copy link
Contributor

Thanks for the updates. Can you please check the linting issues? We would like to merge the PR today.

@matbmoser
Copy link
Contributor Author

matbmoser commented May 24, 2024

Thanks for the updates. Can you please check the linting issues? We would like to merge the PR today.

On my way, forgot to push it... Ok it was wrong written:
image

@matbmoser
Copy link
Contributor Author

Now it should be fine :)

@matbmoser
Copy link
Contributor Author

matbmoser commented May 24, 2024

Y'all are still failing the dash-licence and markdown-lint actions. Also, when building the website, there's a lot of warnings wrt to figures in the eco-pass-kit [1]. Is this addressed in this PR?

[1]

image

This is from adoption view no?
They are going to be addressed in this PR: #790

Copy link
Contributor

@danielmiehle danielmiehle left a comment

Choose a reason for hiding this comment

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

LGTM - ready for merge!

@maximilianong maximilianong merged commit e7fe342 into eclipse-tractusx:main May 24, 2024
5 checks passed
@LuisRickert LuisRickert deleted the ECO-Pass-KIT-Update-24.05-Software-View branch June 10, 2024 16:39
@matbmoser matbmoser linked an issue Jul 5, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Release KIT 24.05
7 participants