diff --git a/api/identity/definitions/request_email_validation.yaml b/api/identity/definitions/request_email_validation.yaml index bed8f572..805cd123 100644 --- a/api/identity/definitions/request_email_validation.yaml +++ b/api/identity/definitions/request_email_validation.yaml @@ -29,14 +29,13 @@ properties: send_attempt: type: integer description: |- - Optional. If specified, the server will only send an email if - the ``send_attempt`` is a number greater than the most recent - one which it has seen (or if it has never seen one), scoped - to that ``email`` + ``client_secret`` pair. This is to avoid - repeatedly sending the same email in the case of request - retries between the POSTing user and the identity - service. The client should increment this value if they - desire a new email (e.g. a reminder) to be sent. + The server will only send an email if the ``send_attempt`` + is a number greater than the most recent one which it has seen, + scoped to that ``email`` + ``client_secret`` pair. This is to + avoid repeatedly sending the same email in the case of request + retries between the POSTing user and the identity service. + The client should increment this value if they desire a new + email (e.g. a reminder) to be sent. example: 1 next_link: type: string diff --git a/api/identity/definitions/request_msisdn_validation.yaml b/api/identity/definitions/request_msisdn_validation.yaml index c28ff29c..f8e37d39 100644 --- a/api/identity/definitions/request_msisdn_validation.yaml +++ b/api/identity/definitions/request_msisdn_validation.yaml @@ -36,10 +36,9 @@ properties: send_attempt: type: integer description: |- - Optional. If specified, the server will only send an SMS if - the ``send_attempt`` is a number greater than the most recent - one which it has seen (or if it has never seen one), scoped - to that ``country`` + ``phone_number`` + ``client_secret`` + The server will only send an SMS if the ``send_attempt`` is a + number greater than the most recent one which it has seen, + scoped to that ``country`` + ``phone_number`` + ``client_secret`` triple. This is to avoid repeatedly sending the same SMS in the case of request retries between the POSTing user and the identity service. The client should increment this value if