Skip to content

Commit

Permalink
fix(authentication): Clarify %retval% result fields
Browse files Browse the repository at this point in the history
When %retval% is an error, the other fields in a response are still
initialized and written, but they will have empty values.
  • Loading branch information
DaniElectra committed May 18, 2024
1 parent 4bdf830 commit 8fe2bfd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/nex/protocols/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ title: Ticket Granting (10)

This is the only protocol that's available on the authentication server. Other protocols are only available on the secure server.

If a server is in maintenance, the `%retval%` result fields are set to `Authentication::UnderMaintenance` and the other fields of the response are left with empty values.

## Methods

| Method ID | Name (3DS / Wii U) | Name (Switch) |
Expand All @@ -20,7 +22,7 @@ This is the only protocol that's available on the authentication server. Other p
### (1) Login
Usernames are not case sensitive.

If the username does not exist, the `%retval%` field is set to `RendezVous::InvalidUsername` and the other fields are left blank.
If the username does not exist, the `%retval%` field is set to `RendezVous::InvalidUsername` and the other fields are left with empty values.

#### Request

Expand Down Expand Up @@ -49,7 +51,7 @@ Examples of server build names:
### (2) LoginEx
Usernames are not case sensitive.

If the username does not exist, the `%retval%` field is set to `RendezVous::InvalidUsername` and the other fields are left blank.
If the username does not exist, the `%retval%` field is set to `RendezVous::InvalidUsername` and the other fields are left with empty values.

Wii U servers don't seem to check what's in the extra data.

Expand Down

0 comments on commit 8fe2bfd

Please sign in to comment.