Skip to content

[grid] Document passkey nickname validation #428

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.

Sign up for GitHub

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

Open
DhruvPareek wants to merge 1 commit into
base: 04-30-grid-auth-challenge-rate-limit-docs
Choose a base branch
from
+11 −8
Open

[grid] Document passkey nickname validation #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions mintlify/openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions openapi.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions openapi/components/schemas/auth/AuthMethod.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ properties:
description: >-
Human-readable identifier for this credential. For EMAIL_OTP credentials
this is the email address; for OAUTH credentials it is typically the email
claim from the OIDC token; for PASSKEY credentials it is the nickname
provided at registration time.
claim from the OIDC token; for PASSKEY credentials it is the validated
nickname provided at registration time.
example: example@lightspark.com
createdAt:
type: string
Expand Down
7 changes: 5 additions & 2 deletions openapi/components/schemas/auth/PasskeyCredentialCreateRequestFields.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,11 @@ properties:
type: string
description: >-
Human-readable identifier for the passkey, chosen by the user at
registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Shown
back on `AuthMethod` responses and in credential listings.
registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Leading
and trailing whitespace is ignored. Must be 1-100 characters and may
contain Unicode letters, numbers, spaces, and the following separators:
Comment on lines 16 to +19
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 "Whitespace is ignored" is ambiguous about the stored value

"Leading and trailing whitespace is ignored" could mean (a) whitespace is stripped before storage, so the stored nickname has no leading/trailing whitespace, or (b) the API accepts whitespace but callers should trim it themselves. The AuthMethod response description says "validated nickname", which implies (a), but a reader of this field alone can't tell. A small wording tweak removes the ambiguity:

Suggested change
Human-readable identifier for the passkey, chosen by the user at
registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Shown
back on `AuthMethod` responses and in credential listings.
registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Leading
and trailing whitespace is ignored. Must be 1-100 characters and may
contain Unicode letters, numbers, spaces, and the following separators:
registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Leading
and trailing whitespace is stripped before storage. Must be 1-100 characters and may
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/components/schemas/auth/PasskeyCredentialCreateRequestFields.yaml
Line: 16-19

Comment:
**"Whitespace is ignored" is ambiguous about the stored value**

"Leading and trailing whitespace is ignored" could mean (a) whitespace is stripped before storage, so the stored `nickname` has no leading/trailing whitespace, or (b) the API accepts whitespace but callers should trim it themselves. The `AuthMethod` response description says "validated nickname", which implies (a), but a reader of this field alone can't tell. A small wording tweak removes the ambiguity:

```suggestion
      registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Leading
      and trailing whitespace is stripped before storage. Must be 1-100 characters and may
```

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code

period, underscore, hyphen, apostrophe, and parentheses. Shown back on
AuthMethod responses and in credential listings.
example: iPhone Face-ID
challenge:
type: string
Expand Down
Loading