mirror of
https://github.com/fluxerapp/fluxer
synced 2026-10-17 13:05:32 +09:00
docs: use British English throughout (#3336)
This commit is contained in:
1 parent
6534ee4300
commit
a19002652b
8 files changed
+18
-18
No files matched your search
@@ -288,7 +288,7 @@ An entry with one of these actions has `access` set to `read`.
|
||||
| list_guild_members | The members of a guild were listed |
|
||||
| list_guild_memory_stats | Guild memory statistics were listed |
|
||||
| list_guild_stickers | The stickers of a guild were listed |
|
||||
| list_report_reasons | The report reason catalog was listed |
|
||||
| list_report_reasons | The report reason catalogue was listed |
|
||||
| list_user_applications | The applications an account owns were read |
|
||||
| list_user_change_log | The contact change log of an account was read |
|
||||
| list_user_dm_channels | The direct message channels of an account were read |
|
||||
|
||||
@@ -188,7 +188,7 @@ How often a client polls [Get experiment assignments](/http-api/experiments/#get
|
||||
|
||||
Every field is present on read. An absent document or missing field uses the defaults above.
|
||||
|
||||
Both fields are served to every account, whether or not any experiment targets that account, and neither one is versioned by `config_version`. A client that has never received a response from the experiments route uses built-in defaults of 300 seconds and 15 percent, which equal the defaults above. A client that cannot read the route never receives either field.
|
||||
Both fields are served to every account, whether or not any experiment targets that account, and neither one is versioned by `config_version`. A client that has never received a response from the experiments route uses built-in defaults of 300 seconds and 15 per cent, which equal the defaults above. A client that cannot read the route never receives either field.
|
||||
|
||||
## Registration configuration object
|
||||
|
||||
|
||||
@@ -407,7 +407,7 @@ The reported profile as it was when the report was filed. A user report keeps th
|
||||
|
||||
## Report flow answers object
|
||||
|
||||
The answers a reporter gave in a [report flow](/http-api/reports/#report-flows), described in English whatever locale the reporter saw. Fluxer builds the description from the stored IDs when it produces the response, so the labels follow the current catalog.
|
||||
The answers a reporter gave in a [report flow](/http-api/reports/#report-flows), described in English whatever locale the reporter saw. Fluxer builds the description from the stored IDs when it produces the response, so the labels follow the current catalogue.
|
||||
|
||||
### Structure
|
||||
|
||||
@@ -430,7 +430,7 @@ The answers a reporter gave in a [report flow](/http-api/reports/#report-flows),
|
||||
| option_label<sup>1</sup> <sup>2</sup> | ?string | The English label of the chosen option |
|
||||
| items<sup>3</sup> | array[[report flow answer item](#report-flow-answer-item-object) object] | The ticked checklist items |
|
||||
|
||||
<sup>1</sup> The raw ID when the current catalog no longer has the screen or option
|
||||
<sup>1</sup> The raw ID when the current catalogue no longer has the screen or option
|
||||
|
||||
<sup>2</sup> Null on a checklist screen and an info screen
|
||||
|
||||
@@ -443,11 +443,11 @@ The answers a reporter gave in a [report flow](/http-api/reports/#report-flows),
|
||||
| Field | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| id | string | The ID of the item |
|
||||
| label | string | The English label of the item, or its raw ID when the current catalog no longer has it |
|
||||
| label | string | The English label of the item, or its raw ID when the current catalogue no longer has it |
|
||||
|
||||
## Report reason object
|
||||
|
||||
One entry of the [report reason](/http-api/reports/#report-reasons) catalog, as [List report reasons](#list-report-reasons) returns it.
|
||||
One entry of the [report reason](/http-api/reports/#report-reasons) catalogue, as [List report reasons](#list-report-reasons) returns it.
|
||||
|
||||
### Structure
|
||||
|
||||
@@ -600,19 +600,19 @@ The operation records one [Admin audit entry](/admin-api/#admin-audit-entry-obje
|
||||
|
||||
Returns every [report reason](/http-api/reports/#report-reasons) a report flow can file a report under, with the category each one stores for each report type. Requires `report:view`.
|
||||
|
||||
The labels are English. The list is the catalog this API was built with, so an admin client can label and filter a reason without a copy of its own.
|
||||
The labels are English. The list is the catalogue this API was built with, so an admin client can label and filter a reason without a copy of its own.
|
||||
|
||||
### Response body
|
||||
|
||||
| Field | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| reasons | array[[report reason](#report-reason-object) object] | Every reason, in catalog order |
|
||||
| reasons | array[[report reason](#report-reason-object) object] | Every reason, in catalogue order |
|
||||
|
||||
### Response
|
||||
|
||||
| Status | Body | Condition |
|
||||
| --- | --- | --- |
|
||||
| 200 | response body | The catalog was returned |
|
||||
| 200 | response body | The catalogue was returned |
|
||||
|
||||
### Side effects
|
||||
|
||||
|
||||
@@ -106,7 +106,7 @@ The `ETag` changes when the response changes. Treat it as an opaque value.
|
||||
|
||||
A client reads this route once per session and then again every `poll_interval_seconds`, offset by a random amount up to `poll_jitter_percent` of that interval in either direction. It sends the last `ETag` on every request after the first. A client MUST NOT poll faster than the lower end of that jitter range.
|
||||
|
||||
Until the first successful response, use 300 seconds with 15 percent jitter.
|
||||
Until the first successful response, use 300 seconds with 15 per cent jitter.
|
||||
|
||||
### Rate limit
|
||||
|
||||
|
||||
@@ -497,7 +497,7 @@ The read is ordered from newest to oldest by entry ID. `before` selects entries
|
||||
|
||||
Consolidated entries have new IDs but retain the position of the run they replace. Sort the page by ID if a strictly descending array is required.
|
||||
|
||||
A stored update entry that fails the [no-change rule](#audit-actions) is skipped and does not count toward `limit`. A page holds fewer entries than `limit` only when the guild has no further matching entries in that direction.
|
||||
A stored update entry that fails the [no-change rule](#audit-actions) is skipped and does not count towards `limit`. A page holds fewer entries than `limit` only when the guild has no further matching entries in that direction.
|
||||
|
||||
### Response
|
||||
|
||||
|
||||
@@ -1614,7 +1614,7 @@ The response is 204 whether the message survives or is deleted, so the emitted G
|
||||
|
||||
### Side effects
|
||||
|
||||
The operation permanently deletes the stored attachment object, purges it from media delivery, removes it from the message, and advances the message's edit timestamp. On a [published](#crosspost-message) message it counts toward the published message edit allowance described under [Modify message](#modify-message), and a denial returns 429 `PUBLISHED_MESSAGE_EDIT_RATE_LIMITED`. It then emits [Message Update](/gateway/events/#message-update) to every session that can see the channel. When the removed attachment was the message's only attachment and the message has no content, embeds, or stickers, Fluxer deletes the whole message instead, with the complete [Delete message](#delete-message) effect set, including its Dispatches and guild audit log entry.
|
||||
The operation permanently deletes the stored attachment object, purges it from media delivery, removes it from the message, and advances the message's edit timestamp. On a [published](#crosspost-message) message it counts towards the published message edit allowance described under [Modify message](#modify-message), and a denial returns 429 `PUBLISHED_MESSAGE_EDIT_RATE_LIMITED`. It then emits [Message Update](/gateway/events/#message-update) to every session that can see the channel. When the removed attachment was the message's only attachment and the message has no content, embeds, or stickers, Fluxer deletes the whole message instead, with the complete [Delete message](#delete-message) effect set, including its Dispatches and guild audit log entry.
|
||||
|
||||
### Rate limit
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
title: Reports
|
||||
description: Report flows, safety report submission, the reason catalog, and the DSA notice flow.
|
||||
description: Report flows, safety report submission, the reason catalogue, and the DSA notice flow.
|
||||
---
|
||||
|
||||
import RouteHeader from '@/components/RouteHeader.astro';
|
||||
@@ -247,7 +247,7 @@ Every member is always present. The members that do not apply to `type` are null
|
||||
| notice_id | ?string | The notice to show when `type` is `end`, or null for the thank-you screen |
|
||||
| url | ?string | The page to open when `type` is `link` |
|
||||
|
||||
<sup>1</sup> A plain string, so a client MUST tolerate a reason the [catalog](#report-reasons) does not list yet
|
||||
<sup>1</sup> A plain string, so a client MUST tolerate a reason the [catalogue](#report-reasons) does not list yet
|
||||
|
||||
## Report flow checklist object
|
||||
|
||||
@@ -406,7 +406,7 @@ Only `pending` and `resolved` are ever stored. A client MUST still tolerate a st
|
||||
|
||||
## Report reasons
|
||||
|
||||
A report filed through a flow stores a reason, together with the [category](#report-categories) that reason maps to for the report's target type. Moderators can filter on both. The catalog grows over time, so a client MUST tolerate a reason it does not list.
|
||||
A report filed through a flow stores a reason, together with the [category](#report-categories) that reason maps to for the report's target type. Moderators can filter on both. The catalogue grows over time, so a client MUST tolerate a reason it does not list.
|
||||
|
||||
The second column gives the reason value, then the category it stores on a message report, a user report, and a guild report, in that order.
|
||||
|
||||
@@ -740,7 +740,7 @@ The code expires after 10 minutes. Codes use uppercase letters and digits in `XX
|
||||
|
||||
A new code can go to the same address once a minute has passed since the last one, or once that code has expired. It replaces the previous code and restarts the 10 minute window. A request within the minute returns 429 with `retry_after` and leaves the code already sent usable.
|
||||
|
||||
When the provider refuses the message, or the address is recorded as a hard bounce, Fluxer keeps no code for the address, so a code sent to it earlier stops working too, and returns 503 `SERVICE_UNAVAILABLE`. That attempt still counts toward the 3 sends an address gets each hour.
|
||||
When the provider refuses the message, or the address is recorded as a hard bounce, Fluxer keeps no code for the address, so a code sent to it earlier stops working too, and returns 503 `SERVICE_UNAVAILABLE`. That attempt still counts towards the 3 sends an address gets each hour.
|
||||
|
||||
The operation creates no ticket and emits no Gateway Dispatch.
|
||||
|
||||
@@ -748,7 +748,7 @@ The operation creates no ticket and emits no Gateway Dispatch.
|
||||
|
||||
5 requests per hour, on the `dsa:report:email:send` bucket.
|
||||
|
||||
One address gets at most 3 sends each hour, and at most one each minute while its last code is unexpired. The minute check runs first, so a request it refuses does not count toward the hourly 3. Both return 429 `RATE_LIMITED` with `retry_after`.
|
||||
One address gets at most 3 sends each hour, and at most one each minute while its last code is unexpired. The minute check runs first, so a request it refuses does not count towards the hourly 3. Both return 429 `RATE_LIMITED` with `retry_after`.
|
||||
|
||||
## Verify DSA report email
|
||||
|
||||
|
||||
@@ -245,7 +245,7 @@ The options name the chosen domain in `rpId` and list only the chosen passkeys.
|
||||
|
||||
## Replaced passkeys
|
||||
|
||||
A [passkey update](#passkey-updates) keeps the old `fluxer.app` credential as a replaced passkey, so the mobile apps and `web.fluxer.app` still accept it. A replaced passkey appears in no list, no [Ready](/gateway/events/#ready) payload, and no [WebAuthn Credentials Update](/gateway/events/#webauthn-credentials-update), and it does not count toward the 10-credential limit.
|
||||
A [passkey update](#passkey-updates) keeps the old `fluxer.app` credential as a replaced passkey, so the mobile apps and `web.fluxer.app` still accept it. A replaced passkey appears in no list, no [Ready](/gateway/events/#ready) payload, and no [WebAuthn Credentials Update](/gateway/events/#webauthn-credentials-update), and it does not count towards the 10-credential limit.
|
||||
|
||||
A replaced passkey works only on requests that are not new-origin requests. It never works on a new origin or through the passkey bridge. Renaming or deleting it by ID returns 404 `UNKNOWN_WEBAUTHN_CREDENTIAL`. Deleting the passkey that replaced it deletes it too, and deleting the account's last listed passkey deletes every replaced one.
|
||||
|
||||
|
||||
Reference in new issue
Block a user