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(trace): traceability kit release for 23.09 (3.2.0) #322

Merged
merged 91 commits into from
Sep 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
91 commits
Select commit Hold shift + click to select a range
5f526e7
Updated architecture picture to fit to dark mode
markuskeidl May 15, 2023
71839f5
Merge branch 'eclipse-tractusx:main' into docs/bugfixes-and-updates-f…
markuskeidl May 15, 2023
08c8d1b
Fixed deprecated references to release 3.0
markuskeidl May 15, 2023
bfeaecc
Initial draft for DTR changes because of EDC asset structure rework
markuskeidl May 24, 2023
af691eb
Merge branch 'eclipse-tractusx:main' into docs/edc-asset-structure-re…
markuskeidl May 24, 2023
cb29f81
docs(trace): extended conventions for specifying EDC endpoints in the…
markuskeidl May 26, 2023
dc5dbe6
chore(trace): Fixed linting errors
markuskeidl May 26, 2023
2ad96a6
Merge pull request #6 from catenax-ng/docs/edc-asset-structure-rework
mhellmeier May 31, 2023
2b6b60d
Merge branch 'eclipse-tractusx:main' into docs/trace-release-3.2
markuskeidl Jun 12, 2023
962cff5
docs(trace): updated KIT with changes because of AAS v3.0
markuskeidl Jun 12, 2023
79e2f41
docs(trace): fix conflicts for pull request #8
markuskeidl Jun 13, 2023
4359fb3
Merge branch 'eclipse-tractusx:main' into docs/trace-release-3.2
markuskeidl Jun 13, 2023
6c3dd39
Merge pull request #8 from catenax-ng/docs/trace-update-to-aas30-v2
mhellmeier Jun 13, 2023
b6d382c
docs(trace): Updated conventions for submodel descriptors and EDC ass…
markuskeidl Jun 14, 2023
1fff8a0
fix(trace): removed wrong postfix from submodel descriptor example
markuskeidl Jun 14, 2023
9bb4477
docs(trace): improved description which profile the endpoint must sup…
markuskeidl Jun 16, 2023
2b0576c
docs(trace): updated subprotocolBody content based on changes for EDC…
markuskeidl Jun 16, 2023
55c4fea
fix(trace): fixed missing "," in JSON examples
markuskeidl Jun 19, 2023
418766e
Merge branch 'docs/trace-release-3.2' into docs/trace-edc-asset-struc…
markuskeidl Jun 21, 2023
9244a81
docs(trace): updated KIT to reflect that a decentralized DTR is used
markuskeidl Jun 22, 2023
2eea0b2
Merge pull request #10 from catenax-ng/docs/trace-decentralized-regis…
mhellmeier Jun 22, 2023
5c75e47
fix(Trace): fixed issues with wrong whitespaces
markuskeidl Jun 23, 2023
d281290
fix(Trace): added missing changelog messages for previous pull requests
markuskeidl Jun 23, 2023
b9e8ae9
Merge branch 'docs/trace-release-3.2' into docs/trace-edc-asset-struc…
markuskeidl Jun 23, 2023
84dac5e
updated SerialPartTyzation 1.1.1 to SerialPart1.0.0 in development vi…
jacewski-bosch Jun 23, 2023
3e03e33
updated AssemblyPartRelationship 1.1.1 to SingleLevelBomAsBuilt 1.0.0…
jacewski-bosch Jun 23, 2023
9f9c066
added sample data for traction battery code
jacewski-bosch Jun 23, 2023
dd0437d
Merge pull request #9 from catenax-ng/docs/trace-edc-asset-structure-…
mhellmeier Jun 23, 2023
0f3f82d
made sample data more realistic (changed Traction Battery Codes)
jacewski-bosch Jun 23, 2023
6f99732
docs(trace): described usage if interface and href more clearly
markuskeidl Jun 26, 2023
5753397
fix(trace): updated interface value and clarified error return values…
markuskeidl Jun 26, 2023
4ed6f2a
docs(trace): IDSA protocol was renamed from IDS to DSP
markuskeidl Jun 27, 2023
a8efd6c
fixed sample data for single level bom as built
jacewski-bosch Jun 27, 2023
829384a
made asset lifecycle phase asset id mandatory
jacewski-bosch Jun 27, 2023
1b105d0
added manufacturerPartId to vehicle sample
jacewski-bosch Jun 27, 2023
3cae91c
made *assetLifecyclephase* specificAssetId optional for asBuilt twins
jacewski-bosch Jun 28, 2023
dfb3fab
docs(trace): use "currently" instead of specific release to avoid inc…
markuskeidl Jun 29, 2023
4a49082
Merge branch 'docs/trace-release-3.2' into docs/bugfixes-and-updates-…
markuskeidl Jun 29, 2023
04e7584
fix(trace): assetLifecyclePhase is mandatory for DT As-Planned
markuskeidl Jun 29, 2023
5b7c56b
fix(trace): removed reference to specific release
markuskeidl Jun 29, 2023
b08d4e3
Merge pull request #5 from catenax-ng/docs/bugfixes-and-updates-for-r3-1
mhellmeier Jun 29, 2023
6921166
chore(trace): fix linting issues
mhellmeier Jun 29, 2023
5a2073b
docs(trace): update policy sections
mhellmeier Jun 29, 2023
0a2902c
Merge branch 'docs/trace-release-3.2' into docs/trace-edc-asset-struc…
markuskeidl Jun 30, 2023
b7217f5
docs(trace): updated changelog
markuskeidl Jun 30, 2023
e64cc0d
Merge pull request #12 from catenax-ng/docs/trace-edc-asset-structure…
mhellmeier Jun 30, 2023
548cc1b
docs(trace): add TractionBatteryCode aspect model
mhellmeier Jul 6, 2023
ee085f3
Merge pull request #14 from catenax-ng/docs/trace-aspect-mode-battery…
mhellmeier Jul 10, 2023
ef01e63
docs(trace): added visibility permissions for specific asset IDs
markuskeidl Jul 10, 2023
0a9abf8
docs(trace): add `ID 3.2 Trace` purpose policy value
mhellmeier Jul 10, 2023
32c5b58
docs(trace): add verifiable credentials information
mhellmeier Jul 10, 2023
be1ea6e
Merge branch 'docs/trace-release-3.2' into docs/trace-policies
mhellmeier Jul 10, 2023
ef029ec
docs(trace): setting the visibility of entries in a digital twin's sp…
markuskeidl Jul 11, 2023
77c5944
docs(trace): clarified that the owner of a digital twin will always s…
markuskeidl Jul 12, 2023
f6c978c
docs(trace): improved description of usage of subprotocolBody in endp…
markuskeidl Jul 14, 2023
a8cc0d1
Merge branch 'docs/trace-release-3.2' into docs/aspect-models-updates…
jacewski-bosch Jul 19, 2023
bddb385
docs(trace): clarified how subprotocolBody is used by the data consumer
markuskeidl Jul 19, 2023
5293e97
docs(trace): improved description of how $value is used
markuskeidl Jul 19, 2023
1ffbfa7
chore(trace): fixed linting issue
markuskeidl Jul 19, 2023
ddb9bf6
updated SerialPart Aspect Model references from 1.0.0 to 1.0.1
jacewski-bosch Jul 19, 2023
beaeab7
Merge pull request #18 from catenax-ng/docs/aspect-models-updates-3.2
mhellmeier Jul 19, 2023
4aa8e92
docs(trace): improved wording
markuskeidl Jul 19, 2023
7a1ef44
Merge branch 'docs/trace-release-3.2'
markuskeidl Jul 19, 2023
a38b7a3
fix(trace): fixed structure of externalSubjectId in examples and fixe…
markuskeidl Jul 19, 2023
9e03a3d
Merge pull request #15 from catenax-ng/docs/trace-dtr-permissions
mhellmeier Jul 20, 2023
3ba9ed6
docs(trace): update about requirement customerPartID is mandatory
klanir123 Jul 20, 2023
32bec02
docs(trace): update adoption view about standards and changelog
klanir123 Jul 20, 2023
bef916c
Merge branch 'docs/trace-release-3.2'
markuskeidl Jul 21, 2023
bb8f7af
chore(trace): adding some updates lost with the previous merge
markuskeidl Jul 21, 2023
05343bd
fix(trace): fixed wrong type in externalSubjectId examples
markuskeidl Jul 21, 2023
9043279
Merge pull request #17 from catenax-ng/docs/trace-endpoint-asset-id
mhellmeier Jul 21, 2023
994e52a
docs(trace): update policy sections
mhellmeier Jul 31, 2023
5846db4
Merge branch 'docs/trace-release-3.2' into docs/trace-updates-develop…
mhellmeier Jul 31, 2023
c77362e
docs(trace): update standard links
mhellmeier Jul 31, 2023
892bbb2
Merge pull request #19 from catenax-ng/docs/trace-dtr-permissions-v2
mhellmeier Aug 1, 2023
b086997
Merge pull request #20 from catenax-ng/docs/trace-updates-development…
mhellmeier Aug 1, 2023
783d37c
Merge branch 'docs/trace-release-3.2' into docs/trace-policies
mhellmeier Aug 8, 2023
0ca53aa
docs(trace): add more access policy details
mhellmeier Aug 8, 2023
a11f4f4
Merge pull request #13 from catenax-ng/docs/trace-policies
mhellmeier Aug 8, 2023
1c88e30
docs(trace): update versioning
mhellmeier Aug 16, 2023
34aa9b9
Merge branch 'main' into docs/trace-release-3.2
mhellmeier Aug 16, 2023
99e091d
docs(trace): distinguish between 3.1.0 and next version
mhellmeier Aug 16, 2023
5a0ade8
docs(trace): clarify standard links and release
mhellmeier Aug 18, 2023
0b97028
docs(trace): Removed optional customer attributes from Batch example
markuskeidl Aug 21, 2023
76de881
docs(trace): fix versioning, links and naming
mhellmeier Aug 18, 2023
328c630
docs(trace): updated version for aspect model Batch from 1.0.2 to 2.0.0
markuskeidl Aug 23, 2023
a1db440
docs(trace): updated how to define visibility for digital twins based…
markuskeidl Aug 22, 2023
d9a502a
Merge pull request #21 from catenax-ng/docs/trace-batch-example-fix
mhellmeier Sep 4, 2023
99457d4
Merge pull request #22 from catenax-ng/docs/trace-dtr-permissions-v3
mhellmeier Sep 4, 2023
48281ed
docs(trace): create release 23.09
mhellmeier Sep 28, 2023
cd4cdf8
docs(trace): add kit to versioned folder
mhellmeier Sep 28, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
229 changes: 125 additions & 104 deletions docs-kits/kits/Traceability Kit/page_adoption-view.md

Large diffs are not rendered by default.

55 changes: 47 additions & 8 deletions docs-kits/kits/Traceability Kit/page_changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,70 @@ sidebar_position: 1

All notable changes to this Kit will be documented in this file.

## [2.0.0] - 2023-09-28

Compatible for release 23.09 (also known as 3.2).

### Added

- **Adoption View:**
- TractionBatteryCode aspect model
- Information about Verifiable Credentials
- **Development View:**
- TractionBatteryCode aspect model

### Changed

- **General:**
- Updated all parts of the KIT related to the digital twin registry as the DTR now has a decentralized architecture
- Updated SerialPartTypization 1.1.1 to SerialPart 1.0.1
- Updated AssemblyPartRelationship 1.1.1 to SingleLevelBomAsBuilt 1.0.0
- Updated aspect model Batch from version 1.0.2 to 2.0.0 ([Release Notes](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.batch/RELEASE_NOTES.md))
- Fixed references to deprecated releases
- **Adoption View:**
- Updated description of the policy section (Access Policies, Usage Policies, Contract Definitions)
- Updated relevant standards for release 3.2
- **Development View:**
- Updated documentation because of the migration to the new standard AAS v3.0 by the DTR
- Updated conventions for submodel descriptors and EDC asset structure to give data provides more flexibility in how to create EDC assets for submodels of digital twins
- Setting the visibility of entries in a digital twin's specifid asset IDs is now mandatory to ensure need-know
- Removed optional customer attributes from example for Batch aspect model

### Removed

- **Adoption View:**
- Policy payloads are removed and replaced by specific documentation links

## [1.0.1] - 2023-04-14

<h3>Added</h3>
Compatible for release 3.1.

- Adoption View: Traceability tutorial video
- Adoption View: Customer journey
### Added

<h3>Changed</h3>
- **Adoption View:**
- Traceability tutorial video
- Customer journey

### Changed

- ./.

<h3>Removed</h3>
### Removed

- ./.

## [1.0.0] - 2023-04-12

<h3>Added</h3>
Compatible for release 3.1.

### Added

- Initial version of the Kit including adoption, operation and development view + two API specifications (Notification API, Unique ID Push API)

<h3>Changed</h3>
### Changed

- ./.

<h3>Removed</h3>
### Removed

- ./.

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,70 @@ sidebar_position: 1

All notable changes to this Kit will be documented in this file.

## [2.0.0] - 2023-09-28

Compatible for release 23.09 (also known as 3.2).

### Added

- **Adoption View:**
- TractionBatteryCode aspect model
- Information about Verifiable Credentials
- **Development View:**
- TractionBatteryCode aspect model

### Changed

- **General:**
- Updated all parts of the KIT related to the digital twin registry as the DTR now has a decentralized architecture
- Updated SerialPartTypization 1.1.1 to SerialPart 1.0.1
- Updated AssemblyPartRelationship 1.1.1 to SingleLevelBomAsBuilt 1.0.0
- Updated aspect model Batch from version 1.0.2 to 2.0.0 ([Release Notes](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.batch/RELEASE_NOTES.md))
- Fixed references to deprecated releases
- **Adoption View:**
- Updated description of the policy section (Access Policies, Usage Policies, Contract Definitions)
- Updated relevant standards for release 3.2
- **Development View:**
- Updated documentation because of the migration to the new standard AAS v3.0 by the DTR
- Updated conventions for submodel descriptors and EDC asset structure to give data provides more flexibility in how to create EDC assets for submodels of digital twins
- Setting the visibility of entries in a digital twin's specifid asset IDs is now mandatory to ensure need-know
- Removed optional customer attributes from example for Batch aspect model

### Removed

- **Adoption View:**
- Policy payloads are removed and replaced by specific documentation links

## [1.0.1] - 2023-04-14

<h3>Added</h3>
Compatible for release 3.1.

- Adoption View: Traceability tutorial video
- Adoption View: Customer journey
### Added

<h3>Changed</h3>
- **Adoption View:**
- Traceability tutorial video
- Customer journey

### Changed

- ./.

<h3>Removed</h3>
### Removed

- ./.

## [1.0.0] - 2023-04-12

<h3>Added</h3>
Compatible for release 3.1.

### Added

- Initial version of the Kit including adoption, operation and development view + two API specifications (Notification API, Unique ID Push API)

<h3>Changed</h3>
### Changed

- ./.

<h3>Removed</h3>
### Removed

- ./.