Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Webauthn: getClientExtensionResults() returns a AuthenticationExtensionsClientOutputs, not a Map #36673

Open
Le0Developer opened this issue Nov 6, 2024 · 1 comment
Labels
area: WebAuthn Content:WebAPI Web API docs help wanted If you know something about this topic, we would love your help!

Comments

@Le0Developer
Copy link

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredential/getClientExtensionResults

What specific section or headline is this issue about?

No response

What information was incorrect, unhelpful, or incomplete?

The documentation incorrectly states a map is returned. However as per webauthn spec, it returns a AuthenticationExtensionsClientOutputs. Documentation for that return type is additionally completely absent.

What did you expect to see?

A link to AuthenticationExtensionsClientOutputs which documents the possible extensions.

Do you have any supporting links, references, or citations?

https://w3c.github.io/webauthn/#idl-index

https://w3c.github.io/webauthn/#iface-authentication-extensions-client-outputs

Do you have anything more you want to share?

No response

MDN metadata

Page report details
@Le0Developer Le0Developer added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Nov 6, 2024
@github-actions github-actions bot added Content:WebAPI Web API docs and removed Content:WebAPI Web API docs labels Nov 6, 2024
@Josh-Cena
Copy link
Member

It looks like the author confused the WebIDL "ordered map" with an actual JS map. We don't document dictionaries so we won't mention the name AuthenticationExtensionsClientOutputs, but we should mention that it's a plain object whose keys and values represent the described entries.

@Josh-Cena Josh-Cena added help wanted If you know something about this topic, we would love your help! Content:WebAPI Web API docs area: WebAuthn and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: WebAuthn Content:WebAPI Web API docs help wanted If you know something about this topic, we would love your help!
Projects
None yet
Development

No branches or pull requests

2 participants