Skip to content
This repository has been archived by the owner on Mar 12, 2024. It is now read-only.

Commit

Permalink
Merge pull request #8 from Metaform/doc/update-namespace
Browse files Browse the repository at this point in the history
doc: Updates namespaces to use Catena-X
  • Loading branch information
paullatzelsperger authored Jun 14, 2023
2 parents db784f5 + 9316328 commit c75f5b9
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 32 deletions.
2 changes: 1 addition & 1 deletion docs/architecture/cx-3-2/edc/policy.definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ an active signed traceability agreement:
"@context": [
"https://www.w3.org/ns/odrl.jsonld",
{
"tx": "https://w3id.org/tractusx/v0.0.1/ns/"
"cx": "https://w3id.org/catenax/v0.0.1/ns/"
}
],
"@type": "Offer",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"@context": {
"@version": 1.1,
"@protected": true,
"summary": "https://w3id.org/2023/tractusx/credentials/summary/",
"summary": "https://w3id.org/2023/catenax/credentials/summary/",
"id": "@id",
"type": "@type",
"SummaryCredential": {
Expand Down
6 changes: 1 addition & 5 deletions docs/credentials/summary/summary.vc.context.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"@context": {
"@version": 1.1,
"@protected": true,
"summary": "https://w3id.org/2023/tractusx/credentials/summary/",
"summary": "https://w3id.org/2023/catenax/credentials/summary/",
"id": "@id",
"type": "@type",
"SummaryCredential": {
Expand All @@ -14,10 +14,6 @@
"holderIdentifier": {
"@id": "summary:holderIdentifier"
},
"name": {
"@id": "summary:name",
"@type": "https://schema.org/Text"
},
"items": {
"@id": "summary:items",
"@type": "https://schema.org/Text"
Expand Down
25 changes: 10 additions & 15 deletions docs/credentials/summary/summary.vc.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# 1. Introduction: The Summary VC

The Summary VC (S-VC) is a temporary credential designed to roll-up a number of other Tractus-X VCs into a compact form
The Summary VC (S-VC) is a temporary credential designed to roll-up a number of other Catena-X VCs into a compact form
that will fit within HTTP header limits. This document specifies the Summary VC schema.

The following is an example Summary VC:

```json
{
"@context": [
"https://w3id.org/2023/tractusx/credentials/summary/v1"
"https://w3id.org/2023/catenax/credentials/summary/v1"
],
"id": "<credential uid>",
"type": [
Expand All @@ -21,8 +21,6 @@ The following is an example Summary VC:
"credentialSubject": {
"id": "<did:web:subject>",
"holderIdentifier": "<BPN>",
"type": "Summary-List",
"name": "CX-Credentials",
"items": [
"cx-active-member",
"cx-dismantler",
Expand Down Expand Up @@ -52,7 +50,7 @@ the [Verifiable Credentials Data Model v1.1](https://www.w3.org/TR/vc-data-model

## 2.2 Summary Items

The mandatory `items` property defined by the `https://w3id.org/2023/tractusx/credentials/summary/v1` context contains a
The mandatory `items` property defined by the `https://w3id.org/2023/catenax/credentials/summary/v1` context contains a
set of string identifiers indicating the credential types held by the subject.

Valid items are:
Expand All @@ -70,23 +68,20 @@ Valid items are:

If mandatory properties are not present, the VC should be interpreted as invalid.

# 3. Issues
# 3. Known Issues

The following are outstanding questions and issues that need to be resolved. There is
a [proposed context](./summary.vc.context.modified.v1.json) that resolves these issues.
The following are known questions and issues that need to be resolved with respect to other VCs for the 3.3 released.
There is a [proposed context](./summary.vc.context.modified.v1.json) that resolves these issues for the summary
credential if it is decided not to retire that VC. Note that these issues will not be resolved for the 3.3 release.

## 3.1. Clear Properties

- What are `credentialSubject#type` and `credentialSubject#name` used for?

## 3.2 Consistent Naming
## 3.1 Consistent Naming

- The `credentialSubject#items` property is too ambiguous and should be something
like `credentialSubject#hasCredentials`
- The `credentialSubject#contract-template` property uses hyphens and should be consistent with W3C camelCase
- The `credentialSubject#items-template` property uses hyphens and should be consistent with W3C camelCase

## 3.3 Referencing Credential Types
## 3.2 Referencing Credential Types

Credentials referenced in the [Summary Items property](#22-summary-items) should correspond to credential types, not
hyphenated strings, e.g.`DismantlerCredential` instead of `cx-dismantler`. Note that actual types will not be used as
Expand All @@ -103,7 +98,7 @@ The proposed valid property values are:
- BehaviorTwinCredential
- BpnCredential

## 3.4 Use of IRIs
## 3.3 Use of IRIs

The `credentialSubject#contract-template` property should be an IRI instead of text. There it should be defined as
type `@id`:
Expand Down
20 changes: 10 additions & 10 deletions docs/credentials/tx.vc.guidelines.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# 1. Introduction: Tractus-X Verifiable Credentials
# 1. Introduction: Catena-X Verifiable Credentials

The document provides guidelines for defining Tractus-X Verifiable Credentials (VC) based on
The document provides guidelines for defining Catena-X Verifiable Credentials (VC) based on
the [Verifiable Credentials Data Model v1.1](https://www.w3.org/TR/vc-data-model/).

## 1.2. Goals

The goal of these guidelines are to provide a baseline for VC interoperability across Tractus-X projects regardless of
The goal of these guidelines are to provide a baseline for VC interoperability across Catena-X projects regardless of
technology platform. These guidelines are intended to ensure that:

- It is possible to process and verify VCs using independent software stacks
- All TX VCs have consistent schemas and Json-Ld contexts
- All CX VCs have consistent schemas and Json-Ld contexts
- All VC Json-Ld contexts are correctly defined and allow for proper Json-Ld processing
- Consistent naming standards are used for all VC definitions
- A consistent versioning scheme is adopted for all VCs
- A consistent Json-Ld context resolution scheme is used for all VCs

# 2. The Tractus-X Namespace
# 2. The Catena-X Namespace

All VCs must be defined in the `Tractus-X namespace`
All VCs must be defined in the `Catena-X namespace`

# 3. Defining Verifiable Credentials

All TX verifiable credentials must conform to
All CX verifiable credentials must conform to
the [Verifiable Credentials Data Model v1.1](https://www.w3.org/TR/vc-data-model/).

> Note that the URL scheme adopted by this specification is the one in use by the W3C, which supports the ability to
Expand All @@ -33,13 +33,13 @@ A master Json-Ld 1.1 context is defined that contains common terms. VCs may have
and reference the master context. This allows VC definitions to be evolved and versioned independently. The master
context should be referenced as:

`https://w3id.org/tractusx/2023/credentials/v1.0.0`
`https://w3id.org/catenax/2023/credentials/v1.0.0`

## 3.2. Individual VC Contexts

Individual VC contexts define terms specific to the VC and should be referenced using a URL similar to the following:

`https://w3id.org/tractusx/2023/credentials/traceability/v1.0.0`
`https://w3id.org/catenax/2023/credentials/traceability/v1.0.0`

This URL is constructed by taking determining the year the VC definition is published, appending it to the base W3ID
url, and further appending the VC name and version.
Expand All @@ -54,7 +54,7 @@ should be unambiguous and must be associated with a proper IRI so that they are
{
"@context": {
"@version": 1.1,
"ex": "https://w3id.org/2023/tractusx/credentials/example/",
"ex": "https://w3id.org/2023/catenax/credentials/example/",
"ExampleCredential": {
"@id": "ex:ExampleCredential",
"exampleData": {
Expand Down

0 comments on commit c75f5b9

Please sign in to comment.