- changed status to open
[IDA] typos
This is a review for “OpenID Connect for Identity Assurance 1.0”.
- Torsten’s affiliation in the “Authors” section should be changed from
yes.com
to his current organization. - “OpenID Connect provider” → “OpenID provider” (in the second paragraph in the “Introduction” section)
- “This specifications” → “This specification” (in the last “Note” in the “Introduction” section)
- The “Warning” section should be removed.
- “claim provider” → “claims provider” (twice in the first paragraph in “3.2. identity proofing”)
- “claim provider” → “claims provider” (in the first paragraph in “3.3. identity verification”)
- “claim provider” → “claims provider” (in the first paragraph in “3.4. identity assurance”)
- “eID systems” → “eID system” (at the end of the third paragraph in “4. Requirements”)
- “implementors” → “implementers” for consistency. (in the 9th paragraph in “4. Requirements”)
- “defines the a number” → “defines a number” (in the last paragraph in “4. Requirements”)
[!@IDA-verified-claims]
in the first paragrah in “5.1. Verified claims schema” is not recognized as valid markdown.- “, it can be used” → “, which can be used” or “. It can be used” (In the second paragraph in “5.3. Requesting end-user claims”)
- “the ‘country’ subclaim” → “the
country
subclaim” (in the 5th paragraph in “5.3. Requesting end-user claims”) - “the ‘address’ claim” → “the
address
claim” (in the 5th paragraph in “5.3. Requesting end-user claims”) - “or this draft” → “or this specification” (in the 5th paragraph in “5.3. Requesting end-user claims”)
- “meets the requirements” → “meet the requirements” (in the second last paragraph in “5.3. Requesting end-user claims”)
- “Where
assurance_details
have” → “Whenassurance_details
has” (in the second last paragraph in “5.3. Requesting end-user claims”) - “section 5.5.1” → “Section 5.5.1” (in the first paragraph in “5.5.2. max_age”)
- “family and given name” → “family and given names” (in the last paragraph in “5.6. Requesting claims sets with different verification requirements”)
- “section 3.3.6” → “section 3.3.3.6” (in the first paragraph in “5.7. Returning less data than requested”)
- “section 5.5” → “section 5.5.1” (in the last paragraph in “5.7. Returning less data than requested”)
- “id_token or Userinfo response” → “ID Token or UserInfo response” (in the first paragraph in “5.7.1. Unavailable data”)
- “id_token or Userinfo response” → “ID Token or UserInfo response” (in the first paragraph in “5.7.2. Non-consented data”)
- “with a
scope
" → “with ascope
value" (in the second paragraph in “5.8. Requesting sets of claims by scope”) - “end-user Claim” → “end-user claim” (in the last paragraph in “6.1. Aggregated and distributed claims assertions”)
- Append a period at the end of the 1st, 2nd, 4th and 5th bullets in the first list in “6.2. Aggregated and distributed claims validation”.
- “one or more type” → “one or more types” (in the description for
evidence_supported
in “8. OP metadata”) - “in the evidence element” → “in the
evidence
element” (fixed width font) (in the description forevidence_supported
in “8. OP metadata”) - “see section 4.2.2” → “see section 5.4.4” (in the description for
evidence_supported
in “8. OP metadata”) @!predefined_values
in the description fordocuments_methods_supported
in “8. OP metadata” is not recognized as valid markdown.- The scheme of the link to the OIDC Core spec in “13. Normative References” should be changed from
http
tohttps
. - The scheme of the link to the OpenID4IDAClaims spec in “13. Normative References” should be changed from
http
tohttps
. - The URLs to the FAPI-1-RW spec and the FAPI-2-BL spec in “14. Informative References” should be updated. Also, their release dates should be checked. For example, the “Informative References” section says that the FAPI-2-BL was released in September, 2020, but probably it is wrong.
- I'm not sure that
[[ this specification ]]
in “A.2. Media type registration” is intended or invalid markdown. - “implementors” → “implementers” (in the last paragraph in “B.1. Verification of claims by a document”)
- “Self-Issued OpenID Connect provider” → “Self-Issued OpenID provider” (in the title and the first paragraph of C.9)
- “a ID Token” → “an ID Token” (in the first paragraph of C.9)
- Torsten’s affiliation in the “Authors' Addresses” section should be changed from
yes.com
to his current organization.
Comments (10)
-
-
-
- Torsten’s affiliation in the “Authors” section should be changed from
yes.com
to his current organization. - “OpenID Connect provider” → “OpenID provider” (in the second paragraph in the “Introduction” section)
- “This specifications” → “This specification” (in the last “Note” in the “Introduction” section)
- The “Warning” section should be removed. not until it is approved by foundation wide vote
- “claim provider” → “claims provider” (twice in the first paragraph in “3.2. identity proofing”) I think we settled on singular because of ISO guidance and translation challenges of plurals
- “claim provider” → “claims provider” (in the first paragraph in “3.3. identity verification”) I think we settled on singular because of ISO guidance and translation challenges of plurals
- “claim provider” → “claims provider” (in the first paragraph in “3.4. identity assurance”) I think we settled on singular because of ISO guidance and translation challenges of plurals
- “eID systems” → “eID system” (at the end of the third paragraph in “4. Requirements”)
- “implementors” → “implementers” for consistency. (in the 9th paragraph in “4. Requirements”)
- “defines the a number” → “defines a number” (in the last paragraph in “4. Requirements”)
[!@IDA-verified-claims]
in the first paragrah in “5.1. Verified claims schema” is not recognized as valid markdown. it should be @! not !@- “, it can be used” → “, which can be used” or “. It can be used” (In the second paragraph in “5.3. Requesting end-user claims”) - I prefer “which”
- “the ‘country’ subclaim” → “the
country
subclaim” (in the 5th paragraph in “5.3. Requesting end-user claims”) - “the ‘address’ claim” → “the
address
claim” (in the 5th paragraph in “5.3. Requesting end-user claims”) - “or this draft” → “or this specification” (in the 5th paragraph in “5.3. Requesting end-user claims”)
- “meets the requirements” → “meet the requirements” (in the second last paragraph in “5.3. Requesting end-user claims”) agree with removing the plural but the text that needs to change is “fulfill the requirements”
- “Where
assurance_details
have” → “Whenassurance_details
has” (in the second last paragraph in “5.3. Requesting end-user claims”) it’s second last paragraph of 5.4 - “section 5.5.1” → “Section 5.5.1” (in the first paragraph in “5.5.2. max_age”)
- “family and given name” → “family and given names” (in the last paragraph in “5.6. Requesting claims sets with different verification requirements”) might be even more accurate if we switch it to refer to the claim names requested “family and given name” → “
family_name
andgiven_name
“ - “section 3.3.6” → “section 3.3.3.6” (in the first paragraph in “5.7. Returning less data than requested”)
- “section 5.5” → “section 5.5.1” (in the last paragraph in “5.7. Returning less data than requested”)
- “id_token or Userinfo response” → “ID Token or UserInfo response” (in the first paragraph in “5.7.1. Unavailable data”) but double check with Edmund and Nat
- “id_token or Userinfo response” → “ID Token or UserInfo response” (in the first paragraph in “5.7.2. Non-consented data”) but double check with Edmund and Nat
- “with a
scope
" → “with ascope
value" (in the second paragraph in “5.8. Requesting sets of claims by scope”) - “end-user Claim” → “end-user claim” (in the last paragraph in “6.1. Aggregated and distributed claims assertions”)
- Append a period at the end of the 1st, 2nd, 4th and 5th bullets in the first list in “6.2. Aggregated and distributed claims validation”.
- “one or more type” → “one or more types” (in the description for
evidence_supported
in “8. OP metadata”) I think we settled on singular because of ISO guidance and translation challenges of plurals - “in the evidence element” → “in the
evidence
element” (fixed width font) (in the description forevidence_supported
in “8. OP metadata”) - “see section 4.2.2” → “see section 5.4.4” (in the description for
evidence_supported
in “8. OP metadata”) @!predefined_values
in the description fordocuments_methods_supported
in “8. OP metadata” is not recognized as valid markdown. the issue is that the tag is incorrect - it should be [@!predefined_values_page]- The scheme of the link to the OIDC Core spec in “13. Normative References” should be changed from
http
tohttps
. - The scheme of the link to the OpenID4IDAClaims spec in “13. Normative References” should be changed from
http
tohttps
. - The URLs to the FAPI-1-RW spec and the FAPI-2-BL spec in “14. Informative References” should be updated. Also, their release dates should be checked. For example, the “Informative References” section says that the FAPI-2-BL was released in September, 2020, but probably it is wrong.
- I'm not sure that
[[ this specification ]]
in “A.2. Media type registration” is intended or invalid markdown. - That should be updated to refer to the location of this document once it is approved and published - maybe raise dedicated issue? - “implementors” → “implementers” (in the last paragraph in “B.1. Verification of claims by a document”)
- “Self-Issued OpenID Connect provider” → “Self-Issued OpenID provider” (in the title and the first paragraph of C.9)
- “a ID Token” → “an ID Token” (in the first paragraph of C.9)
- Torsten’s affiliation in the “Authors' Addresses” section should be changed from
yes.com
to his current organization.
- Torsten’s affiliation in the “Authors” section should be changed from
-
-
assigned issue to
-
assigned issue to
-
I added a specific to “finalization tasks” https://bitbucket.org/openid/ekyc-ida/issues/1407/ida-final-tasks to cover the “this specification” referencing in Media Type Registration section
-
I think we should address the “FAPI 1 RW” reference as a separate item - since this ref was written into this draft spec FAPI has gone to final and we should reference either:
Financial-grade API Security Profile (FAPI) 1.0 – Part 1: Baseline
or
Financial-grade API Security Profile (FAPI) 1.0 – Part 2: Advanced
** update - @Joseph has recommended that we ref Part2:Advanced - no need to separate the task after all.
-
for the FAPI2 reference it should be: FAPI 2.0 Security Profile
-
Let me add some more:
- “Note: it is not possible to request sub-claims ….” should start with a new line (Section 5.3)
- “fulfil”-> “fulfill” UK vs US English (Section 5.6: the OP delivers the claim in as many verified claims response objects it can fulfil.)
- No definition of “AS” in Introduction (as with OP and RP) (Section 5.2, Section 6.1)
- “JSON web tokens” should be capitalized as this is a spec name (Section 10)
- Authors names should be written when citing FAPI (Section 14)
-
Being addressed by PR#208
-
- changed status to resolved
Resolved by PR208
- Log in to comment