ietf-wg-gnap / gnap-core-protocol

141 stars 26 forks source link

Contradiction between the text and the example in section 3.3.3. #487

Closed blue-ringed-octopus-guy closed 1 year ago

blue-ringed-octopus-guy commented 1 year ago

This is very minor, but there's a contradiction between the user_code provided in the example in section 3.3.3. and the recommendations that are mentioned in the text above it.

The text says:

MUST consist of only easily typeable characters (such as letters or numbers)

And

It is RECOMMENDED that this code be no more than eight characters in length.

However, the example provided below it goes against these two recommendations, as it contains a special character (a hyphen) rather than just letters and numbers, and it's longer than eight characters in length:

"interact": {
    "user_code": "A1BC-3DFF"
}

I'd suggest either tweaking the wording, or tweaking the example so that the user_code provided in the example is aligned to the recommendations mentioned in the text.