From ff9bb4f69880ac15148965f58c8c4287f7e7f041 Mon Sep 17 00:00:00 2001 From: Jonas Hendrickx Date: Fri, 8 Nov 2024 08:20:10 +0100 Subject: [PATCH] Document the `nickname` property when registering a credential. (#97) --- .../android/rest/contracts/register/RegisterCompleteRequest.kt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/passwordless/src/main/java/dev/passwordless/android/rest/contracts/register/RegisterCompleteRequest.kt b/passwordless/src/main/java/dev/passwordless/android/rest/contracts/register/RegisterCompleteRequest.kt index e8e623b..4894a13 100644 --- a/passwordless/src/main/java/dev/passwordless/android/rest/contracts/register/RegisterCompleteRequest.kt +++ b/passwordless/src/main/java/dev/passwordless/android/rest/contracts/register/RegisterCompleteRequest.kt @@ -8,7 +8,8 @@ import com.google.gson.annotations.SerializedName * * @property session The session ID for the registration. * @property response The response from the authenticator. - * @property nickname The nickname of the user. + * @property nickname The nickname of a credential could represent the location where the credential + * is stored, i.e. "YubiKey Work" or "Marc's Laptop". * @property origin The origin of the request. * @property rpId The identifier of the relying party. */