send_attempt is no longer optional

pull/977/head
Travis Ralston 6 years ago
parent f3181bbedd
commit 4bd23a9086

@ -29,14 +29,13 @@ properties:
send_attempt: send_attempt:
type: integer type: integer
description: |- description: |-
Optional. If specified, the server will only send an email if The server will only send an email if the ``send_attempt``
the ``send_attempt`` is a number greater than the most recent is a number greater than the most recent one which it has seen,
one which it has seen (or if it has never seen one), scoped scoped to that ``email`` + ``client_secret`` pair. This is to
to that ``email`` + ``client_secret`` pair. This is to avoid avoid repeatedly sending the same email in the case of request
repeatedly sending the same email in the case of request retries between the POSTing user and the identity service.
retries between the POSTing user and the identity The client should increment this value if they desire a new
service. The client should increment this value if they email (e.g. a reminder) to be sent.
desire a new email (e.g. a reminder) to be sent.
example: 1 example: 1
next_link: next_link:
type: string type: string

@ -36,10 +36,9 @@ properties:
send_attempt: send_attempt:
type: integer type: integer
description: |- description: |-
Optional. If specified, the server will only send an SMS if The server will only send an SMS if the ``send_attempt`` is a
the ``send_attempt`` is a number greater than the most recent number greater than the most recent one which it has seen,
one which it has seen (or if it has never seen one), scoped scoped to that ``country`` + ``phone_number`` + ``client_secret``
to that ``country`` + ``phone_number`` + ``client_secret``
triple. This is to avoid repeatedly sending the same SMS in triple. This is to avoid repeatedly sending the same SMS in
the case of request retries between the POSTing user and the the case of request retries between the POSTing user and the
identity service. The client should increment this value if identity service. The client should increment this value if

Loading…
Cancel
Save