docs: list name, domain and title rules, confirmation behaviour

- openapi: name, domain and title constraints of POST /lists, title of PATCH
- README: the rules, the RFC 2047 List-Id, single-use and re-usable confirmation, rejoin after bounces
This commit is contained in:
tgiachi 2026-11-10 11:54:52 +01:00
commit 53ca30ad61

View file

@ -99,9 +99,19 @@ paths:
type: object
required: [name, domain]
properties:
name: {type: string}
domain: {type: string}
title: {type: string}
name:
type: string
minLength: 1
maxLength: 30
pattern: '^[A-Za-z0-9_-]+(\.[A-Za-z0-9_-]+)*$'
description: Local part of the list address, stored lowercase. Letters, digits, '.', '_' and '-' only, no dot at either end or two in a row.
domain:
type: string
description: ASCII host name (labels of 1 to 63 letters, digits and hyphens).
title:
type: string
maxLength: 200
description: A single line without control characters. Defaults to the name.
responses:
'201':
description: Created
@ -131,7 +141,7 @@ paths:
schema:
type: object
properties:
title: {type: string}
title: {type: string, minLength: 1, maxLength: 200, description: A single line without control characters.}
post_policy: {type: string, enum: [members, moderated]}
join_policy: {type: string, enum: [open, closed]}
archive_policy: {type: string, enum: [public, private, off]}