W3C home > Mailing lists > Public > public-webauthn@w3.org > November 2018

[webauthn] Merged Pull Request: Add the word "OPTIONAL" to `userVerification` field to match surrounding style.

From: Emil Lundberg via GitHub <sysbot+gh@w3.org>
Date: Wed, 28 Nov 2018 18:20:23 +0000
To: public-webauthn@w3.org
Message-ID: <pull_request.closed-220588901-1543429222-sysbot+gh@w3.org>
emlun has just merged lgarron's pull request 1094 for https://github.com/w3c/webauthn:

== Add the word "OPTIONAL" to `userVerification` field to match surrounding style. ==
Previously, `userVerification` was the only optional field of `PublicKeyCredentialRequestOptions` that didn't include the word "OPTIONAL" in the bullet descriptions, which can suggest at first glance that this field is not optional like the other optional ones. Adding the word is simple, and should avoid potential confusion.

https://github.com/DefinitelyTyped/DefinitelyTyped/pull/29463 is a case where types based on this doc had this optional field as required (along with `rpId`). I don't know if that was a mistake or simply outdated, but the inconsistency in the word "OPTIONAL" made this a bit confusing to check at first.


<!--
    This comment and the below content is programatically generated.
    You may add a comma-separated list of anchors you'd like a
    direct link to below (e.g. #idl-serializers, #idl-sequence):

    Don't remove this comment or modify anything below this line.
    If you don't want a preview generated for this pull request,
    just replace the whole of this comment's content by "no preview"
    and remove what's below.
-->
***
<a href="https://pr-preview.s3.amazonaws.com/lgarron/webauthn/pull/1094.html" title="Last updated on Oct 5, 2018, 5:26 AM GMT (0225a13)">Preview</a> | <a href="https://pr-preview.s3.amazonaws.com/w3c/webauthn/1094/2056fee...lgarron:0225a13.html" title="Last updated on Oct 5, 2018, 5:26 AM GMT (0225a13)">Diff</a>

See https://github.com/w3c/webauthn/pull/1094
Received on Wednesday, 28 November 2018 18:20:25 UTC

This archive was generated by hypermail 2.4.0 : Tuesday, 5 July 2022 07:26:35 UTC