Skip to content

Commit

Permalink
Merge pull request #25 from darrellodonnell/main
Browse files Browse the repository at this point in the history
implementers review
  • Loading branch information
darrellodonnell authored Apr 3, 2024
2 parents 59ee867 + 4789dc0 commit 7523f90
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 22 deletions.
15 changes: 7 additions & 8 deletions spec/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,22 @@
:--- | :--------------
[**Document Type**](https://wiki.trustoverip.org/display/HOME/ToIP+Deliverable+Types%2C+Stages%2C+and+Processes) | *Specification*
**Document Status** | *Draft*
**Document Purpose** | *Working Draft*
**Document Purpose** | *Implementers Draft*


::: todo
Shift `Document Purpose` to Implementer Review Draft before going to Implementer Review.
:::

**Note to Implementers and Reviewers**

The intent of this Implementers Review Draft Deliverable is to drive input for the specification. Comments are appreciated and encouraged. During the Implementers Review period (TODO: list dates) feedback may be dispositioned rapidly.
The intent of this Implementers Review Draft Deliverable is to drive input for the specification. Comments are appreciated and encouraged. During the Implementers Review period (2024-04-03 to 2024-06-03) feedback may be dispositioned rapidly.

Provide input via:
* [GitHub Issues](https://github.com/trustoverip/tswg-trust-registry-protocol/issues) - for items that need to be tracked. These will be formally dispositioned.
* [GitHub Discussions](https://github.com/trustoverip/tswg-trust-registry-protocol/discussions) - for items that are more discussion level.

::: todo
TODO: complete this preamble. @darrellodonnell
:::
This protocol is currently focused on read-only operations.




**Source/Resources:**

Expand Down
3 changes: 0 additions & 3 deletions spec/normative_references.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@

* [ToIP Governance Architecture Specification](https://wiki.trustoverip.org/pages/viewpage.action?pageId=71241)

::: todo
Finish up alignging with `spec-up` spec linkging
:::

[[spec-norm]]

Expand Down
23 changes: 12 additions & 11 deletions spec/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,10 @@ Add normative ref to [ToIP Governance Architecture Specification](https://wiki.t
:::

* [GA-4] MUST publish, in the [[xref: TOIP, DID document]] associated with the **DID** identifying its **EGF**, a [[ref: service property]] specifying the [[ref: service endpoint]] for its [[ref: primary trust registry]] that meets the requirements in the _[Trust Registry Service Property](#trust-registry-service-property)_ section.
[GA-5] MUST publish in its EGF a list of any other EGFs governing [[ref: secondary trust registries]].
[GA-6] MUST specify in the EGF any additional requirements for an [[ref: authorized trust registry]]. This data will be comprised of the following elements::

* [GA-5] MUST publish in its EGF a list of any other EGFs governing [[ref: secondary trust registries]].

* [GA-6] MUST specify in the EGF any additional requirements for an [[ref: authorized trust registry]]. This data will be comprised of the following elements::

* [GA-6-1] SHOULD provide Information Trust requirements.
* [GA-6-2] SHOULD provide Technical requirements.
Expand All @@ -61,7 +63,7 @@ Add normative ref to [ToIP Governance Architecture Specification](https://wiki.t
- [GA-7-1] MUST provide all [[ref: authorization]] values that are used by the trust registry.
- [GA-7-2] MUST provide all [[xref: TOIP, assurance levels]], specified with unique names, that are service by the trust registry, and what [[ref: authorization]] values they apply to.
- [GA-7-3] MUST provide a list of all [[ref: VID Types]] that are supported by the ecosystem, and serviced by the trust registry.
- [GA-7-4] SHOULD provide `resources (TODO: TERM IS VAGUE)` that are required by systems integrating into the ecosystem that the system serves.
- [GA-7-4] SHOULD provide `resources` (e.g. logo files, documents, interoperability profile information) that are required by systems integrating into the ecosystem that the system serves.
- [GA-7-5] `???any metadata required by implementors (e.g. claim name that is mandatory if pointing a credential back to an EGF.) [this is a weak example]???`
- [GA-7-6] `???a statement about the basis the trust registry claims to be authoritative???`
- [GA-7-7] `???means by which others are able to verify the asserted authority???`
Expand Down Expand Up @@ -134,12 +136,9 @@ The authoritative technical specifications for the API calls in the ToIP Trust R
- ii. [TRP-3-2] **Recognized Registry:** Given the entityDID the system SHOULD return the list of [[def:trust registries]] that the entity has indicated it is registered in.
- [TRP-3-2-1] The system MUST NOT return more than one trust registry in the array designated as a [[def: primary registry]].

::: todo
CREATE TrustRegistryType and TrustRegistryListType in OAS.
:::

::: TODO:
Align VID or DID terminology.
Align VID and/or DID terminology.
:::

[TRP-4] MUST return responses using the data model specified in the OpenAPI Specification .
Expand All @@ -162,12 +161,14 @@ The authoritative technical specifications for the API calls in the ToIP Trust R

### Anti-Requirements

[AR-1] SHALL NOT support query operations for the history of a [[ref: registered entity]].
The following are considered anti-requirements in that they have been considered in the current design of the TRP:

* [AR-1] SHALL NOT support query operations for the history of a [[ref: registered entity]].

[AR-2] SHALL NOT include support for a DIDComm interface, only a RESTful (i.e. OpenAPI Specification) interface. When a repeatable **trust task** specification approach is created, a DIDComm/**trust task** approach should be considered as a work effort.
* [AR-2] SHALL NOT include support for a DIDComm interface, only a RESTful (i.e. OpenAPI Specification) interface. When a repeatable **trust task** specification approach is created, a DIDComm/**trust task** approach should be considered as a work effort.

[AR-3]]SHALL NOT support automated rules processing in the protocol. A rules engine can certainly use the protocol.
* [AR-3]]SHALL NOT support automated rules processing in the protocol. A rules engine can certainly use the protocol.

[AR-4] Anything other than read-only operations. The TRP is a read-only (RETRIEVE in the CRUD sense) protocol.
* [AR-4] Anything other than read-only operations. The TRP is a read-only (RETRIEVE in the CRUD sense) protocol.


0 comments on commit 7523f90

Please sign in to comment.