diff --git a/api/readme.md b/api/readme.md
index 7f3951e..f6c7bce 100644
--- a/api/readme.md
+++ b/api/readme.md
@@ -5,9 +5,9 @@
In the `./api` folder, run:
```
-npx @redocly/cli build-docs toip-tswg-trustregistryprotocol-v2.yaml --output ../spec/api/redoc-static.html
+npx @redocly/cli build-docs toip-tswg-trustregistryprotocol-v2.yaml --output ../docs/api/redoc-static.html
```
-NOTE: the `--output` switch is required as SpecUp only takes content from the `./spec` folder (and below).
+NOTE: the `--output` switch is required as SpecUp only takes content from the `./docs` folder (and below).
That produces the [Redoc Rendered OpenAPI Spec](redoc-static.html)
\ No newline at end of file
diff --git a/diagrams/highlevel.plantuml b/diagrams/highlevel.plantuml
index aab855f..58dcd9d 100644
--- a/diagrams/highlevel.plantuml
+++ b/diagrams/highlevel.plantuml
@@ -2,7 +2,7 @@
-title Trust Over IP Trust Registry Protocol v2 Early Exploration
+title Trust Over IP Trust Registry Protocol v2 Data Model - Implementer Review Draft
package EGF {
diff --git a/diagrams/protocol-bridging.plantuml b/diagrams/protocol-bridging.plantuml
index 0c8db80..1532883 100644
--- a/diagrams/protocol-bridging.plantuml
+++ b/diagrams/protocol-bridging.plantuml
@@ -4,7 +4,7 @@
' !include C4_Context.puml
-title Native and Bridged Support for TRP
+title Native and Bridged Support for TRP - Implementer Review Draft
Person(Integrator, "Integrator", "Ecosystem Developer")
diff --git a/docs/api.html b/docs/api.html
deleted file mode 100644
index 9673fc7..0000000
--- a/docs/api.html
+++ /dev/null
@@ -1,1332 +0,0 @@
-
-
-
- ToIP Trust Registry Protocol v2
-
-
-
- ToIP Trust Registry Protocol v2
- Trust Registry capabilities
-
-- Allow querying for critical items in a digital trust ecosystem:
-Entities, Registries, and Resources that are required to operate
-in the ecosysystem.
-
-
Registry of Registries (RoR) capabilities.
-
RoR capabilities include:
-
-- Listing Registries that are known (to the registry being queried).
-- list the acknowledged trust registries that the RoR recognizes and what
-that may mean in the context of a particular governance framework.
-
-
-
-
- Version: 0.2.0
- BasePath:/darrellodonnell/ToIP.TrustRegistry/0.1.0
- Apache 2.0
- http://www.apache.org/licenses/LICENSE-2.0.html
- Access
-
-
-
-
-
- [ Jump to Models ]
-
- Table of Contents
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Up
-
get /lookup/assurancelevels
-
Get a list of the assurance levels that are in use by this Trust Registry (and its governing EGF). (lookupAssurancelevelsGet)
-
-
-
-
-
-
-
Query parameters
-
-
egfURI (required)
-
-
Query Parameter — The URI-based identifier of the Ecosystem Governance Framework that the assurance levels apply to. Allows reserved characters per RFC3986.
-Do <strong>NOT</strong> escape the URI.
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
[ {
- "identifier" : "did:example:123",
- "name" : "LOA2",
- "description" : "Level of Assurance 2 - see EGF for definition, terms, obligations, liabilities, and indemnity"
-}, {
- "identifier" : "did:example:123",
- "name" : "LOA2",
- "description" : "Level of Assurance 2 - see EGF for definition, terms, obligations, liabilities, and indemnity"
-} ]
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
AssuranceLevelListType
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
Up
-
get /lookup/authorizations
-
Get a list of Rights that are used in this Trust Registry. (lookupAuthorizationsGet)
-
-
-
-
-
-
-
Query parameters
-
-
egfURI (required)
-
-
Query Parameter — The URI-based identifier of a DID or X.509 Issuer. Allows reserved characters per RFC3986.
-Do <strong>NOT</strong> escape the URI.
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
[ {
- "identifier" : "did:example:abc",
- "simplename" : "country:role"
-}, {
- "identifier" : "did:example:abcd",
- "simplename" : "canada:professional:engineer"
-} ]
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
AuthorizationListType
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
Up
-
get /lookup/namespaces
-
Get the namespaces that are supported in this trust Registry. (lookupNamespacesGet)
-
-
-
-
-
-
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
[ {
- "identifier" : "did:example:123",
- "description" : "description",
- "canonicalString" : "[\"ca.issuer.driverlicense\",\"mining.tsm\"]",
- "egfURI" : "[\"did:example:GlobalDriverLicenseDID\"]"
-}, {
- "identifier" : "did:example:123",
- "description" : "description",
- "canonicalString" : "[\"ca.issuer.driverlicense\",\"mining.tsm\"]",
- "egfURI" : "[\"did:example:GlobalDriverLicenseDID\"]"
-} ]
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
NamespaceListType
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
Up
-
get /lookup/vidmethods
-
Get a list of DID Methods that are supported by a particular Governance Framework. (lookupVidmethodsGet)
-
-
-
-
-
-
-
Query parameters
-
-
egfURI (required)
-
-
Query Parameter — Provides a list of DID-methods that are supported by this trust registry. MAY include Maximum Assurance Level
-that a DID Method is set at under the EGF.
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
[ {
- "identifier" : "identifier",
- "maximumAssuranceLevel" : {
- "identifier" : "did:example:123",
- "name" : "LOA2",
- "description" : "Level of Assurance 2 - see EGF for definition, terms, obligations, liabilities, and indemnity"
- }
-}, {
- "identifier" : "identifier",
- "maximumAssuranceLevel" : {
- "identifier" : "did:example:123",
- "name" : "LOA2",
- "description" : "Level of Assurance 2 - see EGF for definition, terms, obligations, liabilities, and indemnity"
- }
-} ]
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
VIDMethodListType
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
-
Provides metadata object. (metadataGet)
-
Metadata object.
-
-
-
-
-
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
{
- "languages" : [ "en", "en-CA", "fr-CA" ],
- "lastupdated" : "2000-01-23T04:56:07.000+00:00"
-}
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
MetadataType
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
-
Up
-
get /offline/exportfile
-
Access a full data file that can be used offline. (getOfflineFile)
-
Allows querying to determine the status of an Issuer, as identified by their Identifier (unique),
-credential type, and EGF that they are operating under.
-
-
-
-
-
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
{
- "extractdatetime" : "2000-01-23T04:56:07.000+00:00",
- "lookups" : {
- "Namespaces" : [ {
- "identifier" : "did:example:123",
- "description" : "description",
- "canonicalString" : "[\"ca.issuer.driverlicense\",\"mining.tsm\"]",
- "egfURI" : "[\"did:example:GlobalDriverLicenseDID\"]"
- }, {
- "identifier" : "did:example:123",
- "description" : "description",
- "canonicalString" : "[\"ca.issuer.driverlicense\",\"mining.tsm\"]",
- "egfURI" : "[\"did:example:GlobalDriverLicenseDID\"]"
- } ],
- "Authorizations" : [ {
- "identifier" : "did:example:abc",
- "simplename" : "country:role"
- }, {
- "identifier" : "did:example:abcd",
- "simplename" : "canada:professional:engineer"
- } ],
- "AssuranceLevels" : [ {
- "identifier" : "did:example:123",
- "name" : "LOA2",
- "description" : "Level of Assurance 2 - see EGF for definition, terms, obligations, liabilities, and indemnity"
- }, {
- "identifier" : "did:example:123",
- "name" : "LOA2",
- "description" : "Level of Assurance 2 - see EGF for definition, terms, obligations, liabilities, and indemnity"
- } ],
- "VIDMethods" : [ {
- "identifier" : "identifier",
- "maximumAssuranceLevel" : {
- "identifier" : "did:example:123",
- "name" : "LOA2",
- "description" : "Level of Assurance 2 - see EGF for definition, terms, obligations, liabilities, and indemnity"
- }
- }, {
- "identifier" : "identifier",
- "maximumAssuranceLevel" : {
- "identifier" : "did:example:123",
- "name" : "LOA2",
- "description" : "Level of Assurance 2 - see EGF for definition, terms, obligations, liabilities, and indemnity"
- }
- } ]
- },
- "entities" : [ {
- "identifier" : "did:example:123",
- "authorizations" : [ {
- "identifier" : "did:example:abc",
- "simplename" : "country:role"
- }, {
- "identifier" : "did:example:abcd",
- "simplename" : "canada:professional:engineer"
- } ],
- "statusDetail" : "statusDetail",
- "validity" : {
- "validFromDT" : "2000-01-23T04:56:07.000+00:00",
- "validUntilDT" : "2000-01-23T04:56:07.000+00:00"
- },
- "governanceFrameworkVID" : "did:example:456",
- "DIDDocument" : "DIDDocument",
- "status" : "current"
- }, {
- "identifier" : "did:example:123",
- "authorizations" : [ {
- "identifier" : "did:example:abc",
- "simplename" : "country:role"
- }, {
- "identifier" : "did:example:abcd",
- "simplename" : "canada:professional:engineer"
- } ],
- "statusDetail" : "statusDetail",
- "validity" : {
- "validFromDT" : "2000-01-23T04:56:07.000+00:00",
- "validUntilDT" : "2000-01-23T04:56:07.000+00:00"
- },
- "governanceFrameworkVID" : "did:example:456",
- "DIDDocument" : "DIDDocument",
- "status" : "current"
- } ],
- "validity" : {
- "validFromDT" : "2000-01-23T04:56:07.000+00:00",
- "validUntilDT" : "2000-01-23T04:56:07.000+00:00"
- },
- "registries" : [ {
- "identifier" : "did:example:123",
- "name" : "Professional Engineers Ontario",
- "description" : "Established on June 14, 1922, Professional Engineers Ontario (PEO) is the licensing and regulating body for professional engineering in the province.",
- "peerType" : "peer"
- }, {
- "identifier" : "did:example:123",
- "name" : "Professional Engineers Ontario",
- "description" : "Established on June 14, 1922, Professional Engineers Ontario (PEO) is the licensing and regulating body for professional engineering in the province.",
- "peerType" : "peer"
- } ],
- "version" : "version"
-}
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
-
-
Responses
-
200
- JSON file array of offline list of Issuers
-
ExportFile
-
-
-
-
-
Up
-
get /offline/trustestablishmentdocument
-
Access a full data file that can be used offline. (getTED)
-
Allows querying to determine the status of an Issuer, as identified by their Identifier (unique),
-credential type, and EGF that they are operating under.
-
-
-
-
-
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
{
- "TBD" : "TBD"
-}
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- JSON file array of offline list of Issuers
-
TrustEstablishmentDocument
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
-
Up
-
get /entities/{entityVID}/authorizations
-
Determine whether an Entity has a particular Authorization. (entitiesEntityVIDAuthorizationsGet)
-
-
-
Path parameters
-
-
entityVID (required)
-
-
Path Parameter — The VID-based identifier of a VID/DID/AID or X.509 Issuer. Allows reserved characters per RFC3986.
-Do <strong>NOT</strong> escape the URI.
-
-
-
-
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
[ {
- "identifier" : "did:example:abc",
- "simplename" : "country:role"
-}, {
- "identifier" : "did:example:abcd",
- "simplename" : "canada:professional:engineer"
-} ]
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
AuthorizationListType
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
Up
-
get /entitities/{entityid}
-
Returns Registry Information about a particular entity that is represented in the queried system. (entititiesEntityidGet)
-
-
-
Path parameters
-
-
entityid (required)
-
-
Path Parameter — The URI-based identifier of a DID or X.509 Issuer. Allows reserved characters per RFC3986.
-Do <strong>NOT</strong> escape the URI.
-
-
-
-
-
Query parameters
-
-
authorization (optional)
-
-
Query Parameter — The identifier of the Authorization that is being queried for this Entity.
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
{
- "identifier" : "did:example:123",
- "authorizations" : [ {
- "identifier" : "did:example:abc",
- "simplename" : "country:role"
- }, {
- "identifier" : "did:example:abcd",
- "simplename" : "canada:professional:engineer"
- } ],
- "statusDetail" : "statusDetail",
- "validity" : {
- "validFromDT" : "2000-01-23T04:56:07.000+00:00",
- "validUntilDT" : "2000-01-23T04:56:07.000+00:00"
- },
- "governanceFrameworkVID" : "did:example:456",
- "DIDDocument" : "DIDDocument",
- "status" : "current"
-}
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
EntityType
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
Up
-
get /registries/recognized-registries
-
Query this Trust Registry about its recognition of another Trust Registry. (registriesRecognizedRegistriesGet)
-
-
-
-
-
-
-
Query parameters
-
-
namespace-VID (optional)
-
-
Query Parameter — Filter in only the namespace requested - show all registries otherwise. The URI-based Verifiable Identifier (VID) (e.g. DID or X.509 VID). Allows reserved characters per RFC3986.
-Do <strong>NOT</strong> escape the URI.
EGF-VID (optional)
-
-
Query Parameter — Filter in only the registries under the specified EGF (by EGF DID). Defaults to be limited to the EGFURI that is being queried at the root.
-The URI-based Verifiable Identifier (VID) (e.g. DID or X.509 VID). Allows reserved characters per RFC3986.
-Do <strong>NOT</strong> escape the URI.
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
[ {
- "identifier" : "did:example:123",
- "name" : "Professional Engineers Ontario",
- "description" : "Established on June 14, 1922, Professional Engineers Ontario (PEO) is the licensing and regulating body for professional engineering in the province.",
- "peerType" : "peer"
-}, {
- "identifier" : "did:example:123",
- "name" : "Professional Engineers Ontario",
- "description" : "Established on June 14, 1922, Professional Engineers Ontario (PEO) is the licensing and regulating body for professional engineering in the province.",
- "peerType" : "peer"
-} ]
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
RegistryListType
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
Up
-
get /registries/{registryVID}/
-
Get resource data indicated by DID. (registriesRegistryVIDGet)
-
-
-
Path parameters
-
-
registryVID (required)
-
-
Path Parameter — The URI-based identifier of a DID or X.509 Issuer. Allows reserved characters per RFC3986.
-Do <strong>NOT</strong> escape the URI.
-
-
-
-
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
""
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
inline_response_200
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
-
Up
-
get /registries/{registryVID}/recognized-registries/
-
Query this Trust Registry about its recognition of a specific Trust Registry.
-TODO: determine RoR (registry of registry) impacts here. (registriesRegistryVIDRecognizedRegistriesGet)
-
-
-
Path parameters
-
-
registryVID (required)
-
-
Path Parameter — The URI-based identifier of a DID or X.509 Issuer. Allows reserved characters per RFC3986.
-Do <strong>NOT</strong> escape the URI.
-
-
-
-
-
-
-
Return type
-
-
-
-
-
Example data
-
Content-Type: application/json
-
[ {
- "identifier" : "did:example:123",
- "name" : "Professional Engineers Ontario",
- "description" : "Established on June 14, 1922, Professional Engineers Ontario (PEO) is the licensing and regulating body for professional engineering in the province.",
- "peerType" : "peer"
-}, {
- "identifier" : "did:example:123",
- "name" : "Professional Engineers Ontario",
- "description" : "Established on June 14, 1922, Professional Engineers Ontario (PEO) is the licensing and regulating body for professional engineering in the province.",
- "peerType" : "peer"
-} ]
-
-
Produces
- This API call produces the following media types according to the request header;
- the media type will be conveyed by the response header.
-
- application/json
- application/problem+json
-
-
-
Responses
-
200
- search results matching criteria
-
RegistryListType
-
400
- Bad Request
-
ProblemDetails
-
401
- Unauthorized
-
ProblemDetails
-
404
- Not Found
-
ProblemDetails
-
-
-
-
- [ Jump to Methods ]
-
- Table of Contents
-
- AssuranceLevelListType
- AssuranceLevelType
- AuthorizationListType
- AuthorizationType
- EntityListType
- EntityType
- ExportFile
- ExportLookups
- IntegrityType
- MetadataType
- NamespaceListType
- NamespaceType
- PLACEHOLDER-REMOVE-SOON
- ProblemDetails
- RegistryListType
- RegistryType
- ResourceDirectType
- ResourceReferencedType
- TrustEstablishmentDocument
- Uri
- VID
- VIDMethodListType
- VIDMethodType
- ValidityDatesType
- inline_response_200
-
-
-
-
-
-
Creates assurance level as a top-level/first-class-citizen of a Trust Registry. AssuranceLevel values
-MUST be defined in an EGF if they are used.
-
-
identifier
-
example: did:example:123
-
name
-
example: LOA2
-
description
-
example: Level of Assurance 2 - see EGF for definition, terms, obligations, liabilities, and indemnity
-
-
-
-
-
-
-
-
identifier
-
example: did:example:123
-
simplename
-
description
-
assuranceLevel (optional)
-
-
-
-
-
-
-
-
identifier
-
example: did:example:123
-
authorizations (optional)
-
governanceFrameworkVID (optional)
-
example: did:example:456
-
DIDDocument (optional)
String (TODO: REMOVE? redundant and confusing)Provides a URI that resolves to the DID Document for the Identifier. format: URI
-
validity (optional)
-
status
String <p>Provides a current status for entity (issuer or verifier)</p>
-<ul>
-<li>current - the entity is currently authorized, as of time of the query.</li>
-<li>expired - entity rights have expired.</li>
-<li>terminated - entity has voluntarily ceased Issuer role under the specific EGF.</li>
-<li>revoked - entity authority under specific EGF was terminated by the governing authority.</li>
-</ul>
-
-
-
current
expired
terminated
revoked
-
statusDetail (optional)
String Optional free text that expands on the status parameter.
-
-
-
-
-
-
-
extractdatetime
Date The time of the data extraction. format: date-time
-
version (optional)
String Version string [OPTIONAL]
-
validity (optional)
-
lookups (optional)
-
registries (optional)
-
entities (optional)
-
resources (optional)
-
-
-
-
-
-
-
VIDMethods (optional)
-
AssuranceLevels (optional)
-
Authorizations (optional)
-
Namespaces (optional)
-
-
-
-
-
Integrity object
-
-
hashtype
String Hashing algorithm well-known-name. TODO: Reference to some list?
-
example: sha-256
-
hash
-
example: 64ee532ac8a4871e21ccf0397ac8154efb747ec37a2a116c35fc8b810cbf24bd
-
-
-
-
-
-
-
lastupdated
-
languages (optional)
array[String] language codes (RFC 4646 - https://datatracker.ietf.org/doc/html/rfc4646)
-
example: ["en","en-CA","fr-CA"]
-
-
-
-
-
-
Namespace object - formal name, EGF that governs namespace, VC/DIDAuth/etc.
-
-
identifier
-
example: did:example:123
-
canonicalString
-
example: ["ca.issuer.driverlicense","mining.tsm"]
-
egfURI (optional)
String URI of the EGF that defines the namespace.
-
example: ["did:example:GlobalDriverLicenseDID"]
-
description (optional)
-
-
-
-
-
-
A Problem Details object (RFC 7807)
-
-
type (optional)
String An absolute URI that identifies the problem type format: uri
-
title (optional)
String A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).
-
example: Service Unavailable
-
status (optional)
Integer The HTTP status code generated by the origin server for this occurrence of the problem. format: int32
-
detail (optional)
String A human-readable explanation specific to this occurrence of the problem
-
instance (optional)
String An absolute URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. format: uri
-
-
-
-
-
Array of RegistryQueryType
-
-
-
-
-
-
Data structure for basic Trust Registry indication of what the queried TR will state about another TR.
-
-
identifier
-
example: did:example:123
-
name
-
example: Professional Engineers Ontario
-
description (optional)
-
example: Established on June 14, 1922, Professional Engineers Ontario (PEO) is the licensing and regulating body for professional engineering in the province.
-
peerType (optional)
String <p>Relationship types - how does the TR that is being queried consider the other TR.</p>
-<ul>
-<li>peer - registy is recognized as a peer under another jurisdiction or governance mechanism.</li>
-<li>superior - registry is above this TR in a hierarchy.</li>
-<li>subordinate - registry is subordinate to this TR in a hierarchy.</li>
-<li>metaregistry - registry being queried is considered (by this TR) to be a metaregistry (aka registry of registries)</li>
-</ul>
-
-
-
peer
superior
subordinate
metaregistry
-
-
-
-
-
Resource that is served directly by this trust registry.
-
-
identifier
-
example: did:example:123
-
lastupdated
-
datatype
String TODO: DECIDE about mimeType vs. dataType as property name
-The <code>kind</code> of resource (e.g. credential-definition, schema-definition, revocation-registry). intended
-to be used by recipient for processing of the data payload.
-
resourceURI (optional)
-
payloadJSON (optional)
-
-
-
-
-
Resource that is provided by reference to a different source.
-
-
identifier
-
example: did:example:123
-
lastupdated
-
datatype
String TODO: DECIDE about mimeType vs. dataType as property name
-The <code>kind</code> of resource (e.g. credential-definition, schema-definition, revocation-registry). intended
-to be used by recipient for processing of the data payload.
-
resourceURI
-
integrity (optional)
-
-
-
-
-
Trust Establishment Document per https://identity.foundation/trust-establishment/
-
-
-
-
-
string providing an URI formatted according to IETF RFC 3986.
-
-
-
-
-
-
string providing an URI formatted according to IETF RFC 3986.
-
-
-
-
-
-
-
DID Method supported by the trust registry. May include the maximum
-
-
identifier
String as "maintained" at https://w3c.github.io/did-spec-registries/#did-methods TODO: do better...
-
maximumAssuranceLevel (optional)
-
-
-
-
-
Date and Time of validity.
-
-
validFromDT (optional)
Date Indicates that the Identifier status applies at the indicated time. A time in the past indicates when the last status change was recorded in the Trust Registry. format: date-time
-
validUntilDT (optional)
Date Indicates the validity ends/ended at this date and time. A time in the past may indicate that the data have expired. format: date-time
-
-
-
-
-
diff --git a/spec/api/redoc-static.html b/docs/api/redoc-static.html
similarity index 100%
rename from spec/api/redoc-static.html
rename to docs/api/redoc-static.html
diff --git a/docs/images/puml/highlevel.png b/docs/images/puml/highlevel.png
index 0b5ad03..db89b21 100644
Binary files a/docs/images/puml/highlevel.png and b/docs/images/puml/highlevel.png differ
diff --git a/docs/images/puml/protocol-bridging.png b/docs/images/puml/protocol-bridging.png
index bf8c596..4340ce0 100644
Binary files a/docs/images/puml/protocol-bridging.png and b/docs/images/puml/protocol-bridging.png differ
diff --git a/spec/annex.md b/spec/annex.md
index ed59e56..e78e3c9 100644
--- a/spec/annex.md
+++ b/spec/annex.md
@@ -37,7 +37,7 @@ It is provided as an Open API Specification v3 YAML file.
There are several renderings of the OAS specification:
-* Inline - this rendering is managed in this repository [Redoc Rendering (static HTML) of specification](../api/redoc-static.html)
+* Inline - this rendering is managed in this repository [Redoc Rendering (static HTML) of specification](./api/redoc-static.html)
* SwaggerHub - this rendering is manually updated from time to time and may be out of date: [SwaggerHub](https://app.swaggerhub.com/apis/CULedger/CULedger.Identity/0.3.1-oas3.1)
diff --git a/spec/header.md b/spec/header.md
index 81b90b5..e9d23a8 100644
--- a/spec/header.md
+++ b/spec/header.md
@@ -42,7 +42,7 @@ The following links will be helpful for editors and reviewers during the DRAFT s
* Source Code - [https://github.com/trustoverip/tswg-trust-registry-protocol](https://github.com/trustoverip/tswg-trust-registry-protocol)
* Rendered Specification (github.io Pages) - [https://trustoverip.github.io/tswg-trust-registry-protocol/](https://trustoverip.github.io/tswg-trust-registry-protocol/)
* Browseable (SwaggerHub) API - [https://app.swaggerhub.com/apis/continuumloop/trust-over_ip_trust_registry_protocol_res_tful_api_v_2/2.0.alpha-oas3.1](https://app.swaggerhub.com/apis/continuumloop/trust-over_ip_trust_registry_protocol_res_tful_api_v_2/2.0.alpha-oas3.1) - note there is no endpoint responding.
-* Inline (Redocs) API Browser -
+* Inline (Redocs) API Browser - [Redoc Rendering (static HTML) of specification](./api/redoc-static.html)
### Editors
diff --git a/spec/images/puml/highlevel.png b/spec/images/puml/highlevel.png
deleted file mode 100644
index ace793a..0000000
Binary files a/spec/images/puml/highlevel.png and /dev/null differ
diff --git a/spec/images/puml/protocol-bridging.png b/spec/images/puml/protocol-bridging.png
deleted file mode 100644
index bf8c596..0000000
Binary files a/spec/images/puml/protocol-bridging.png and /dev/null differ