Document restructure
Suggestion from Dima and others that the current draft of OIDC4IDA is a difficult read for some implementers and that breaking it into 2 or more parts would be beneficial.
There is also a specific ask from implementers in the VC domain that the verification
element and underlying schema would be very useful outside an OpenID connect implementation and so a separate document covering the structure and content of that element would be much easier to reference.
Comments (10)
-
reporter -
reporter I wonder if we should break this into discrete tasks so that we can diuscuss the merits of each and attend tom them independently perhaps:
- Split out Section 11 “Transaction-Specific Purpose” into separate draft
- Split out 5.1.2 “Attachments” into separate draft
- Split out 5. “Representing Verified Claims” structure and semantics into separate draft (although without “verified_claims delivery”
-
reporter As a visual aid for what we are planning see this picture…
-
reporter Expanding on this to propose the following documents are split out from openid-connect-4-identity-assurance.md:
- “Additional Claims” - Currently section 4.1
- “verified_claims” schema definition - Currently section 5 (except for 5.1.2 and 5.3)
- “Attachments” - Currently section 5.1.2
- “txn” claim - Currently section 4.2
- “Transaction Specific Purpose” - Currently section 11
There may be more that could be separated but I can’t see further obvious candidates at this point.
Propose separate PR fro each document split out from existing openid-connect-4-identity-assurance.md
PR #165 is created for “Additional Claims” separation
Key actions identified for separating sections of the document are
- Creating separate document with all appropriate headers, footers etc
- Creating new reference in remaining IDA spec to new document
- Add new document to pipeline
-
reporter - changed status to open
-
reporter - changed milestone to IDA Final
-
reporter Updated documentation map
-
reporter proposal to move to final with:
- "OpenID Connect for Identity Assurance 1.0" - openid-connect-4-identity-assurance.md
- "OpenID Identity Assurance schema definition 1.0 draft" - openid-ida-verified-claims.md
- "OpenID Connect for Identity Assurance Claims Registration 1.0 draft" - openid-connect-4-ida-claims.md
then move forward with final for:
- "OpenID Attachments 1.0 draft" - openid-connect-4-ida-attachments.md
- the new ‘txn’ document
- the new ‘purpose’ document
-
I used this picture to explain to Japanese works (OIDF-J KYC WG) about this restructure. This change was generally well-received. There were also comments that it would make it easier to use for enterprise (i.e. Authority) purposes.
-
reporter - changed status to resolved
All proposals contained have been done
- Log in to comment
Initial proposal is being done in the restructure branch