Skip to content

Commit

Permalink
Added content + markdown format fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
regiseloi-idlab committed Aug 15, 2024
1 parent 772ba75 commit 0f9a4b4
Show file tree
Hide file tree
Showing 20 changed files with 70 additions and 53 deletions.
2 changes: 0 additions & 2 deletions docs/api_testing/api_testing_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,3 @@ sidebar_position: 1
# Introduction to API endpoint testing with DTT {#introduction-to-api-endpoint-testing-with-dtt}

**_TODO_**: Focus on core VC capabilities: issue, verify, revoke. The objective is to help understand the interop capabilities of a specific endpoint by analyzing the interactions between this test suite and that endpoint.


4 changes: 2 additions & 2 deletions docs/developer_guide/dg_dtt_api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# The DTT API

The DTT API server public swagger access is here: https://api.dtt.dtlab-labcn.app
The DTT API server public swagger access is here: [https://api.dtt.dtlab-labcn.app](https://api.dtt.dtlab-labcn.app)

Swagger reference documentation: https://swagger.io/docs/
Swagger reference documentation: [https://swagger.io/docs/](https://swagger.io/docs/)
1 change: 0 additions & 1 deletion docs/developer_guide/dg_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ sidebar_position: 1
# Introduction

Content here

2 changes: 1 addition & 1 deletion docs/dtt_overview/dtt_how_can_i_contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 3

# How can I contribute to DTT?

[Contact us!](mailto:[email protected])
[Contact us!](mailto:[email protected])
2 changes: 1 addition & 1 deletion docs/dtt_overview/dtt_what_is_dtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ sidebar_position: 1

**Digital Trust Test Bench (DTT)** is a quality assurance tool for digital credential solutions, allowing governments and organizations to put digital credentials to the test to make sure they work with other platforms.

DTT is not: a certification or compliance tool.
DTT is not: a certification or compliance tool.
2 changes: 1 addition & 1 deletion docs/dtt_overview/dtt_who_develops_and_maintain.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ sidebar_position: 2

**_TO-DO_**: reuse existing content!

Note: standards are evolving, those test suites are designed to quickly adapt to those needs.
Note: standards are evolving, those test suites are designed to quickly adapt to those needs.
Binary file added docs/images/did-format-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs/mdl_testing/mdl_testing_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,3 @@ sidebar_position: 1
# Introduction to API endpoint testing with DTT {#introduction-to-api-endpoint-testing-with-dtt}

**_TODO_**: Focus on core VC capabilities: issue, verify, revoke. The objective is to help understand the interop capabilities of a specific endpoint by analyzing the interactions between this test suite and that endpoint.


20 changes: 15 additions & 5 deletions docs/w3c_did/did_about.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
---
sidebar_position: 6
sidebar_position: 5
---

# About the W3C DID test suite

**_TO-DO_**: Currently powered by goddidy - learn more here: XXX
Based on the [W3C DID Core recommendation](https://www.w3.org/TR/did-core/) and the [DID Resolution specification draft](https://w3c.github.io/did-resolution/) published by the [Credential Community Group](https://www.w3.org/groups/cg/credentials), the [Decentralized Identity Foundation](https://identity.foundation/) (DIF) and its [Identifiers & Discovery Working Group](https://github.com/decentralized-identity/identifiers-discovery/) have produced a DID Universal Resolver. See [https://dev.uniresolver.io/](https://dev.uniresolver.io/) for a DIF-hosted instance of the Universal Resolver that can be used for testing purposes.

**_TO-DO_**: Additional resources:
* Learn more about DIDs here: XXX
* Get involved here: XXX
## DTT use of godiddy

[**godiddy.com**](https://godiddy.com/app/resolve) provides another implementation of the DID universal resolver, with both free and enterprise tier subscription options (adapted to production use). DTLab, through its partnership with [Danube Tech GmbH](https://danubetech.com/), leverages godiddy to facilitate DID resolution and DID document validation for DTT users.
More information on the godiddy resolver service can be found [here](https://docs.godiddy.com/apis/universal-resolver).

## Additional resources

* Learn more about DIDs: [W3C DID Core Recommendation](https://www.w3.org/TR/did-core/)

* Get involved:

* [W3C DID Working Group](https://www.w3.org/2019/did-wg/)
* [DIF Identifiers & Discovery Working Group](https://github.com/decentralized-identity/identifiers-discovery/)
13 changes: 12 additions & 1 deletion docs/w3c_did/did_how_to_use.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,15 @@ sidebar_position: 3

# How to use this test suite

**_TO-DO_**: How to access / configure this test suite: availability test/prod, user account, etc.
Please complete the access request form on the [DTT landing page](https://dtt.dtlab-labcn.app/) or contact [[email protected]](mailto:[email protected]) if you don't have a user account for DTT.

To get started, enter the URL representing a DID, and click on **Resolve DID**.

## Need examples to try it out?

[https://dev.uniresolver.io/](https://dev.uniresolver.io/) and [https://godiddy.com/app/resolve](https://godiddy.com/app/resolve) provide a number of examples for a variety of DID methods.
Here are a few to get you started!

- did:cheqd:testnet:55dbc8bf-fba3-4117-855c-1e0dc1d3bb47
- did:ebsi:zkC6cUFUs3FiRp2xedNwih2
- did:indy:indicio:demo:KKyAeG7woJMV6MhhAREVKp
11 changes: 0 additions & 11 deletions docs/w3c_did/did_input.md

This file was deleted.

15 changes: 13 additions & 2 deletions docs/w3c_did/did_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,19 @@ sidebar_position: 1

## What are DIDs? {#what-are-dids}

**_TO-DO_**: reuse someone else’s content here!
Decentralized identifiers (DID) are unique and persistent identifiers that do not rely on any single centralized or deferated registration authority. They can refer to any subject (person, organization, thing, etc).

## What is their role / how are they being used? {#what-is-their-role-how-are-they-being-used}

**_TO-DO_**: reuse someone else’s content here!
From the [W3C DID Core Recommendation](https://www.w3.org/TR/did-core/):
DIDs are *URIs* that associate a *DID subject* with a *DID document* allowing trustable interactions associated with that subject. Each DID document can express cryptographic material, *verification methods*, or *services*, which provide a set of mechanisms enabling a *DID controller* to prove control of the DID. Services **enable trusted interactions** associated with the DID subject.

## A simple example {#a-simple-example}

A DID is a simple text string consisting of three parts:

1. the did URI scheme identifier
2. the identifier for the DID method
3. the DID method-specific identifier.

![decentralized identifier example](../images/did-format-example.png)
5 changes: 2 additions & 3 deletions docs/w3c_did/did_results.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 4
---

# Test results
Expand All @@ -8,7 +8,6 @@ sidebar_position: 5

**_TO-DO_**: plain English overview of results, maybe in the form of a simple checklist?


## Common errors and their meaning {#common-errors-and-their-meaning}

| Error code | Description | What it might mean |
Expand All @@ -18,4 +17,4 @@ sidebar_position: 5

## How to save and share your test results {#how-to-save-and-share-your-test-results}

**_FUTURE_**: intro to Allure report framework
**_FUTURE_**: intro to Allure report framework
31 changes: 17 additions & 14 deletions docs/w3c_did/did_specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,31 @@ sidebar_position: 2

# Standards and specifications for DID methods

## Understanding the Decentralized Identifier ecosystem {#understanding-the-decentralized-identifier-ecosystem}
Several working groups are collaborating towards the standardisation and adoption of DIDs, to enable the creation, resolution, and discovery of deventralized identifiers and names across decentralized digital credentials and identity ecosystems. They are anchoring their work on the W3C DID Core recommendation ("Standard"), augmenting it with more implementation focused guidelines and recommendations to use DIDs, and with additional requirements that are DID-method specific

See [universal-resolver/docs/driver-development.md at main](https://github.com/decentralized-identity/universal-resolver/blob/main/docs/driver-development.md#driver-rules)

[DID Specification Registries](https://www.w3.org/TR/did-spec-registries/)
## W3C DID core specification {#w3c-did-core-specification}

[Decentralized Identifiers (DIDs) v1.0](https://www.w3.org/TR/did-core/). This document specifies the DID syntax, a common data model, core properties, serialized representations, DID operations, and an explanation of the process of resolving DIDs to the resources that they represent.

## W3C DID core specification {#w3c-did-core-specification}
## Resolution of Decentralized identifiers (DIDs) {#resolution-of-decntralized-identifiers}

[Decentralized Identifiers (DIDs) v1.0](https://www.w3.org/TR/did-core/)
The [DID resolution draft report](https://w3c.github.io/did-resolution/) augments the DID core specification by defining common requirements, algorithms including their inputs and results, architectural options, and various considerations for the DID resolution and DID URL dereferencing processes.

Each DID method that gets defined should be registered in the [DID Method Registry](https://w3c.github.io/did-spec-registries/#did-methods) of the W3C DID working group.
Each DID method requires the implementation of a *driver* to enable implementations of the universal resolvers to support this DID method. See [universal-resolver/docs/driver-development.md](https://github.com/decentralized-identity/universal-resolver/blob/main/docs/driver-development.md#driver-rules) for more information.

## Method-specific specifications and best practices {#method-specific-specifications-and-best-practices}

**_TO-DO_**: We need to explain the role of those specs in relation to the CORE spec, which we can get from the primer sections of those specs hopefully, but also what exactly we are testing for here (which may require explaining that it depends on what validation the driver for this specific method has implemented)
While all DID methods must conform to the W3C DID Core specification, different use cases and requirements have led to the creating of different and complementary DID methods. Some are fairly well defined and are used in production, whereas others are more experimental and not as completely defined yet.
Defining how a DID and DID document are created, resolved, and managed on a specific blockchain or “target system” is the role of a DID method specification.

Here are some of the DID methods most actively used and discussed by the community. For more information, please consult the [DID Method Registry](https://w3c.github.io/did-spec-registries/#did-methods).

| DID method | Specification | Status |
| ---------- | ------------- | ------ |
| did:indy | https://github.com/hyperledger/indy-did-method | |
| did:key | https://w3c-ccg.github.io/did-method-key | The did:key Method v0.7 |
| did:peer | https://identity.foundation/peer-did-method-spec | Peer DID Method Specification |
| did:tdw | https://bcgov.github.io/trustdidweb | Trust DID Web - The did:tdw DID Method |
| did:web | https://w3c-ccg.github.io/did-method-web | Unofficial draft authored by the [W3C Credentials Community Group](https://www.w3.org/community/credentials/). |
| did:x509 | https://github.com/microsoft/did-x509 | DRAFT: did:x509 Decentralized Identifier Method Specification |
| did:indy | [https://github.com/hyperledger/indy-did-method](https://github.com/hyperledger/indy-did-method) | |
| did:key | [https://w3c-ccg.github.io/did-method-key](https://w3c-ccg.github.io/did-method-key) | The did:key Method v0.7 |
| did:peer | [https://identity.foundation/peer-did-method-spec](https://identity.foundation/peer-did-method-spec) | Peer DID Method Specification |
| did:tdw | [https://bcgov.github.io/trustdidweb](https://bcgov.github.io/trustdidweb) | Trust DID Web - The did:tdw DID Method |
| did:web | [https://w3c-ccg.github.io/did-method-web](https://w3c-ccg.github.io/did-method-web) | Unofficial draft authored by the [W3C Credentials Community Group](https://www.w3.org/community/credentials/). |
| did:x509 | [ttps://github.com/microsoft/did-x509](ttps://github.com/microsoft/did-x509) | DRAFT: did:x509 Decentralized Identifier Method Specification |
1 change: 1 addition & 0 deletions docs/w3c_vcdm/vcdm_about.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ sidebar_position: 6
**_TODO_**: explain where this version of the test suite comes from, where the repo is, and how it’s configured

**_TODO_**: Additional resources

* Learn more about the W3C Verifiable Credential Data Model here: XXX
* Get involved here: XXX
4 changes: 2 additions & 2 deletions docs/w3c_vcdm/vcdm_how_to_use.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ sidebar_position: 3

The purpose of this test suite is to test an issued Verifiable Credential for conformance with the VC data model 1.1 specification.

[https://dtt.dtlab-labcn.app/test-suites/credentials/w3c](https://dtt.dtlab-labcn.app/test-suites/credentials/w3c)
[https://dtt.dtlab-labcn.app/test-suites/credentials/w3c](https://dtt.dtlab-labcn.app/test-suites/credentials/w3c)

**_TODO_**: How to access / configure this test suite: availability test/prod, user account, etc.
**_TODO_**: How to access / configure this test suite: availability test/prod, user account, etc.
1 change: 0 additions & 1 deletion docs/w3c_vcdm/vcdm_input.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@ Paste a JSON-LD Credential containing a VC and click on **Submit**.
**_TODO_**: Need examples to try it out? Check out (insert links to DIF universal resolver samples and godiddy samples), We should probably provide our own examples, starting with what we use internally for unit testing)

**_FUTURE_**: options/parameters.

2 changes: 1 addition & 1 deletion docs/w3c_vcdm/vcdm_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ sidebar_position: 1

# Introduction to the W3C Verifiable Credential Data Model

The W3C Verifiable Credential Data Model provides a standard way to express credentials on the Web in a way that is cryptographically secure, privacy respecting, and machine-verifiable.
The W3C Verifiable Credential Data Model provides a standard way to express credentials on the Web in a way that is cryptographically secure, privacy respecting, and machine-verifiable.
3 changes: 1 addition & 2 deletions docs/w3c_vcdm/vcdm_results.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@ sidebar_position: 5

**_TO-DO_**: plain English overview of results, maybe in the form of a simple checklist?


## Common errors and their meaning {#common-errors-and-their-meaning}

**_TODO_**: this section may not be as relevant for VCDM testing as it is for DID testing?

## How to save and share your test results {#how-to-save-and-share-your-test-results}

**_FUTURE_**: intro to Allure report framework
**_FUTURE_**: intro to Allure report framework
2 changes: 1 addition & 1 deletion docs/w3c_vcdm/vcdm_specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ sidebar_position: 2

**_TODO_**: write brief intro with explanation for current versions and status

[Verifiable Credentials Data Model v2.0](https://www.w3.org/TR/vc-data-model-2.0/)
[Verifiable Credentials Data Model v2.0](https://www.w3.org/TR/vc-data-model-2.0/)

0 comments on commit 0f9a4b4

Please sign in to comment.