Skip to content

Commit 5494aab

Browse files
docs(fx-api): clarify POST 503, 500 and atomic wording
1 parent b8c4df9 commit 5494aab

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎openapi.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ components:
161161
code: internal-error
162162
message: Monitor could not complete this request.
163163
ServiceUnavailable:
164-
description: Monitor is unavailable, or FxA could not verify the token. Safe to retry, after the interval in `Retry-After` when it is present.
164+
description: Monitor is unavailable, or FxA could not verify the token. Safe to retry, after the interval in `Retry-After` when it is present, otherwise on your next scheduled poll.
165165
headers:
166166
Retry-After:
167167
required: false
@@ -274,7 +274,7 @@ paths:
274274
275275
Idempotent per `breachId`. Repeated entries merge, and order does not matter.
276276
277-
Atomic: every matched breach updates, or none does.
277+
Atomic: one write covers every matched breach, so a request never applies halfway.
278278
279279
requestBody:
280280
required: true
@@ -315,7 +315,7 @@ paths:
315315
$ref: "#/components/responses/TooManyRequests"
316316
"500":
317317
$ref: "#/components/responses/InternalError"
318-
description: Something failed on our side. Treat the batch as not applied and retry it, repeats are safe.
318+
description: Something failed on our side. The batch may or may not be applied, so retry it, repeats are safe.
319319
"503":
320320
$ref: "#/components/responses/ServiceUnavailable"
321-
description: Monitor is unavailable, or FxA could not verify the token. Treat the batch as not applied and retry it, after the interval in `Retry-After` when it is present. Repeats are safe.
321+
description: FxA could not verify the token, we could not check this user against HIBP, or Monitor is unavailable. Nothing was written. Retry after the interval in `Retry-After` when it is present, otherwise later. Repeats are safe.

0 commit comments

Comments
 (0)